io.github.reggert.reb4j

Class CharLiteral

java.lang.Object

io.github.reggert.reb4j.AbstractExpression

io.github.reggert.reb4j.AbstractAlternative

io.github.reggert.reb4j.AbstractSequenceableAlternative

io.github.reggert.reb4j.Literal

io.github.reggert.reb4j.CharLiteral

All Implemented Interfaces:

Alternative, Expression, Quantifiable, Sequenceable, Serializable

public final class CharLiteral
extends Literal
implements Quantifiable

Expression that matches a single specific character.

See Also:

Literal.literal(char), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
char	unescapedChar

Fields inherited from class io.github.reggert.reb4j.Literal

NEEDS_ESCAPE, specialEscapes

Method Summary

Methods

Modifier and Type	Method and Description
Quantified.AnyTimes	anyTimes() Returns an expression that matches the receiver repeated any number of times, using greedy matching.
Quantified.AnyTimes	anyTimes(Quantified.Mode mode) Returns an expression that matches the receiver repeated any number of times, using the specified matching mode.
Quantified.AnyTimes	anyTimesPossessively() Deprecated.
Quantified.AnyTimes	anyTimesReluctantly() Deprecated.
Quantified.RepeatRange	atLeast(int n) Returns an expression that matches the receiver repeated at least the specified minimum number of times, using greedy matching.
Quantified.RepeatRange	atLeast(int n, Quantified.Mode mode) Returns an expression that matches the receiver repeated at least the specified minimum number of times, using the specified matching mode.
Quantified.AtLeastOnce	atLeastOnce() Returns an expression that matches the receiver repeated at least once, using greedy matching.
Quantified.AtLeastOnce	atLeastOnce(Quantified.Mode mode) Returns an expression that matches the receiver repeated at least once, using the specified matching mode.
Quantified.AtLeastOnce	atLeastOncePossessively() Deprecated.
Quantified.AtLeastOnce	atLeastOnceReluctantly() Deprecated.
Quantified.RepeatRange	atLeastPossessively(int n) Deprecated.
Quantified.RepeatRange	atLeastReluctantly(int n) Deprecated.
boolean	equals(Object obj)
int	hashCode()
Quantified.Optional	optional() Returns an expression that matches the receiver appearing once or not at all, using greedy matching.
Quantified.Optional	optional(Quantified.Mode mode) Returns an expression that matches the receiver appearing once or not at all, using the specified matching mode.
Quantified.Optional	optionalPossessively() Deprecated.
Quantified.Optional	optionalReluctantly() Deprecated.
Quantified.RepeatExactly	repeat(int n) Returns an expression that matches the receiver repeated the specified number of times, using greedy matching.
Quantified.RepeatRange	repeat(int min, int max) Returns an expression that matches the receiver repeated a number of times within the specified range, using greedy matching.
Quantified.RepeatRange	repeat(int min, int max, Quantified.Mode mode) Returns an expression that matches the receiver repeated a number of times within the specified range, using the specified matching mode.
Quantified.RepeatExactly	repeat(int n, Quantified.Mode mode) Returns an expression that matches the receiver repeated the specified number of times, using the specified matching mode.
Quantified.RepeatExactly	repeatPossessively(int n) Deprecated.
Quantified.RepeatRange	repeatPossessively(int min, int max) Deprecated.
Quantified.RepeatExactly	repeatReluctantly(int n) Deprecated.
Quantified.RepeatRange	repeatReluctantly(int min, int max) Deprecated.
String	unescaped() Returns the original unescaped string (or character as a string) matched by this expression.

Methods inherited from class io.github.reggert.reb4j.Literal

boundedLength, escape, escapeChar, escaped, expression, literal, literal, possiblyZeroLength, repetitionInvalidatesBounds

Methods inherited from class io.github.reggert.reb4j.AbstractSequenceableAlternative

andThen, andThen, then, then

Methods inherited from class io.github.reggert.reb4j.AbstractAlternative

or, or

Methods inherited from class io.github.reggert.reb4j.AbstractExpression

toPattern, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.reggert.reb4j.Expression

boundedLength, expression, possiblyZeroLength, repetitionInvalidatesBounds, toPattern

Field Detail

unescapedChar

public final char unescapedChar

Method Detail

anyTimes

public final Quantified.AnyTimes anyTimes(Quantified.Mode mode)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated any number of times, using the specified matching mode.

Specified by:

anyTimes in interface Quantifiable

anyTimes

public final Quantified.AnyTimes anyTimes()

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated any number of times, using greedy matching.

Specified by:

anyTimes in interface Quantifiable

anyTimesReluctantly

@Deprecated
public final Quantified.AnyTimes anyTimesReluctantly()

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated any number of times, using reluctant matching.

Specified by:

anyTimesReluctantly in interface Quantifiable

anyTimesPossessively

@Deprecated
public final Quantified.AnyTimes anyTimesPossessively()

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated any number of times, using possessive matching.

Specified by:

anyTimesPossessively in interface Quantifiable

atLeastOnce

public final Quantified.AtLeastOnce atLeastOnce(Quantified.Mode mode)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least once, using the specified matching mode.

Specified by:

atLeastOnce in interface Quantifiable

atLeastOnce

public final Quantified.AtLeastOnce atLeastOnce()

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least once, using greedy matching.

Specified by:

atLeastOnce in interface Quantifiable

atLeastOnceReluctantly

