Index

A B C D E F G H I J L M N O P R S T U V 
All Classes and Interfaces|All Packages

A

abort(String) - Method in class jjparse.Parsing
Constructs a Parsing.Parser that always fails with an Parsing.Abort.
Abort(String, Input<? extends I>) - Constructor for class jjparse.Parsing.Abort
 
alternatives - Variable in class jjparse.description.Choice
The List of alternative Descriptions.
and(Description) - Method in class jjparse.description.Description
Creates a new Description by creating a Sequence from this and the provided Description.
and(Parsing.Parser<U>) - Method in class jjparse.Parsing.Parser
Concatenates this and the provided Parsing.Parser and returns a Product of the corresponding values on Parsing.Success.
andl(Parsing.Parser<U>) - Method in class jjparse.Parsing.Parser
Concatenates this and the provided Parsing.Parser but returns only the value parsed by this Parsing.Parser.
andr(Parsing.Parser<U>) - Method in class jjparse.Parsing.Parser
Concatenates this and the provided Parsing.Parser but returns only the value parsed by the provided one.
apply(Input<I>) - Method in class jjparse.Parsing.Parser
Applies this Parsing.Parser to the provided Input, returning a Parsing.Result.

B

between(Parsing.Parser<?>, Parsing.Parser<?>) - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which parses this Parsing.Parser in between the two provided Parsing.Parsers, only returning the value of this Parsing.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 this Parsing.Parser using the separator Parsing.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 this Parsing.Parser using the separator Parsing.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 this Parsing.Parser using the separator Parsing.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 this Parsing.Parser using the separator Parsing.Parser.
character(char) - Method in class jjparse.StringParsing
Creates a primitive Parsing.Parser that attempts to parse the provided Character.
CharacterInput - Class in jjparse.input
A specific implementation of an Input for Characters that also implements the CharSequence interface.
CharacterInput.CodePointPosition - Class in jjparse.input
Represents a Input<Character>.Position in this CharacterInput that 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.Parser that attempts to parse the provided Parsing.Parsers in the order they are given until one of them succeeds or aborts.
Choice - Class in jjparse.description
Choice(List<Description>) - Constructor for class jjparse.description.Choice
Constructs a new Choice Description.
commit() - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which behaves like this Parsing.Parser except that the created Parsing.Parser aborts with an Parsing.Abort when this Parsing.Parser fails with an Parsing.Error.

D

describe() - Method in class jjparse.description.Choice
 
describe() - Method in class jjparse.description.Description
Produces a String that explains what a corresponding Parsing.Parser would expect according to this Description.
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
Describes the element to which this Input<T>.Position refers to.
description - Variable in class jjparse.description.Negation
The Description which should be negated.
description() - Method in class jjparse.Parsing.Parser
This method shall return a Description for this Parsing.Parser which provides details about the shape of the Input this Parsing.Parser expects.
Description - Class in jjparse.description
The base class for all kinds of Parsing.Parser Descriptions.
Description() - Constructor for class jjparse.description.Description
Construct a new Description.
digit - Variable in class jjparse.StringParsing
A Parsing.Parser which parses a single digit (0 - 9).

E

elements - Variable in class jjparse.description.Sequence
The List of Descriptions.
empty() - Static method in class jjparse.input.Input
Constructs an empty Input of an arbitrary element type where "<empty>" is used as the name.
Empty - Class in jjparse.description
A Description for Parsing.Parsers with no expectation hints (which is the default).
Empty() - Constructor for class jjparse.description.Empty
Constructs a new Empty Description.
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.Parser that always fails with an Parsing.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 first record component.
flatMap(Function<T, Parsing.Parser<U>>) - Method in class jjparse.Parsing.Parser
Maps this Parsing.Parser by applying the provided Function to the Parsing.Results it produces.
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.Result in case it is a Parsing.Success to another Parsing.Result using the provided Function and flattens the nested Parsing.Result.
flatMap(Function<T, Parsing.Result<U>>) - Method in class jjparse.Parsing.Success
 
