jParsec 3.1 · org.jparsec.pattern.Patterns · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final Pattern	ALWAYS A `Pattern` that always matches with match length `0`.
public static final Pattern	ANY_CHAR A `Pattern` that matches any character and only mismatches for an empty string.
public static final Pattern	DEC_INTEGER A `Pattern` object that matches a decimal integer, which starts with a non-zero digit and is followed by 0 or more digits.
public static final Pattern	DECIMAL A `Pattern` object that matches a decimal number that could start with a decimal point or a digit.
public static final Pattern	EOF A `Pattern` object that matches if the input has no character left.
public static final Pattern	ESCAPED A `Pattern` object that succeeds with match length `2` if there are at least 2 characters in the input and the first character is `'\'`.
public static final Pattern	FRACTION A `Pattern` object that matches a decimal point and one or more digits after it.
public static final Pattern	HEX_INTEGER A `Pattern` object that matches a hex integer, which starts with a `0x` or `0X`, and is followed by one or more hex digits.
public static final Pattern	INTEGER A `Pattern` object that matches an integer.
public static final Pattern	NEVER A `Pattern` that always returns `Pattern#MISMATCH`.
public static final Pattern	OCT_INTEGER A `Pattern` object that matches an octal integer that starts with a `0` and is followed by 0 or more `[0 - 7]` characters.
public static final Pattern	REGEXP_MODIFIERS A `Pattern` object that matches regular expression modifiers, which is a list of alpha characters.
public static final Pattern	REGEXP_PATTERN A `Pattern` object that matches any regular expression pattern string in the form of `/some pattern here/`.
public static final Pattern	SCIENTIFIC_NOTATION A `Pattern` object that matches a scientific notation, such as `1e12`, `1.2E-1`, etc.
public static final Pattern	STRICT_DECIMAL A `Pattern` object that matches a decimal number that has at least one digit before the decimal point.
public static final Pattern	WORD A `Pattern` object that matches a standard english word, which starts with either an underscore or an alpha character, followed by 0 or more alphanumeric characters.

Constructor Summary

Access	Constructor and Description
private	Patterns()

Method Summary

