Modifier and Type	Class and Description
private static class	StrMatcher.CharMatcher References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Class used to define a character for matching purposes.
private static class	StrMatcher.CharSetMatcher References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Class used to define a set of characters for matching purposes.
private static class	StrMatcher.NoMatcher References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Class used to match no characters.
private static class	StrMatcher.StringMatcher References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Class used to define a set of characters for matching purposes.
private static class	StrMatcher.TrimMatcher References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Class used to match whitespace as per trim().

Field Summary

Modifier and Type	Field and Description
private static final StrMatcher	COMMA_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the comma character.
private static final StrMatcher	DOUBLE_QUOTE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the double quote character.
private static final StrMatcher	NONE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches no characters.
private static final StrMatcher	QUOTE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the single or double quote character.
private static final StrMatcher	SINGLE_QUOTE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the double quote character.
private static final StrMatcher	SPACE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the space character.
private static final StrMatcher	SPLIT_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the same characters as StringTokenizer, namely space, tab, newline, form feed.
private static final StrMatcher	TAB_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the tab character.
private static final StrMatcher	TRIM_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the String trim() whitespace characters.

Access	Constructor and Description
protected	StrMatcher() Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
public static StrMatcher	Returns: a new Matcher for the given char. charMatcher(final char the character to match, must not be null. ch) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Creates a matcher from a character.
public static StrMatcher	Returns: a new matcher for the given char[]. charSetMatcher(final char... the characters to match, null or empty matches nothing. chars) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Creates a matcher from a set of characters.
public static StrMatcher	Returns: a new Matcher for the given characters. charSetMatcher(final String the characters to match, null or empty matches nothing. chars) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Creates a matcher from a string representing a set of characters.
public static StrMatcher	Returns: a matcher for a comma. commaMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Returns a matcher which matches the comma character.
public static StrMatcher	Returns: a matcher for a double quote. doubleQuoteMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Returns a matcher which matches the double quote character.
public int	Returns: The number of matching characters, or zero if there is no match. isMatch(final char[] the text content to match against, do not change. buffer, final int the starting position for the match, valid for buffer. pos) Returns the number of matching characters, or zero if there is no match.
public abstract int	Returns: The number of matching characters, or zero if there is no match. isMatch(char[] the text content to match against, do not change. buffer, int the starting position for the match, valid for buffer. pos, int the first active index in the buffer, valid for buffer. bufferStart, int the end index (exclusive) of the active buffer, valid for buffer. bufferEnd) Returns the number of matching characters, or zero if there is no match.
public static StrMatcher	Returns: a matcher that matches nothing. noneMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches no characters.
public static StrMatcher	Returns: a matcher for a single or double quote. quoteMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Returns a matcher which matches the single or double quote character.
public static StrMatcher	Returns: a matcher for a single quote. singleQuoteMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Returns a matcher which matches the single quote character.
public static StrMatcher	Returns: a matcher for a space. spaceMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Returns a matcher which matches the space character.
public static StrMatcher	Returns: The split matcher. splitMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the same characters as StringTokenizer, namely space, tab, newline and form feed.
public static StrMatcher	Returns: a new Matcher for the given String stringMatcher(final String the string to match, null or empty matches nothing str) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Creates a matcher from a string.
public static StrMatcher	Returns: a matcher for a tab. tabMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Returns a matcher which matches the tab character.
public static StrMatcher	Returns: The trim matcher. trimMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. Matches the String trim() whitespace characters.

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

Field Detail

COMMA_MATCHER	back to summary
private static final StrMatcher COMMA_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the comma character.

DOUBLE_QUOTE_MATCHER	back to summary
private static final StrMatcher DOUBLE_QUOTE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the double quote character.

NONE_MATCHER	back to summary
private static final StrMatcher NONE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches no characters.

QUOTE_MATCHER	back to summary
private static final StrMatcher QUOTE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the single or double quote character.