float32 - Variable in class jjparse.StringParsing
A Parsing.Parser which parses a 32-bit IEEE 754 floating point number.
float64 - Variable in class jjparse.StringParsing
A Parsing.Parser which parses a 64-bit IEEE 754 floating point number.
fold(BiFunction<A, B, C>) - Method in record class jjparse.data.Product
Reduces this Product to a value by applying the provided function to this Product's values.
format(Input<?>, Description) - Static method in class jjparse.Parsing.Failure
Format an error message for the provided Input and Description.

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 CharacterInput at this CharacterInput.CodePointPosition.
getColumnNumber() - Method in class jjparse.input.CharacterInput.CodePointPosition
Computes the column number that corresponds to this CharacterInput.CodePointPosition as it is perceived by the user.
getLineNumber() - Method in class jjparse.input.CharacterInput.CodePointPosition
Computes the line number that corresponds to this CharacterInput.CodePointPosition as 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.Result or 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.Parser which parses the traditional C identifier.
input - Variable in class jjparse.input.Input.Position
The Input to which this Input<T>.Position refers.
Input<T> - Class in jjparse.input
An abstract representation of an Input for parsing.
Input(String) - Constructor for class jjparse.input.Input
Constructs a new Input on 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.Parser which parses a signed 32-bit integer.
int64 - Variable in class jjparse.StringParsing
A Parsing.Parser which parses a signed 64-bit integer.
integer - Variable in class jjparse.StringParsing
A Parsing.Parser which parses a signed integer.
isEmpty() - Method in class jjparse.input.CharacterInput
 
isEmpty() - Method in class jjparse.input.Input
Checks whether this Input is 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.Result is a Parsing.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.Failure is 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.Result is a Parsing.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.Parser which 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 Function into a Parsing.Parser.
literal - Variable in class jjparse.description.Literal
The expected String literal.
literal(String) - Method in class jjparse.StringParsing
Creates a primitive Parsing.Parser that attempts to parse the provided String literal.
Literal - Class in jjparse.description
A Description for Parsing.Parsers that expect a String literal.
Literal(String) - Constructor for class jjparse.description.Literal
Construct a new Literal Description.
log(String) - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which prints additional debug output to the standard output stream.
lowercase - Variable in class jjparse.StringParsing
A Parsing.Parser which parses a Latin lowercase letter (a - z).

M

map(Function<A, C>, Function<B, D>) - Method in record class jjparse.data.Product
Maps this Product to 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
Maps this Parsing.Parser by applying the provided Function to the Parsing.Results it produces.
map(Function<T, U>) - Method in class jjparse.Parsing.Result
Maps the value of this Parsing.Result in case it is a Parsing.Success using the provided Function.
map(Function<T, U>) - Method in class jjparse.Parsing.Success
 
message - Variable in class jjparse.Parsing.Failure
The error message that describes this Parsing.Failure in more detail.

N

name - Variable in class jjparse.input.Input
A human-readable name for this Input which can be used for error reporting purposes.
negate() - Method in class jjparse.description.Description
Creates a new Description by creating a Negation from this Description.
Negation - Class in jjparse.description
A Description for Parsing.Parsers that negate another Parsing.Parser's expectation.
Negation(Description) - Constructor for class jjparse.description.Negation
Constructs a new Negation Description.
nonEmpty() - Method in class jjparse.input.Input
Checks whether this Input is not empty.
normalize() - Method in class jjparse.description.Description
Normalizes this Description such that Negations are propagated downwards to the individual Literal and RegExp Descriptions.
not() - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which attempts to not parse this Parsing.Parser.
number - Variable in class jjparse.StringParsing
A Parsing.Parser which 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
Constructs a new Input of Characters on basis of the provided Byte array and Charset.
of(String, InputStream, Charset) - Static method in class jjparse.input.Input
Constructs a new Input of Characters on basis of the provided InputStream and Charset.
of(String, CharSequence) - Static method in class jjparse.input.Input
Constructs a new Input of Characters on basis of the provided CharSequence.
of(String, Iterable<T>) - Static method in class jjparse.input.Input
Constructs a new Input on basis of the provided Iterable.
of(String, Iterator<T>) - Static method in class jjparse.input.Input
Constructs a new Input on basis of the provided Iterator.
of(String, Stream<T>) - Static method in class jjparse.input.Input
Constructs a new Input on basis of the provided Stream.
of(Path, Charset) - Static method in class jjparse.input.Input
Constructs a new Input of Characters on basis of the provided file Path and Charset.
offset - Variable in class jjparse.input.Input.Position
The offset (i.e., the number of skipped elements) to which this Input<T>.Position points in this Input.
optional() - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which attempts to parse this Parsing.Parser and only fails if this Parsing.Parser aborts with an Parsing.Abort.
or(Description) - Method in class jjparse.description.Description
Creates a new Description by creating a Choice from this and the provided Description.
or(Parsing.Parser<? extends T>) - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which first attempts to parse this Parsing.Parser and, if this Parsing.Parser fails with an Parsing.Error, attempts to parse the exact same Input with the provided Parsing.Parser.

