de.unkrig.lfr.core

Class Sequences

java.lang.Object

de.unkrig.lfr.core.Sequences

public final class Sequences
extends Object

Methods that create all kinds of Sequences.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sequences.LiteralString Representation of a sequence of literal, case-sensitive characters.

Field Summary

Fields

Modifier and Type	Field and Description
static de.unkrig.lfr.core.Sequence	TERMINAL Matches the empty string, and is the last element of any CompositeSequence chain.

Method Summary

Modifier and Type	Method and Description
static de.unkrig.lfr.core.Sequence	alternatives(de.unkrig.lfr.core.Sequence[] alternatives) Creates and returns Sequence that returns the first match of one alternatives plus this sequence's successor.
static de.unkrig.lfr.core.Sequence	beginningOfInput() Implements "^" with !
static de.unkrig.lfr.core.Sequence	beginningOfLine() Implements "^" with MULTILINE.
static de.unkrig.lfr.core.Sequence	beginningOfUnixLine() Implements "^" with MULTILINE and UNIX_LINES.
static de.unkrig.lfr.core.Sequence	capturingGroupEnd(int groupNumber) Implements ")".
static de.unkrig.lfr.core.Sequence	capturingGroupStart(int groupNumber) Implements "(".
static de.unkrig.lfr.core.Sequence	endOfInput() Implements "$" with !
static de.unkrig.lfr.core.Sequence	endOfInputButFinalTerminator() Implements "\Z".
static de.unkrig.lfr.core.Sequence	endOfInputButFinalUnixTerminator() Implements "\Z".
static de.unkrig.lfr.core.Sequence	endOfLine() Implements "$" with MULTILINE.
static de.unkrig.lfr.core.Sequence	endOfPreviousMatch() Implements "\G".
static de.unkrig.lfr.core.Sequence	endOfUnixLine() Implements "$" with MULTILINE and UNIX_LINES.
static de.unkrig.lfr.core.Sequence	greedyQuantifierOfAnyChar(int min, int max, Sequences.LiteralString ls) Implements a greedy quantifier on an "any char" operand, followed by a literal String.
static de.unkrig.lfr.core.Sequence	greedyQuantifierOfCharacterClass(CharacterClass operand, int min, int max) Optimized version of #greedyQuantifierSequence(Sequence, int, int) when the operand is a bare character predicate, e.g. a character class.
static de.unkrig.lfr.core.Sequence	independentNonCapturingGroup(de.unkrig.lfr.core.Sequence[] alternatives) Creates and returns a Sequence that matches the alternatives, and, after the first matching alternative, matches its successor.
static de.unkrig.lfr.core.Sequence	linebreak() A sequence that matches a linebreak; implements "\R".
static de.unkrig.lfr.core.Sequence	negate(de.unkrig.lfr.core.Sequence op) Creates and returns a sequence that produces a zero-width match iff the op does not match, and otherwise (iff the op does match) does not match.
static de.unkrig.lfr.core.Sequence	positiveLookahead(de.unkrig.lfr.core.Sequence op) Implements {@code "(?
static de.unkrig.lfr.core.Sequence	positiveLookbehind(de.unkrig.lfr.core.Sequence op) Implements {@code "(?
static de.unkrig.lfr.core.Sequence	possessiveQuantifier(de.unkrig.lfr.core.Sequence operand, int min, int max) Implements a "possessive" quantifier for an operand.
static de.unkrig.lfr.core.Sequence	quantifier(de.unkrig.lfr.core.Sequence operand, int min, int max, int counterIndex, boolean greedy) Implements greedy and reluctant (but not possessive) quantifiers.
static de.unkrig.lfr.core.CompositeSequence	reluctantQuantifierOfAnyChar(int min, int max, Sequences.LiteralString ls) Implements a reluctant quantifier on an "any char" operand, followed by a literal String.
static de.unkrig.lfr.core.Sequence	unicodeWordBoundary() Implements "\b", and, negated, "\B".
static de.unkrig.lfr.core.Sequence	wordBoundary() Implements "\b", and, negated, "\B".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TERMINAL

public static final de.unkrig.lfr.core.Sequence TERMINAL

Matches the empty string, and is the last element of any CompositeSequence chain.

Method Detail

quantifier

public static de.unkrig.lfr.core.Sequence quantifier(de.unkrig.lfr.core.Sequence operand,
                                                     int min,
                                                     int max,
                                                     int counterIndex,
                                                     boolean greedy)

Implements greedy and reluctant (but not possessive) quantifiers.

reluctantQuantifierOfAnyChar

public static de.unkrig.lfr.core.CompositeSequence reluctantQuantifierOfAnyChar(int min,
                                                                                int max,
                                                                                Sequences.LiteralString ls)

Implements a reluctant quantifier on an "any char" operand, followed by a literal String.

Examples: ".*?ABC" ".{3,17}?ABC"

possessiveQuantifier

public static de.unkrig.lfr.core.Sequence possessiveQuantifier(de.unkrig.lfr.core.Sequence operand,
                                                               int min,
                                                               int max)

Implements a "possessive" quantifier for an operand.

alternatives

public static de.unkrig.lfr.core.Sequence alternatives(de.unkrig.lfr.core.Sequence[] alternatives)

Creates and returns Sequence that returns the first match of one alternatives plus this sequence's successor. For example, "a(b|bb)c" will match both "abc" and "abbc". (In the second case, matching "abc" fails, but matching "abbc" eventually succeeds.)

See Also:

independentNonCapturingGroup(Sequence[])

independentNonCapturingGroup

public static de.unkrig.lfr.core.Sequence independentNonCapturingGroup(de.unkrig.lfr.core.Sequence[] alternatives)

Creates and returns a Sequence that matches the alternatives, and, after the first matching alternative, matches its successor. For example, "a(?>b|bb)c" will match "abc" but not "abbc". (In the second case, matching "ab" succeeds, "abb" is never tried.)

See Also:

alternatives(Sequence[])

capturingGroupStart

public static de.unkrig.lfr.core.Sequence capturingGroupStart(int groupNumber)

Implements "(".

capturingGroupEnd

public static de.unkrig.lfr.core.Sequence capturingGroupEnd(int groupNumber)

Implements ")".

beginningOfInput

public static de.unkrig.lfr.core.Sequence beginningOfInput()

Implements "^" with !MULTILINE, and "\A".

beginningOfLine

public static de.unkrig.lfr.core.Sequence beginningOfLine()

Implements "^" with MULTILINE.

beginningOfUnixLine

public static de.unkrig.lfr.core.Sequence beginningOfUnixLine()

Implements "^" with MULTILINE and UNIX_LINES.

endOfInputButFinalTerminator

public static de.unkrig.lfr.core.Sequence endOfInputButFinalTerminator()

Implements "\Z".

endOfInputButFinalUnixTerminator

public static de.unkrig.lfr.core.Sequence endOfInputButFinalUnixTerminator()

Implements "\Z".

endOfInput

public static de.unkrig.lfr.core.Sequence endOfInput()

Implements "$" with !MULTILINE, and "\z".

endOfLine

public static de.unkrig.lfr.core.Sequence endOfLine()

Implements "$" with MULTILINE.

endOfUnixLine

public static de.unkrig.lfr.core.Sequence endOfUnixLine()

Implements "$" with MULTILINE and UNIX_LINES.

linebreak

public static de.unkrig.lfr.core.Sequence linebreak()

A sequence that matches a linebreak; implements "\R".

wordBoundary

public static de.unkrig.lfr.core.Sequence wordBoundary()

Implements "\b", and, negated, "\B".

unicodeWordBoundary

public static de.unkrig.lfr.core.Sequence unicodeWordBoundary()

Implements "\b", and, negated, "\B".

endOfPreviousMatch

public static de.unkrig.lfr.core.Sequence endOfPreviousMatch()

Implements "\G".

positiveLookahead

public static de.unkrig.lfr.core.Sequence positiveLookahead(de.unkrig.lfr.core.Sequence op)

Implements "(?=X)".

positiveLookbehind

public static de.unkrig.lfr.core.Sequence positiveLookbehind(de.unkrig.lfr.core.Sequence op)

Implements "(?<=X)".

greedyQuantifierOfCharacterClass

public static de.unkrig.lfr.core.Sequence greedyQuantifierOfCharacterClass(CharacterClass operand,
                                                                           int min,
                                                                           int max)

Optimized version of #greedyQuantifierSequence(Sequence, int, int) when the operand is a bare character predicate, e.g. a character class.

greedyQuantifierOfAnyChar

public static de.unkrig.lfr.core.Sequence greedyQuantifierOfAnyChar(int min,
                                                                    int max,
                                                                    Sequences.LiteralString ls)

Implements a greedy quantifier on an "any char" operand, followed by a literal String.

Examples: ".*ABC" ".{3,17}ABC"

negate

public static de.unkrig.lfr.core.Sequence negate(de.unkrig.lfr.core.Sequence op)

Creates and returns a sequence that produces a zero-width match iff the op does not match, and otherwise (iff the op does match) does not match.