SINGLE_QUOTE_MATCHER	back to summary
private static final StrMatcher SINGLE_QUOTE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the double quote character.

SPACE_MATCHER	back to summary
private static final StrMatcher SPACE_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the space character.

SPLIT_MATCHER	back to summary
private static final StrMatcher SPLIT_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the same characters as StringTokenizer, namely space, tab, newline, form feed.

TAB_MATCHER	back to summary
private static final StrMatcher TAB_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the tab character.

TRIM_MATCHER	back to summary
private static final StrMatcher TRIM_MATCHER References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the String trim() whitespace characters.

Constructor Detail

StrMatcher	back to summary
protected StrMatcher() Constructs a new instance.

Method Detail

charMatcher back to summary

charMatcher	back to summary
public static StrMatcher charMatcher(final char ch) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Creates a matcher from a character. Parameters ch:char the character to match, must not be null. Returns:StrMatcher a new Matcher for the given char.

public static StrMatcher charMatcher(final char ch)

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Creates a matcher from a character.

Parameters

ch:char: the character to match, must not be null.

Returns:StrMatcher

a new Matcher for the given char.

charSetMatcher back to summary

charSetMatcher	back to summary
public static StrMatcher charSetMatcher(final char... chars) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Creates a matcher from a set of characters. Parameters chars:char[] the characters to match, null or empty matches nothing. Returns:StrMatcher a new matcher for the given char[].

public static StrMatcher charSetMatcher(final char... chars)

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Creates a matcher from a set of characters.

Parameters

chars:char[]: the characters to match, null or empty matches nothing.

Returns:StrMatcher

a new matcher for the given char[].

charSetMatcher back to summary

charSetMatcher	back to summary
public static StrMatcher charSetMatcher(final String chars) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Creates a matcher from a string representing a set of characters. Parameters chars:String the characters to match, null or empty matches nothing. Returns:StrMatcher a new Matcher for the given characters.

public static StrMatcher charSetMatcher(final String chars)

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Creates a matcher from a string representing a set of characters.

Parameters

chars:String: the characters to match, null or empty matches nothing.

Returns:StrMatcher

a new Matcher for the given characters.

commaMatcher back to summary

commaMatcher	back to summary
public static StrMatcher commaMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns a matcher which matches the comma character. Returns:StrMatcher a matcher for a comma.

public static StrMatcher commaMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns a matcher which matches the comma character.

Returns:StrMatcher: a matcher for a comma.

doubleQuoteMatcher back to summary

doubleQuoteMatcher	back to summary
public static StrMatcher doubleQuoteMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns a matcher which matches the double quote character. Returns:StrMatcher a matcher for a double quote.

public static StrMatcher doubleQuoteMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns a matcher which matches the double quote character.

Returns:StrMatcher: a matcher for a double quote.

isMatch back to summary

isMatch	back to summary
public int isMatch(final char[] buffer, final int pos) Returns the number of matching characters, or zero if there is no match. This method is called to check for a match. The parameter `pos` represents the current position to be checked in the string `buffer` (a character array which must not be changed). The API guarantees that `pos` is a valid index for `buffer`. The matching code may check one character or many. It may check characters preceding `pos` as well as those after. It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched. Parameters buffer:char[] the text content to match against, do not change. pos:int the starting position for the match, valid for buffer. Returns:int The number of matching characters, or zero if there is no match.

public int isMatch(final char[] buffer, final int pos)

Returns the number of matching characters, or zero if there is no match.

This method is called to check for a match. The parameter pos represents the current position to be checked in the string buffer (a character array which must not be changed). The API guarantees that pos is a valid index for buffer.

The matching code may check one character or many. It may check characters preceding pos as well as those after.

It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

isMatch back to summary

isMatch	back to summary
public abstract int isMatch(char[] buffer, int pos, int bufferStart, int bufferEnd) Returns the number of matching characters, or zero if there is no match. This method is called to check for a match. The parameter `pos` represents the current position to be checked in the string `buffer` (a character array which must not be changed). The API guarantees that `pos` is a valid index for `buffer`. The character array may be larger than the active area to be matched. Only values in the buffer between the specified indices may be accessed. The matching code may check one character or many. It may check characters preceding `pos` as well as those after, so long as no checks exceed the bounds specified. It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched. Parameters buffer:char[] the text content to match against, do not change. pos:int the starting position for the match, valid for buffer. bufferStart:int the first active index in the buffer, valid for buffer. bufferEnd:int the end index (exclusive) of the active buffer, valid for buffer. Returns:int The number of matching characters, or zero if there is no match.

public abstract int isMatch(char[] buffer, int pos, int bufferStart, int bufferEnd)

Returns the number of matching characters, or zero if there is no match.

The character array may be larger than the active area to be matched. Only values in the buffer between the specified indices may be accessed.

The matching code may check one character or many. It may check characters preceding pos as well as those after, so long as no checks exceed the bounds specified.

It must return zero for no match, or a positive number if a match was found. The number indicates the number of characters that matched.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.
bufferStart:int: the first active index in the buffer, valid for buffer.
bufferEnd:int: the end index (exclusive) of the active buffer, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

noneMatcher back to summary

noneMatcher	back to summary
public static StrMatcher noneMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches no characters. Returns:StrMatcher a matcher that matches nothing.

public static StrMatcher noneMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Matches no characters.

Returns:StrMatcher: a matcher that matches nothing.

quoteMatcher back to summary

quoteMatcher	back to summary
public static StrMatcher quoteMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns a matcher which matches the single or double quote character. Returns:StrMatcher a matcher for a single or double quote.

public static StrMatcher quoteMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns a matcher which matches the single or double quote character.

Returns:StrMatcher: a matcher for a single or double quote.

singleQuoteMatcher back to summary

singleQuoteMatcher	back to summary
public static StrMatcher singleQuoteMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns a matcher which matches the single quote character. Returns:StrMatcher a matcher for a single quote.

public static StrMatcher singleQuoteMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns a matcher which matches the single quote character.

Returns:StrMatcher: a matcher for a single quote.

spaceMatcher back to summary

spaceMatcher	back to summary
public static StrMatcher spaceMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns a matcher which matches the space character. Returns:StrMatcher a matcher for a space.

public static StrMatcher spaceMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns a matcher which matches the space character.

Returns:StrMatcher: a matcher for a space.

splitMatcher back to summary

splitMatcher	back to summary
public static StrMatcher splitMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the same characters as StringTokenizer, namely space, tab, newline and form feed. Returns:StrMatcher The split matcher.

public static StrMatcher splitMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Matches the same characters as StringTokenizer, namely space, tab, newline and form feed.

Returns:StrMatcher: The split matcher.

stringMatcher back to summary

stringMatcher	back to summary
public static StrMatcher stringMatcher(final String str) References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Creates a matcher from a string. Parameters str:String the string to match, null or empty matches nothing Returns:StrMatcher a new Matcher for the given String

public static StrMatcher stringMatcher(final String str)

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Creates a matcher from a string.

Parameters

str:String: the string to match, null or empty matches nothing

Returns:StrMatcher

a new Matcher for the given String

tabMatcher back to summary

tabMatcher	back to summary
public static StrMatcher tabMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns a matcher which matches the tab character. Returns:StrMatcher a matcher for a tab.

public static StrMatcher tabMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns a matcher which matches the tab character.

Returns:StrMatcher: a matcher for a tab.

trimMatcher back to summary

trimMatcher	back to summary
public static StrMatcher trimMatcher() References Deprecated `StrMatcher` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Matches the String trim() whitespace characters. Returns:StrMatcher The trim matcher.

public static StrMatcher trimMatcher()

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Matches the String trim() whitespace characters.