Modifier and Type	Method and Description
public static Pattern	among(String chars) Returns a `Pattern` object that matches if the current character in the input is equal to any character in `chars`, in which case `1` is returned as match length.
public static Pattern	and(final Pattern... patterns) Returns a `Pattern` that matches if all of `patterns` matches, in which case, the maximum match length is returned.
public static Pattern	atLeast(final int min, final CharPredicate predicate) Returns a `Pattern` object that matches if the input starts with `min` or more characters and all satisfy `predicate`.
public static Pattern	atMost(final int max, final CharPredicate predicate) Returns a `Pattern` that matches up to `max` number of characters satisfying `predicate`.
private static Pattern	getModifiersPattern()
private static Pattern	getRegularExpressionPattern()
public static Pattern	hasAtLeast(final int n) Returns a `Pattern` object that matches if the input has at least `n` characters left.
public static Pattern	hasExact(final int n) Returns a `Pattern` object that matches if the input has exactly `n` characters left.
public static Pattern	isChar(char c) Returns a `Pattern` object that matches if the current character in the input is equal to character `c`, in which case `1` is returned as match length.
public static Pattern	isChar(final CharPredicate predicate) Returns a `Pattern` object that matches if the current character in the input satisfies `predicate`, in which case `1` is returned as match length.
public static Pattern	lineComment(String begin) Returns a `Pattern` object that matches a line comment started by `begin` and ended by `EOF` or `LF` (the line feed character).
public static Pattern	longer(Pattern p1, Pattern p2) Returns a `Pattern` that tries both `p1` and `p2`, and picks the one with the longer match length.
public static Pattern	longest(final Pattern... patterns) Returns a `Pattern` that tries all of `patterns`, and picks the one with the longest match length.
public static Pattern	many(int min, CharPredicate predicate) Deprecated Use `atLeast(int, CharPredicate)` instead. Returns a `Pattern` object that matches if the input starts with `min` or more characters and all satisfy `predicate`.
public static Pattern	many(final CharPredicate predicate) Returns a `Pattern` that matches 0 or more characters satisfying `predicate`.
public static Pattern	many1(CharPredicate predicate) Returns a `Pattern` that matches 1 or more characters satisfying `predicate`.
private static int	matchMany(CharPredicate predicate, CharSequence src, int len, int from, int acc)
private static int	matchSome(int max, CharPredicate predicate, CharSequence src, int len, int from, int acc)
private static int	Returns: the number of characters matched, or `Pattern#MISMATCH` if an unexpected character is encountered. matchString(String the pattern string. str, CharSequence the input sequence. Must not be null. src, int start of index to scan characters from `src`. begin, int end of index to scan characters from `src`. end) Matches (part of) a character sequence against a pattern string.
private static int	matchStringCaseInsensitive(String str, CharSequence src, int begin, int end)
pack-priv static Pattern	nextWithEmpty(Pattern left, Pattern right)
public static Pattern	Returns: a `Pattern` that matches iff the input does not match nested `pattern`. not(Pattern pattern)
public static Pattern	notString(final String string) Returns a `Pattern` object that matches if the input has at least 1 character and doesn't match `string`.
public static Pattern	notStringCaseInsensitive(final String string) Returns a `Pattern` object that matches if the input has at least 1 character and doesn't match `string` case insensitively.
pack-priv static Pattern	optional(Pattern pp)
public static Pattern	or(Pattern... patterns) Returns a `Pattern` that matches if any of `patterns` matches, in which case, the first match length is returned.
pack-priv static Pattern	orWithoutEmpty(Pattern left, Pattern right)
public static Pattern	range(char c1, char c2) Returns a `Pattern` object that matches if the current character in the input is between character `c1` and `c2`, in which case `1` is returned as match length.
public static Pattern	regex(final Pattern p) Adapts a regular expression pattern to a `Pattern`.
public static Pattern	regex(String s) Adapts a regular expression pattern string to a `Pattern`.
public static Pattern	repeat(int n, CharPredicate predicate) Returns a `Pattern` object that matches if the input has at least `n` characters and the first `n` characters all satisfy `predicate`.
public static Pattern	sequence(Pattern... patterns) Returns a `Pattern` object that matches the input against `patterns` sequentially.
public static Pattern	shorter(Pattern p1, Pattern p2) Returns a `Pattern` that tries both `p1` and `p2`, and picks the one with the shorter match length.
public static Pattern	shortest(final Pattern... patterns) Returns a `Pattern` that tries all of `patterns`, and picks the one with the shortest match length.
public static Pattern	some(int min, int max, CharPredicate predicate) Deprecated Use `times(int, int, CharPredicate)` instead. Returns a `Pattern` that matches at least `min` and up to `max` number of characters satisfying `predicate`,
public static Pattern	some(final int max, final CharPredicate predicate) Deprecated Use `atMost(int, CharPredicate)` instead. Returns a `Pattern` that matches up to `max` number of characters satisfying `predicate`.
public static Pattern	string(final String string) Returns a `Pattern` object that matches `string` literally.
public static Pattern	stringCaseInsensitive(final String string) Returns a `Pattern` object that matches `string` case insensitively.
public static Pattern	times(final int min, final int max, final CharPredicate predicate) Returns a `Pattern` that matches at least `min` and up to `max` number of characters satisfying `predicate`,

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALWAYS	back to summary
public static final Pattern ALWAYS A `Pattern` that always matches with match length `0`.

ANY_CHAR	back to summary
public static final Pattern ANY_CHAR A `Pattern` that matches any character and only mismatches for an empty string.

DEC_INTEGER	back to summary
public static final Pattern DEC_INTEGER A `Pattern` object that matches a decimal integer, which starts with a non-zero digit and is followed by 0 or more digits.

DECIMAL	back to summary
public static final Pattern DECIMAL A `Pattern` object that matches a decimal number that could start with a decimal point or a digit.

EOF	back to summary
public static final Pattern EOF A `Pattern` object that matches if the input has no character left. Match length is `0` if succeed.

ESCAPED	back to summary
public static final Pattern ESCAPED A `Pattern` object that succeeds with match length `2` if there are at least 2 characters in the input and the first character is `'\'`. Mismatch otherwise.

FRACTION	back to summary
public static final Pattern FRACTION A `Pattern` object that matches a decimal point and one or more digits after it.

HEX_INTEGER	back to summary
public static final Pattern HEX_INTEGER A `Pattern` object that matches a hex integer, which starts with a `0x` or `0X`, and is followed by one or more hex digits.

INTEGER	back to summary
public static final Pattern INTEGER A `Pattern` object that matches an integer.

NEVER	back to summary
public static final Pattern NEVER A `Pattern` that always returns `Pattern#MISMATCH`.

OCT_INTEGER	back to summary
public static final Pattern OCT_INTEGER A `Pattern` object that matches an octal integer that starts with a `0` and is followed by 0 or more `[0 - 7]` characters.

REGEXP_MODIFIERS	back to summary
public static final Pattern REGEXP_MODIFIERS A `Pattern` object that matches regular expression modifiers, which is a list of alpha characters.