@Deprecated
public final Quantified.AtLeastOnce atLeastOnceReluctantly()

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least once, using reluctant matching.

Specified by:

atLeastOnceReluctantly in interface Quantifiable

atLeastOncePossessively

@Deprecated
public final Quantified.AtLeastOnce atLeastOncePossessively()

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least once, using possessive matching.

Specified by:

atLeastOncePossessively in interface Quantifiable

optional

public final Quantified.Optional optional(Quantified.Mode mode)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver appearing once or not at all, using the specified matching mode.

Specified by:

optional in interface Quantifiable

optional

public final Quantified.Optional optional()

Description copied from interface: Quantifiable

Returns an expression that matches the receiver appearing once or not at all, using greedy matching.

Specified by:

optional in interface Quantifiable

optionalReluctantly

@Deprecated
public final Quantified.Optional optionalReluctantly()

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver appearing once or not at all, using reluctant matching.

Specified by:

optionalReluctantly in interface Quantifiable

optionalPossessively

@Deprecated
public final Quantified.Optional optionalPossessively()

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver appearing once or not at all, using possessive matching.

Specified by:

optionalPossessively in interface Quantifiable

repeat

public final Quantified.RepeatExactly repeat(int n,
                              Quantified.Mode mode)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated the specified number of times, using the specified matching mode.

Specified by:

repeat in interface Quantifiable

Parameters:

n - the exact number of times the pattern must be repeated for the quantified expression to match; must be >= 0.

mode - the matching mode to use; must not be null.

repeat

public final Quantified.RepeatExactly repeat(int n)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated the specified number of times, using greedy matching.

Specified by:

repeat in interface Quantifiable

Parameters:

n - the exact number of times the pattern must be repeated for the quantified expression to match; must be >= 0.

repeatReluctantly

@Deprecated
public final Quantified.RepeatExactly repeatReluctantly(int n)

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated the specified number of times, using reluctant matching.

Specified by:

repeatReluctantly in interface Quantifiable

Parameters:

n - the exact number of times the pattern must be repeated for the quantified expression to match; must be >= 0.

repeatPossessively

@Deprecated
public final Quantified.RepeatExactly repeatPossessively(int n)

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated the specified number of times, using possessive matching.

Specified by:

repeatPossessively in interface Quantifiable

Parameters:

n - the exact number of times the pattern must be repeated for the quantified expression to match; must be >= 0.

repeat

public final Quantified.RepeatRange repeat(int min,
                            int max,
                            Quantified.Mode mode)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated a number of times within the specified range, using the specified matching mode.

Specified by:

repeat in interface Quantifiable

Parameters:

min - the minimum number of times that the pattern may be repeated; must be >= 0.

max - the maximum number of times that the pattern may be repeated; must be >= min.

mode - the matching mode to use; must not be null.

repeat

public final Quantified.RepeatRange repeat(int min,
                            int max)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated a number of times within the specified range, using greedy matching.

Specified by:

repeat in interface Quantifiable

Parameters:

min - the minimum number of times that the pattern may be repeated; must be >= 0.

max - the maximum number of times that the pattern may be repeated; must be >= min.

repeatReluctantly

@Deprecated
public final Quantified.RepeatRange repeatReluctantly(int min,
                                                  int max)

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated a number of times within the specified range, using reluctant matching.

Specified by:

repeatReluctantly in interface Quantifiable

Parameters:

min - the minimum number of times that the pattern may be repeated; must be >= 0.

max - the maximum number of times that the pattern may be repeated; must be > 0.

repeatPossessively

@Deprecated
public final Quantified.RepeatRange repeatPossessively(int min,
                                                   int max)

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated a number of times within the specified range, using possessive matching.

Specified by:

repeatPossessively in interface Quantifiable

Parameters:

min - the minimum number of times that the pattern may be repeated; must be >= 0.

max - the maximum number of times that the pattern may be repeated; must be > 0.

atLeast

public final Quantified.RepeatRange atLeast(int n,
                             Quantified.Mode mode)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least the specified minimum number of times, using the specified matching mode.

Specified by:

atLeast in interface Quantifiable

Parameters:

n - the minimum number of times that the pattern may be repeated; must be be >= 0;

mode - the matching mode to use; must not be null.

atLeast

public final Quantified.RepeatRange atLeast(int n)

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least the specified minimum number of times, using greedy matching.

Specified by:

atLeast in interface Quantifiable

Parameters:

n - the minimum number of times that the pattern may be repeated; must be be >= 0;

atLeastReluctantly

@Deprecated
public final Quantified.RepeatRange atLeastReluctantly(int n)

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least the specified minimum number of times, using reluctant matching.

Specified by:

atLeastReluctantly in interface Quantifiable

Parameters:

n - the minimum number of times that the pattern may be repeated; must be be >= 0;

atLeastPossessively

@Deprecated
public final Quantified.RepeatRange atLeastPossessively(int n)

Deprecated.

Description copied from interface: Quantifiable

Returns an expression that matches the receiver repeated at least the specified minimum number of times, using possessive matching.

Specified by:

atLeastPossessively in interface Quantifiable

Parameters:

n - the minimum number of times that the pattern may be repeated; must be be >= 0;

unescaped

public String unescaped()

Description copied from class: Literal

Returns the original unescaped string (or character as a string) matched by this expression.

Specified by:

unescaped in class Literal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object