Returns:StrMatcher: The trim matcher.

org.apache.commons.text back to summary

private final Class StrMatcher.CharMatcher

Class Inheritance

extends StrMatcher

java.lang.Object
org.apache.commons.text.StrMatcher
org.apache.commons.text.StrMatcher.CharMatcher

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Class used to define a character for matching purposes.

Field Summary

Modifier and Type	Field and Description
private final char	ch The character to match.

Constructor Summary

Access	Constructor and Description
private	CharMatcher(final char the character to match. ch) Constructor that creates a matcher that matches a single character.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public int	Returns: The number of matching characters, or zero if there is no match. isMatch(final char[] the text content to match against, do not change. buffer, final int the starting position for the match, valid for buffer. pos, final int the first active index in the buffer, valid for buffer. bufferStart, final int the end index of the active buffer, valid for buffer. bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Returns `1` if there is a match, or `0` if there is no match.

public int

Returns:

The number of matching characters, or zero if there is no match.

isMatch(final char[]

the text content to match against, do not change.

buffer, final int

the starting position for the match, valid for buffer.

pos, final int

the first active index in the buffer, valid for buffer.

bufferStart, final int

the end index of the active buffer, valid for buffer.

bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns 1 if there is a match, or 0 if there is no match.

Inherited from org.apache.commons.text.StrMatcher:: charMatcher charSetMatcher charSetMatcher commaMatcher doubleQuoteMatcher isMatch noneMatcher quoteMatcher singleQuoteMatcher spaceMatcher splitMatcher stringMatcher tabMatcher trimMatcher

Field Detail

ch	back to summary
private final char ch The character to match.

Constructor Detail

CharMatcher	back to summary
private CharMatcher(final char ch) Constructor that creates a matcher that matches a single character. Parameters ch:char the character to match.

CharMatcher

back to summary

private CharMatcher(final char ch)

Constructor that creates a matcher that matches a single character.

Parameters

ch:char: the character to match.

Method Detail

isMatch back to summary

isMatch	back to summary
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Returns `1` if there is a match, or `0` if there is no match. Parameters buffer:char[] the text content to match against, do not change. pos:int the starting position for the match, valid for buffer. bufferStart:int the first active index in the buffer, valid for buffer. bufferEnd:int the end index of the active buffer, valid for buffer. Returns:int The number of matching characters, or zero if there is no match. Annotations @Override

public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns 1 if there is a match, or 0 if there is no match.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.
bufferStart:int: the first active index in the buffer, valid for buffer.
bufferEnd:int: the end index of the active buffer, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

Annotations

@Override

org.apache.commons.text back to summary

private final Class StrMatcher.CharSetMatcher

Class Inheritance

extends StrMatcher

java.lang.Object
org.apache.commons.text.StrMatcher
org.apache.commons.text.StrMatcher.CharSetMatcher

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Class used to define a set of characters for matching purposes.

Field Summary

Modifier and Type	Field and Description
private final char[]	chars The set of characters to match.

Constructor Summary

Access	Constructor and Description
private	CharSetMatcher(final char[] the characters to match, must not be null chars) Constructor that creates a matcher from a character array.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public int	Returns: The number of matching characters, or zero if there is no match. isMatch(final char[] the text content to match against, do not change. buffer, final int the starting position for the match, valid for buffer. pos, final int the first active index in the buffer, valid for buffer. bufferStart, final int the end index of the active buffer, valid for buffer. bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Returns `1` if there is a match, or `0` if there is no match.

public int

Returns:

The number of matching characters, or zero if there is no match.

isMatch(final char[]

the text content to match against, do not change.

buffer, final int

the starting position for the match, valid for buffer.

pos, final int

the first active index in the buffer, valid for buffer.

bufferStart, final int

the end index of the active buffer, valid for buffer.

bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns 1 if there is a match, or 0 if there is no match.

Inherited from org.apache.commons.text.StrMatcher:: charMatcher charSetMatcher charSetMatcher commaMatcher doubleQuoteMatcher isMatch noneMatcher quoteMatcher singleQuoteMatcher spaceMatcher splitMatcher stringMatcher tabMatcher trimMatcher

Field Detail

chars	back to summary
private final char[] chars The set of characters to match.

Constructor Detail

CharSetMatcher	back to summary
private CharSetMatcher(final char[] chars) Constructor that creates a matcher from a character array. Parameters chars:char[] the characters to match, must not be null

CharSetMatcher

back to summary

private CharSetMatcher(final char[] chars)

Constructor that creates a matcher from a character array.

Parameters

chars:char[]: the characters to match, must not be null

Method Detail

isMatch back to summary

isMatch	back to summary
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Returns `1` if there is a match, or `0` if there is no match. Parameters buffer:char[] the text content to match against, do not change. pos:int the starting position for the match, valid for buffer. bufferStart:int the first active index in the buffer, valid for buffer. bufferEnd:int the end index of the active buffer, valid for buffer. Returns:int The number of matching characters, or zero if there is no match. Annotations @Override

public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns 1 if there is a match, or 0 if there is no match.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.
bufferStart:int: the first active index in the buffer, valid for buffer.
bufferEnd:int: the end index of the active buffer, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

Annotations

@Override

org.apache.commons.text back to summary

private final Class StrMatcher.NoMatcher

Class Inheritance

extends StrMatcher

java.lang.Object
org.apache.commons.text.StrMatcher
org.apache.commons.text.StrMatcher.NoMatcher

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Class used to match no characters.

Constructor Summary

Access	Constructor and Description
private	NoMatcher() Constructs a new instance of `NoMatcher`.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public int	Returns: The number of matching characters, or zero if there is no match. isMatch(final char[] the text content to match against, do not change. buffer, final int the starting position for the match, valid for buffer. pos, final int the first active index in the buffer, valid for buffer. bufferStart, final int the end index of the active buffer, valid for buffer. bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Always returns `0`.

public int

Returns:

The number of matching characters, or zero if there is no match.

isMatch(final char[]

the text content to match against, do not change.

buffer, final int

the starting position for the match, valid for buffer.

pos, final int

the first active index in the buffer, valid for buffer.

bufferStart, final int

the end index of the active buffer, valid for buffer.

bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Always returns 0.

Inherited from org.apache.commons.text.StrMatcher:: charMatcher charSetMatcher charSetMatcher commaMatcher doubleQuoteMatcher isMatch noneMatcher quoteMatcher singleQuoteMatcher spaceMatcher splitMatcher stringMatcher tabMatcher trimMatcher

Constructor Detail

NoMatcher	back to summary
private NoMatcher() Constructs a new instance of `NoMatcher`.

Method Detail

isMatch back to summary

isMatch	back to summary
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Always returns `0`. Parameters buffer:char[] the text content to match against, do not change. pos:int the starting position for the match, valid for buffer. bufferStart:int the first active index in the buffer, valid for buffer. bufferEnd:int the end index of the active buffer, valid for buffer. Returns:int The number of matching characters, or zero if there is no match. Annotations @Override

public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Always returns 0.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.
bufferStart:int: the first active index in the buffer, valid for buffer.
bufferEnd:int: the end index of the active buffer, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

Annotations

@Override

org.apache.commons.text back to summary

private final Class StrMatcher.StringMatcher

Class Inheritance

extends StrMatcher

java.lang.Object
org.apache.commons.text.StrMatcher
org.apache.commons.text.StrMatcher.StringMatcher

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Class used to define a set of characters for matching purposes.

Field Summary

Modifier and Type	Field and Description
private final char[]	chars The string to match, as a character array.

Constructor Summary

Access	Constructor and Description
private	StringMatcher(final String the string to match, must not be null str) Constructor that creates a matcher from a String.

Method Summary

Modifier and Type	Method and Description
public int	Returns: The number of matching characters, or zero if there is no match. isMatch(final char[] the text content to match against, do not change. buffer, int the starting position for the match, valid for buffer. pos, final int the first active index in the buffer, valid for buffer. bufferStart, final int the end index of the active buffer, valid for buffer. bufferEnd) Implements abstract org.apache.commons.text.StrMatcher.isMatch. Returns the number of matching characters, or zero if there is no match.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Modifier and Type

Method and Description

public int

Returns:

The number of matching characters, or zero if there is no match.

isMatch(final char[]

the text content to match against, do not change.

buffer, int

the starting position for the match, valid for buffer.

pos, final int

the first active index in the buffer, valid for buffer.

bufferStart, final int

the end index of the active buffer, valid for buffer.

bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns the number of matching characters, or zero if there is no match.

public String

toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.apache.commons.text.StrMatcher:: charMatcher charSetMatcher charSetMatcher commaMatcher doubleQuoteMatcher isMatch noneMatcher quoteMatcher singleQuoteMatcher spaceMatcher splitMatcher stringMatcher tabMatcher trimMatcher

Field Detail

chars	back to summary
private final char[] chars The string to match, as a character array.

Constructor Detail

StringMatcher	back to summary
private StringMatcher(final String str) Constructor that creates a matcher from a String. Parameters str:String the string to match, must not be null

StringMatcher

back to summary

private StringMatcher(final String str)

Constructor that creates a matcher from a String.

Parameters

str:String: the string to match, must not be null

Method Detail

isMatch

back to summary

public int isMatch(final char[] buffer, int pos, final int bufferStart, final int bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns the number of matching characters, or zero if there is no match.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.
bufferStart:int: the first active index in the buffer, valid for buffer.
bufferEnd:int: the end index of the active buffer, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

org.apache.commons.text back to summary

private final Class StrMatcher.TrimMatcher

Class Inheritance

extends StrMatcher

java.lang.Object
org.apache.commons.text.StrMatcher
org.apache.commons.text.StrMatcher.TrimMatcher

References Deprecated

StrMatcher is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Class used to match whitespace as per trim().

Constructor Summary

Access	Constructor and Description
private	TrimMatcher() Constructs a new instance of `TrimMatcher`.

Method Summary

Modifier and Type

Method and Description

public int

Returns:

The number of matching characters, or zero if there is no match.

isMatch(final char[]

the text content to match against, do not change.

buffer, final int

the starting position for the match, valid for buffer.

pos, final int

the first active index in the buffer, valid for buffer.

bufferStart, final int

the end index of the active buffer, valid for buffer.

bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns whether or not the given character matches.

Inherited from org.apache.commons.text.StrMatcher:: charMatcher charSetMatcher charSetMatcher commaMatcher doubleQuoteMatcher isMatch noneMatcher quoteMatcher singleQuoteMatcher spaceMatcher splitMatcher stringMatcher tabMatcher trimMatcher

Constructor Detail

TrimMatcher	back to summary
private TrimMatcher() Constructs a new instance of `TrimMatcher`.

Method Detail

isMatch

back to summary

public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd)

Implements abstract org.apache.commons.text.StrMatcher.isMatch.

Returns whether or not the given character matches.

Parameters

buffer:char[]: the text content to match against, do not change.
pos:int: the starting position for the match, valid for buffer.
bufferStart:int: the first active index in the buffer, valid for buffer.
bufferEnd:int: the end index of the active buffer, valid for buffer.

Returns:int

The number of matching characters, or zero if there is no match.

Annotations

@Override

public abstract Class StrMatcher

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StrMatcher.CharMatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StrMatcher.CharSetMatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StrMatcher.NoMatcher

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class StrMatcher.StringMatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StrMatcher.TrimMatcher

Constructor Summary

Method Summary

Constructor Detail

Method Detail