REGEXP_PATTERN	back to summary
public static final Pattern REGEXP_PATTERN A `Pattern` object that matches any regular expression pattern string in the form of `/some pattern here/`. `'\'` is used as escape character.

SCIENTIFIC_NOTATION	back to summary
public static final Pattern SCIENTIFIC_NOTATION A `Pattern` object that matches a scientific notation, such as `1e12`, `1.2E-1`, etc.

STRICT_DECIMAL back to summary

STRICT_DECIMAL	back to summary
public static final Pattern STRICT_DECIMAL A `Pattern` object that matches a decimal number that has at least one digit before the decimal point. The decimal point and the numbers to the right are optional. `0, 11., 2.3` are all good candidates. While `.1, .` are not.

public static final Pattern STRICT_DECIMAL

A Pattern object that matches a decimal number that has at least one digit before the decimal point. The decimal point and the numbers to the right are optional.

0, 11., 2.3 are all good candidates. While .1, . are not.

WORD	back to summary
public static final Pattern WORD A `Pattern` object that matches a standard english word, which starts with either an underscore or an alpha character, followed by 0 or more alphanumeric characters.

Constructor Detail

Patterns	back to summary
private Patterns()

Method Detail

among	back to summary
public static Pattern among(String chars) Returns a `Pattern` object that matches if the current character in the input is equal to any character in `chars`, in which case `1` is returned as match length.

and	back to summary
public static Pattern and(final Pattern... patterns) Returns a `Pattern` that matches if all of `patterns` matches, in which case, the maximum match length is returned. Mismatch if any one mismatches.

atLeast back to summary

atLeast	back to summary
public static Pattern atLeast(final int min, final CharPredicate predicate) Returns a `Pattern` object that matches if the input starts with `min` or more characters and all satisfy `predicate`. Since 2.2

public static Pattern atLeast(final int min, final CharPredicate predicate)

Returns a Pattern object that matches if the input starts with min or more characters and all satisfy predicate.

Since: 2.2

atMost back to summary

atMost	back to summary
public static Pattern atMost(final int max, final CharPredicate predicate) Returns a `Pattern` that matches up to `max` number of characters satisfying `predicate`. Since 2.2

public static Pattern atMost(final int max, final CharPredicate predicate)

Returns a Pattern that matches up to max number of characters satisfying predicate.

Since: 2.2

getModifiersPattern	back to summary
private static Pattern getModifiersPattern()

getRegularExpressionPattern	back to summary
private static Pattern getRegularExpressionPattern()

hasAtLeast	back to summary
public static Pattern hasAtLeast(final int n) Returns a `Pattern` object that matches if the input has at least `n` characters left. Match length is `n` if succeed.

hasExact	back to summary
public static Pattern hasExact(final int n) Returns a `Pattern` object that matches if the input has exactly `n` characters left. Match length is `n` if succeed.

isChar	back to summary
public static Pattern isChar(char c) Returns a `Pattern` object that matches if the current character in the input is equal to character `c`, in which case `1` is returned as match length. Mismatches otherwise.

isChar	back to summary
public static Pattern isChar(final CharPredicate predicate) Returns a `Pattern` object that matches if the current character in the input satisfies `predicate`, in which case `1` is returned as match length.

lineComment	back to summary
public static Pattern lineComment(String begin) Returns a `Pattern` object that matches a line comment started by `begin` and ended by `EOF` or `LF` (the line feed character).

longer	back to summary
public static Pattern longer(Pattern p1, Pattern p2) Returns a `Pattern` that tries both `p1` and `p2`, and picks the one with the longer match length. If both have the same length, `p1` is favored.

longest	back to summary
public static Pattern longest(final Pattern... patterns) Returns a `Pattern` that tries all of `patterns`, and picks the one with the longest match length. If two patterns have the same length, the first one is favored.

many back to summary

many	back to summary
public static Pattern many(int min, CharPredicate predicate) Deprecated Use `atLeast(int, CharPredicate)` instead. Returns a `Pattern` object that matches if the input starts with `min` or more characters and all satisfy `predicate`. Annotations @Deprecated

public static Pattern many(int min, CharPredicate predicate)

Deprecated

Use atLeast(int, CharPredicate) instead.

Returns a Pattern object that matches if the input starts with min or more characters and all satisfy predicate.

Annotations

@Deprecated

many	back to summary
public static Pattern many(final CharPredicate predicate) Returns a `Pattern` that matches 0 or more characters satisfying `predicate`.

many1	back to summary
public static Pattern many1(CharPredicate predicate) Returns a `Pattern` that matches 1 or more characters satisfying `predicate`.

matchMany	back to summary
private static int matchMany(CharPredicate predicate, CharSequence src, int len, int from, int acc)