P

parse(Parsing.Parser<? extends T>, Input<? extends I>) - Method in class jjparse.Parsing
Attempts to parse the whole Input with the provided Parsing.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 Parsing class and provides access to all Parsing.Parsers and Parsing.Parser combinators 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.Result which 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 Pattern of this Description.
position() - Method in class jjparse.input.CharacterInput
 
position() - Method in class jjparse.input.Input
A Input<T>.Position that points to the first element in this Input.
position() - Method in class jjparse.input.StreamInput
 
position(Parsing.Parser<Function<Input.Position, T>>) - Method in class jjparse.Parsing
Constructs a new Parsing.Parser that behaves just like the given one, applying the current Input.Position to the Function returned by the provided Parsing.Parser.
Position(int) - Constructor for class jjparse.input.Input.Position
Creates a new Input<T>.Position on basis of the provided offset.
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 Product record class.

R

regex(String) - Method in class jjparse.StringParsing
Creates a primitive Parsing.Parser that attempts to match the provided regular expression (which must be a valid Pattern).
RegExp - Class in jjparse.description
A Description for Parsing.Parsers that expect a Pattern.
RegExp(Pattern) - Constructor for class jjparse.description.RegExp
Constructs a new RegExp Description.
repeat() - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which applies this Parsing.Parser arbitrarily many, including zero, times.
repeat1() - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which applies this Parsing.Parser arbitrarily 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 second record component.
separate(Parsing.Parser<?>) - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which parses this Parsing.Parser (possibly zero times) interleaved with the provided separator Parsing.Parser, only returning the values returned by this Parsing.Parser.
separate1(Parsing.Parser<?>) - Method in class jjparse.Parsing.Parser
Creates a Parsing.Parser which parses this Parsing.Parser (at least one time) interleaved with the provided separator Parsing.Parser, only returning the values returned by this Parsing.Parser.
sequence(Parsing.Parser<? extends T>...) - Method in class jjparse.Parsing
Constructs a new Parsing.Parser that applies the provided Parsing.Parsers in sequence.
Sequence - Class in jjparse.description
Sequence(List<Description>) - Constructor for class jjparse.description.Sequence
Constructs a new Sequence Description.
setSkipParser(Parsing.Parser<? extends T>) - Method in class jjparse.Parsing
Sets the Parsing.Parser that is used for skipping Input before another Parsing.Parser is applied.
skip(Input<? extends I>) - Method in class jjparse.Parsing
Skips the prefix of the provided Input using the current skip Parsing.Parser.
StreamInput<T> - Class in jjparse.input
A lazily evaluated Input for Streams of arbitrary elements.
StringParsing - Class in jjparse
An extension of the basic Parsing class that provides basic Parsing.Parsers for Parsing with Strings.
StringParsing() - Constructor for class jjparse.StringParsing
Creates an instance of this StringParsing class and provides access to all Parsing.Parsers and Parsing.Parser combinators in that way.
subSequence(int, int) - Method in class jjparse.input.CharacterInput
 
success(Supplier<? extends T>) - Method in class jjparse.Parsing
Constructs a Parsing.Parser that always succeeds with a Parsing.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.Parser which parses a Latin uppercase letter (A - Z).

V

value - Variable in class jjparse.Parsing.Success
The parsed value of this Parsing.Success.
A B C D E F G H I J L M N O P R S T U V 
All Classes and Interfaces|All Packages