Index
All Classes and Interfaces|All Packages
A
- abort(String) - Method in class jjparse.Parsing
-
Constructs a
Parsing.Parserthat always fails with anParsing.Abort. - Abort(String, Input<? extends I>) - Constructor for class jjparse.Parsing.Abort
- alternatives - Variable in class jjparse.description.Choice
-
The
Listof alternativeDescriptions. - and(Description) - Method in class jjparse.description.Description
- and(Parsing.Parser<U>) - Method in class jjparse.Parsing.Parser
-
Concatenates this and the provided
Parsing.Parserand returns aProductof the corresponding values onParsing.Success. - andl(Parsing.Parser<U>) - Method in class jjparse.Parsing.Parser
-
Concatenates this and the provided
Parsing.Parserbut returns only the value parsed by thisParsing.Parser. - andr(Parsing.Parser<U>) - Method in class jjparse.Parsing.Parser
-
Concatenates this and the provided
Parsing.Parserbut returns only the value parsed by the provided one. - apply(Input<I>) - Method in class jjparse.Parsing.Parser
B
- between(Parsing.Parser<?>, Parsing.Parser<?>) - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich parses thisParsing.Parserin between the two providedParsing.Parsers, only returning the value of thisParsing.Parser.
C
- chainl(Parsing.Parser<BiFunction<T, T, T>>, T) - Method in class jjparse.Parsing.Parser
-
Just like
Parsing.Parser.separate(jjparse.Parsing.Parser<?>), this method separates thisParsing.Parserusing the separatorParsing.Parser. - chainl1(Parsing.Parser<BiFunction<T, T, T>>) - Method in class jjparse.Parsing.Parser
-
Just like
Parsing.Parser.separate1(jjparse.Parsing.Parser<?>), this method separates thisParsing.Parserusing the separatorParsing.Parser. - chainr(Parsing.Parser<BiFunction<T, T, T>>, T) - Method in class jjparse.Parsing.Parser
-
Just like
Parsing.Parser.separate(jjparse.Parsing.Parser<?>), this method separates thisParsing.Parserusing the separatorParsing.Parser. - chainr1(Parsing.Parser<BiFunction<T, T, T>>) - Method in class jjparse.Parsing.Parser
-
Just like
Parsing.Parser.separate1(jjparse.Parsing.Parser<?>), this method separates thisParsing.Parserusing the separatorParsing.Parser. - character(char) - Method in class jjparse.StringParsing
-
Creates a primitive
Parsing.Parserthat attempts to parse the providedCharacter. - CharacterInput - Class in jjparse.input
-
A specific implementation of an
InputforCharacters that also implements theCharSequenceinterface. - CharacterInput.CodePointPosition - Class in jjparse.input
-
Represents a
Input<Character>.Positionin thisCharacterInputthat is aware of the underlying unicode code points. - charAt(int) - Method in class jjparse.input.CharacterInput
- choice(Parsing.Parser<? extends T>...) - Method in class jjparse.Parsing
-
Constructs a
Parsing.Parserthat attempts to parse the providedParsing.Parsers in the order they are given until one of them succeeds or aborts. - Choice - Class in jjparse.description
-
A
DescriptionforParsing.Parsers that expect aParsing.choice(jjparse.Parsing.Parser<? extends T>...). - Choice(List<Description>) - Constructor for class jjparse.description.Choice
-
Constructs a new
ChoiceDescription. - commit() - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich behaves like thisParsing.Parserexcept that the createdParsing.Parseraborts with anParsing.Abortwhen thisParsing.Parserfails with anParsing.Error.
D
- describe() - Method in class jjparse.description.Choice
- describe() - Method in class jjparse.description.Description
-
Produces a
Stringthat explains what a correspondingParsing.Parserwould expect according to thisDescription. - describe() - Method in class jjparse.description.Empty
- describe() - Method in class jjparse.description.Literal
- describe() - Method in class jjparse.description.Negation
- describe() - Method in class jjparse.description.RegExp
- describe() - Method in class jjparse.description.Sequence
- describe() - Method in class jjparse.input.CharacterInput.CodePointPosition
- describe() - Method in class jjparse.input.Input.Position
- description - Variable in class jjparse.description.Negation
-
The
Descriptionwhich should be negated. - description() - Method in class jjparse.Parsing.Parser
-
This method shall return a
Descriptionfor thisParsing.Parserwhich provides details about the shape of theInputthisParsing.Parserexpects. - Description - Class in jjparse.description
-
The base class for all kinds of
Parsing.ParserDescriptions. - Description() - Constructor for class jjparse.description.Description
-
Construct a new
Description. - digit - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a single digit (0 - 9).
E
- elements - Variable in class jjparse.description.Sequence
-
The
ListofDescriptions. - empty() - Static method in class jjparse.input.Input
-
Constructs an empty
Inputof an arbitrary element type where"<empty>"is used as the name. - Empty - Class in jjparse.description
-
A
DescriptionforParsing.Parsers with no expectation hints (which is the default). - Empty() - Constructor for class jjparse.description.Empty
-
Constructs a new
EmptyDescription. - equals(Object) - Method in record class jjparse.data.Product
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class jjparse.input.Input.Position
- error(String) - Method in class jjparse.Parsing
-
Constructs a
Parsing.Parserthat always fails with anParsing.Error. - Error(String, Input<? extends I>) - Constructor for class jjparse.Parsing.Error
F
- Failure(String, Input<? extends I>) - Constructor for class jjparse.Parsing.Failure
-
The base constructor for a
Parsing.Failure. - first() - Method in record class jjparse.data.Product
-
Returns the value of the
firstrecord component. - flatMap(Function<T, Parsing.Parser<U>>) - Method in class jjparse.Parsing.Parser
- flatMap(Function<T, Parsing.Result<U>>) - Method in class jjparse.Parsing.Failure
- flatMap(Function<T, Parsing.Result<U>>) - Method in class jjparse.Parsing.Result
-
Maps the value of this
Parsing.Resultin case it is aParsing.Successto anotherParsing.Resultusing the providedFunctionand flattens the nestedParsing.Result. - flatMap(Function<T, Parsing.Result<U>>) - Method in class jjparse.Parsing.Success
- float32 - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a 32-bit IEEE 754 floating point number. - float64 - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a 64-bit IEEE 754 floating point number. - fold(BiFunction<A, B, C>) - Method in record class jjparse.data.Product
- format(Input<?>, Description) - Static method in class jjparse.Parsing.Failure
-
Format an error message for the provided
InputandDescription.
G
- get() - Method in class jjparse.Parsing.Failure
- get() - Method in class jjparse.Parsing.Result
-
Returns the value of this
Parsing.Result, if it is present. - get() - Method in class jjparse.Parsing.Success
- getCodePoint() - Method in class jjparse.input.CharacterInput.CodePointPosition
-
Returns the code point that occurs in the associated
CharacterInputat thisCharacterInput.CodePointPosition. - getColumnNumber() - Method in class jjparse.input.CharacterInput.CodePointPosition
-
Computes the column number that corresponds to this
CharacterInput.CodePointPositionas it is perceived by the user. - getLineNumber() - Method in class jjparse.input.CharacterInput.CodePointPosition
-
Computes the line number that corresponds to this
CharacterInput.CodePointPositionas it is perceived by the user. - getOrFail() - Method in class jjparse.Parsing.Failure
- getOrFail() - Method in class jjparse.Parsing.Result
-
Returns the value of this
Parsing.Resultor fails with an exception, if it is not present. - getOrFail() - Method in class jjparse.Parsing.Success
H
- hashCode() - Method in record class jjparse.data.Product
-
Returns a hash code value for this object.
- hashCode() - Method in class jjparse.input.Input.Position
- head() - Method in class jjparse.input.CharacterInput
- head() - Method in class jjparse.input.Input
-
Returns the first element of this
Input. - head() - Method in class jjparse.input.StreamInput
I
- identifier - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses the traditional C identifier. - input - Variable in class jjparse.input.Input.Position
- Input<T> - Class in jjparse.input
-
An abstract representation of an
Inputfor parsing. - Input(String) - Constructor for class jjparse.input.Input
-
Constructs a new
Inputon basis of the provided name. - Input.Position - Class in jjparse.input
-
Represents an offset within this
Input. - int32 - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a signed 32-bit integer. - int64 - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a signed 64-bit integer. - integer - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a signed integer. - isEmpty() - Method in class jjparse.input.CharacterInput
- isEmpty() - Method in class jjparse.input.Input
-
Checks whether this
Inputis empty. - isEmpty() - Method in class jjparse.input.StreamInput
- isFailure() - Method in class jjparse.Parsing.Failure
- isFailure() - Method in class jjparse.Parsing.Result
-
Checks whether this
Parsing.Resultis aParsing.Failure. - isFailure() - Method in class jjparse.Parsing.Success
- isFatal() - Method in class jjparse.Parsing.Abort
- isFatal() - Method in class jjparse.Parsing.Error
- isFatal() - Method in class jjparse.Parsing.Failure
-
Checks whether this
Parsing.Failureis fatal in the sense that no backtracking shall be applied during parsing. - isSuccess() - Method in class jjparse.Parsing.Failure
- isSuccess() - Method in class jjparse.Parsing.Result
-
Checks whether this
Parsing.Resultis aParsing.Success. - isSuccess() - Method in class jjparse.Parsing.Success
J
- jjparse - package jjparse
- jjparse.data - package jjparse.data
- jjparse.description - package jjparse.description
- jjparse.input - package jjparse.input
L
- lazy(Supplier<Parsing.Parser<? extends T>>) - Method in class jjparse.Parsing
-
Constructs a new
Parsing.Parserwhich is initialized lazy. - length() - Method in class jjparse.input.CharacterInput
- lift(Function<? super Input<I>, ? extends Parsing.Result<T>>) - Method in class jjparse.Parsing
-
Lifts the provided
Functioninto aParsing.Parser. - literal - Variable in class jjparse.description.Literal
-
The expected
Stringliteral. - literal(String) - Method in class jjparse.StringParsing
-
Creates a primitive
Parsing.Parserthat attempts to parse the providedStringliteral. - Literal - Class in jjparse.description
- Literal(String) - Constructor for class jjparse.description.Literal
-
Construct a new
LiteralDescription. - log(String) - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich prints additional debug output to the standard output stream. - lowercase - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a Latin lowercase letter (a - z).
M
- map(Function<A, C>, Function<B, D>) - Method in record class jjparse.data.Product
-
Maps this
Productto a new one by mapping its values using the provided functions. - map(Function<T, U>) - Method in class jjparse.Parsing.Failure
- map(Function<T, U>) - Method in class jjparse.Parsing.Parser
- map(Function<T, U>) - Method in class jjparse.Parsing.Result
- map(Function<T, U>) - Method in class jjparse.Parsing.Success
- message - Variable in class jjparse.Parsing.Failure
-
The error message that describes this
Parsing.Failurein more detail.
N
- name - Variable in class jjparse.input.Input
-
A human-readable name for this
Inputwhich can be used for error reporting purposes. - negate() - Method in class jjparse.description.Description
- Negation - Class in jjparse.description
- Negation(Description) - Constructor for class jjparse.description.Negation
-
Constructs a new
NegationDescription. - nonEmpty() - Method in class jjparse.input.Input
-
Checks whether this
Inputis not empty. - normalize() - Method in class jjparse.description.Description
-
Normalizes this
Descriptionsuch thatNegations are propagated downwards to the individualLiteralandRegExpDescriptions. - not() - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich attempts to not parse thisParsing.Parser. - number - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses an unsigned 32-bit integer.
O
- of(A, B) - Static method in record class jjparse.data.Product
-
A shorthand for constructing a new
Product. - of(String, byte[], Charset) - Static method in class jjparse.input.Input
- of(String, InputStream, Charset) - Static method in class jjparse.input.Input
- of(String, CharSequence) - Static method in class jjparse.input.Input
- of(String, Iterable<T>) - Static method in class jjparse.input.Input
- of(String, Iterator<T>) - Static method in class jjparse.input.Input
- of(String, Stream<T>) - Static method in class jjparse.input.Input
- of(Path, Charset) - Static method in class jjparse.input.Input
- offset - Variable in class jjparse.input.Input.Position
- optional() - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich attempts to parse thisParsing.Parserand only fails if thisParsing.Parseraborts with anParsing.Abort. - or(Description) - Method in class jjparse.description.Description
- or(Parsing.Parser<? extends T>) - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich first attempts to parse thisParsing.Parserand, if thisParsing.Parserfails with anParsing.Error, attempts to parse the exact sameInputwith the providedParsing.Parser.
P
- parse(Parsing.Parser<? extends T>, Input<? extends I>) - Method in class jjparse.Parsing
-
Attempts to parse the whole
Inputwith the providedParsing.Parser. - Parser() - Constructor for class jjparse.Parsing.Parser
- Parsing<I> - Class in jjparse
-
An abstract class that provides all basic parsing capabilities.
- Parsing() - Constructor for class jjparse.Parsing
-
Creates an instance of this
Parsingclass and provides access to allParsing.Parsers andParsing.Parsercombinators in that way. - Parsing.Abort<T> - Class in jjparse
-
Represents a fatal
Parsing.Failure. - Parsing.Error<T> - Class in jjparse
-
Represents a recoverable
Parsing.Failure. - Parsing.Failure<T> - Class in jjparse
-
Represents a
Parsing.Resultwhich indicates a parse failure. - Parsing.Parser<T> - Class in jjparse
-
The abstract base class of a
Parsing.Parser. - Parsing.Result<T> - Class in jjparse
-
Represents the result of a parsing operation.
- Parsing.Success<T> - Class in jjparse
-
Represents a successful result of a parsing operation.
- pattern - Variable in class jjparse.description.RegExp
-
The expected
Patternof thisDescription. - position() - Method in class jjparse.input.CharacterInput
- position() - Method in class jjparse.input.Input
- position() - Method in class jjparse.input.StreamInput
- position(Parsing.Parser<Function<Input.Position, T>>) - Method in class jjparse.Parsing
-
Constructs a new
Parsing.Parserthat behaves just like the given one, applying the currentInput.Positionto theFunctionreturned by the providedParsing.Parser. - Position(int) - Constructor for class jjparse.input.Input.Position
- Product<A,
B> - Record Class in jjparse.data -
A simple representation of a
Product(or pair) as a record. - Product(A, B) - Constructor for record class jjparse.data.Product
-
Creates an instance of a
Productrecord class.
R
- regex(String) - Method in class jjparse.StringParsing
-
Creates a primitive
Parsing.Parserthat attempts to match the provided regular expression (which must be a validPattern). - RegExp - Class in jjparse.description
- RegExp(Pattern) - Constructor for class jjparse.description.RegExp
-
Constructs a new
RegExpDescription. - repeat() - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich applies thisParsing.Parserarbitrarily many, including zero, times. - repeat1() - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich applies thisParsing.Parserarbitrarily many times but at least one time. - rest - Variable in class jjparse.Parsing.Result
-
The rest of the
Input. - Result(Input<? extends I>) - Constructor for class jjparse.Parsing.Result
-
The base constructor for
Parsing.Result.
S
- second() - Method in record class jjparse.data.Product
-
Returns the value of the
secondrecord component. - separate(Parsing.Parser<?>) - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich parses thisParsing.Parser(possibly zero times) interleaved with the provided separatorParsing.Parser, only returning the values returned by thisParsing.Parser. - separate1(Parsing.Parser<?>) - Method in class jjparse.Parsing.Parser
-
Creates a
Parsing.Parserwhich parses thisParsing.Parser(at least one time) interleaved with the provided separatorParsing.Parser, only returning the values returned by thisParsing.Parser. - sequence(Parsing.Parser<? extends T>...) - Method in class jjparse.Parsing
-
Constructs a new
Parsing.Parserthat applies the providedParsing.Parsers in sequence. - Sequence - Class in jjparse.description
-
A
DescriptionforParsing.Parsers that expect aParsing.sequence(jjparse.Parsing.Parser<? extends T>...). - Sequence(List<Description>) - Constructor for class jjparse.description.Sequence
-
Constructs a new
SequenceDescription. - setSkipParser(Parsing.Parser<? extends T>) - Method in class jjparse.Parsing
- skip(Input<? extends I>) - Method in class jjparse.Parsing
-
Skips the prefix of the provided
Inputusing the current skipParsing.Parser. - StreamInput<T> - Class in jjparse.input
- StringParsing - Class in jjparse
-
An extension of the basic
Parsingclass that provides basicParsing.Parsers forParsingwithStrings. - StringParsing() - Constructor for class jjparse.StringParsing
-
Creates an instance of this
StringParsingclass and provides access to allParsing.Parsers andParsing.Parsercombinators in that way. - subSequence(int, int) - Method in class jjparse.input.CharacterInput
- success(Supplier<? extends T>) - Method in class jjparse.Parsing
-
Constructs a
Parsing.Parserthat always succeeds with aParsing.Success. - Success(T, Input<? extends I>) - Constructor for class jjparse.Parsing.Success
-
Constructs a new
Parsing.Success.
T
- tail() - Method in class jjparse.input.CharacterInput
- tail() - Method in class jjparse.input.Input
-
Returns the rest of this
Input, excluding its first element. - tail() - Method in class jjparse.input.StreamInput
- toString() - Method in record class jjparse.data.Product
-
Returns a string representation of this record class.
- toString() - Method in class jjparse.input.CharacterInput.CodePointPosition
- toString() - Method in class jjparse.input.CharacterInput
- toString() - Method in class jjparse.input.Input.Position
U
- uppercase - Variable in class jjparse.StringParsing
-
A
Parsing.Parserwhich parses a Latin uppercase letter (A - Z).
V
- value - Variable in class jjparse.Parsing.Success
-
The parsed value of this
Parsing.Success.
All Classes and Interfaces|All Packages