matchSome	back to summary
private static int matchSome(int max, CharPredicate predicate, CharSequence src, int len, int from, int acc)

matchString back to summary

matchString	back to summary
private static int matchString(String str, CharSequence src, int begin, int end) Matches (part of) a character sequence against a pattern string. Parameters str:String the pattern string. src:CharSequence the input sequence. Must not be null. begin:int start of index to scan characters from `src`. end:int end of index to scan characters from `src`. Returns:int the number of characters matched, or `Pattern#MISMATCH` if an unexpected character is encountered.

private static int matchString(String str, CharSequence src, int begin, int end)

Matches (part of) a character sequence against a pattern string.

Parameters

str:String: the pattern string.
src:CharSequence: the input sequence. Must not be null.
begin:int: start of index to scan characters from src.
end:int: end of index to scan characters from src.

Returns:int

the number of characters matched, or Pattern#MISMATCH if an unexpected character is encountered.

matchStringCaseInsensitive	back to summary
private static int matchStringCaseInsensitive(String str, CharSequence src, int begin, int end)

nextWithEmpty	back to summary
pack-priv static Pattern nextWithEmpty(Pattern left, Pattern right)

not	back to summary
public static Pattern not(Pattern pattern) Returns:Pattern a `Pattern` that matches iff the input does not match nested `pattern`.

notString	back to summary
public static Pattern notString(final String string) Returns a `Pattern` object that matches if the input has at least 1 character and doesn't match `string`. `1` is returned as match length if succeeds.

notStringCaseInsensitive	back to summary
public static Pattern notStringCaseInsensitive(final String string) Returns a `Pattern` object that matches if the input has at least 1 character and doesn't match `string` case insensitively. `1` is returned as match length if succeeds.

optional	back to summary
pack-priv static Pattern optional(Pattern pp)

or	back to summary
public static Pattern or(Pattern... patterns) Returns a `Pattern` that matches if any of `patterns` matches, in which case, the first match length is returned. Mismatch if any one mismatches.

orWithoutEmpty	back to summary
pack-priv static Pattern orWithoutEmpty(Pattern left, Pattern right)

range	back to summary
public static Pattern range(char c1, char c2) Returns a `Pattern` object that matches if the current character in the input is between character `c1` and `c2`, in which case `1` is returned as match length.

regex	back to summary
public static Pattern regex(final Pattern p) Adapts a regular expression pattern to a `Pattern`. Warning in addition to regular expression cost, the returned `Pattern` object needs to make a substring copy every time it's evaluated. This can incur excessive copying and memory overhead when parsing large strings. Consider implementing `Pattern` manually for large input.

regex	back to summary
public static Pattern regex(String s) Adapts a regular expression pattern string to a `Pattern`. Warning in addition to regular expression cost, the returned `Pattern` object needs to make a substring copy every time it's evaluated. This can incur excessive copying and memory overhead when parsing large strings. Consider implementing `Pattern` manually for large input.

repeat	back to summary
public static Pattern repeat(int n, CharPredicate predicate) Returns a `Pattern` object that matches if the input has at least `n` characters and the first `n` characters all satisfy `predicate`.

sequence	back to summary
public static Pattern sequence(Pattern... patterns) Returns a `Pattern` object that matches the input against `patterns` sequentially. Te total match length is returned if all succeed.

shorter	back to summary
public static Pattern shorter(Pattern p1, Pattern p2) Returns a `Pattern` that tries both `p1` and `p2`, and picks the one with the shorter match length. If both have the same length, `p1` is favored.

shortest	back to summary
public static Pattern shortest(final Pattern... patterns) Returns a `Pattern` that tries all of `patterns`, and picks the one with the shortest match length. If two patterns have the same length, the first one is favored.

some back to summary

public static Pattern some(int min, int max, CharPredicate predicate)

Deprecated

Use times(int, int, CharPredicate) instead.

Returns a Pattern that matches at least min and up to max number of characters satisfying predicate,

Annotations

@Deprecated

some back to summary

public static Pattern some(final int max, final CharPredicate predicate)

Deprecated

Use atMost(int, CharPredicate) instead.

Returns a Pattern that matches up to max number of characters satisfying predicate.

Annotations

@Deprecated

string	back to summary
public static Pattern string(final String string) Returns a `Pattern` object that matches `string` literally.

stringCaseInsensitive	back to summary
public static Pattern stringCaseInsensitive(final String string) Returns a `Pattern` object that matches `string` case insensitively.

times back to summary

public static Pattern times(final int min, final int max, final CharPredicate predicate)

Returns a Pattern that matches at least min and up to max number of characters satisfying predicate,

Since: 2.2

public final Class Patterns

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail