io.github.reggert.reb4j.charclass

Class CharClass

java.lang.Object

io.github.reggert.reb4j.AbstractExpression

io.github.reggert.reb4j.AbstractAlternative

io.github.reggert.reb4j.AbstractSequenceableAlternative

io.github.reggert.reb4j.AbstractQuantifiableSequenceableAlternative

io.github.reggert.reb4j.charclass.CharClass

All Implemented Interfaces:

Alternative, Expression, Quantifiable, Sequenceable, Serializable

Direct Known Subclasses:

CharRange, Intersection, MultiChar, Negated, PredefinedClass, SingleChar, Union

public abstract class CharClass
extends AbstractQuantifiableSequenceableAlternative
implements Expression, Quantifiable, Sequenceable, Alternative

Base class representing an expression that matches a single character within a class of characters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharClass.Java Module containing predefined character classes matching character traits defined by the Character class.
static class	CharClass.Perl Module containing Perl-style predefined character classes.
static class	CharClass.Posix Module containing POSIX-style predefined character classes.
static class	CharClass.Unicode Module containing predefined character classes matching a single character that has certain traits defined by the Unicode specification.

Constructor Summary

Constructors

Constructor and Description
CharClass()

Method Summary

Methods

Modifier and Type	Method and Description
Integer	boundedLength() Indicates the computed maximum length of the expression, if one can be determined.
static SingleChar	character(char c) Constructs a character class consisting of a single character.
static MultiChar	characters(char c1, char c2, char... cs) Constructs a character class consisting of several characters.
fj.data.LazyString	expression() Returns the regular expression represented by this object.
Intersection	intersect(CharClass right) Returns the intersection of this character class with the specified character class.
Intersection	intersect(Intersection right) Returns the intersection of this character class with the specified character classes.
abstract CharClass	negated() Returns an expressing matching a single character that is not within the class of characters matched by this expression.
boolean	possiblyZeroLength() Indicates whether the expression may possibly be zero length.
static CharRange	range(char first, char last) Constructs a character class consisting of all characters in a range.
boolean	repetitionInvalidatesBounds() Indicates whether applying repetition to the expression invalidates the boundedness computation.
Union	union(CharClass right) Returns the union of this character class with the specified character class.
Union	union(Union right) Returns the union of this character class with the specified character classes.

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

anyTimes, anyTimes, anyTimesPossessively, anyTimesReluctantly, atLeast, atLeast, atLeastOnce, atLeastOnce, atLeastOncePossessively, atLeastOnceReluctantly, atLeastPossessively, atLeastReluctantly, optional, optional, optionalPossessively, optionalReluctantly, repeat, repeat, repeat, repeat, repeatPossessively, repeatPossessively, repeatReluctantly, repeatReluctantly

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

anyTimes, anyTimes, anyTimesPossessively, anyTimesReluctantly, atLeast, atLeast, atLeastOnce, atLeastOnce, atLeastOncePossessively, atLeastOnceReluctantly, atLeastPossessively, atLeastReluctantly, optional, optional, optionalPossessively, optionalReluctantly, repeat, repeat, repeat, repeat, repeatPossessively, repeatPossessively, repeatReluctantly, repeatReluctantly

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

andThen, andThen, then, then

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

or, or

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

toPattern

Constructor Detail

CharClass

public CharClass()

Method Detail

expression

public final fj.data.LazyString expression()

Description copied from interface: Expression

Returns the regular expression represented by this object.

Specified by:

expression in interface Expression

boundedLength

public Integer boundedLength()

Description copied from interface: Expression

Indicates the computed maximum length of the expression, if one can be determined.

Specified by:

boundedLength in interface Expression

Returns:

the computed maximum length, or null if it is unbounded.

repetitionInvalidatesBounds

public boolean repetitionInvalidatesBounds()

Description copied from interface: Expression

Indicates whether applying repetition to the expression invalidates the boundedness computation. This generally indicates that the expression may match a zero-repetition ({0, n} or ?). This is used to determine boundedness of enclosing expressions.

Specified by:

repetitionInvalidatesBounds in interface Expression

possiblyZeroLength

public boolean possiblyZeroLength()

Description copied from interface: Expression

Indicates whether the expression may possibly be zero length. Used in some cases for determining repetitionInvalidatesBounds.

Specified by:

possiblyZeroLength in interface Expression

negated

public abstract CharClass negated()

Returns an expressing matching a single character that is not within the class of characters matched by this expression.

union

public Union union(Union right)

Returns the union of this character class with the specified character classes.

union

public Union union(CharClass right)

Returns the union of this character class with the specified character class.

intersect

public Intersection intersect(CharClass right)

Returns the intersection of this character class with the specified character class.

intersect

public Intersection intersect(Intersection right)

Returns the intersection of this character class with the specified character classes.

character

public static SingleChar character(char c)

Constructs a character class consisting of a single character.

characters

public static MultiChar characters(char c1,
                   char c2,
                   char... cs)

Constructs a character class consisting of several characters.

range

public static CharRange range(char first,
              char last)

Constructs a character class consisting of all characters in a range.

Parameters:

first - the minimum bound for the range.

last - the maximum bound for the range; must be greater than first.

Throws:

IllegalArgumentException - if last <= first.