public class PatternWithGroups extends Object
Modifier and Type | Field and Description |
---|---|
static PatternWithGroups |
EMPTY
The empty pattern that matches the null or empty string.
|
Modifier | Constructor and Description |
---|---|
protected |
PatternWithGroups()
Construct an empty pattern.
|
|
PatternWithGroups(Pattern regexPattern)
Construct a new pattern.
|
|
PatternWithGroups(Pattern regexPattern,
int[] groupIndexes)
Construct a new pattern.
|
|
PatternWithGroups(String regex)
Construct a new pattern.
|
|
PatternWithGroups(String regex,
int[] groupIndexes)
Construct a new pattern.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
int[] |
getGroupIndexes()
Get the group indexes.
|
String |
getRegex()
Get the regular expression.
|
int |
hashCode() |
MatchResult |
match(CharSequence cs)
Match against the pattern.
|
boolean |
match(CharSequence cs,
List<String> groupValues)
Match against the pattern.
|
boolean |
match(CharSequence cs,
List<String> groupNames,
Map<String,String> groupValues)
Match against the pattern.
|
String |
toString() |
public static final PatternWithGroups EMPTY
protected PatternWithGroups()
public PatternWithGroups(String regex) throws PatternSyntaxException
regex
- the regular expression. If the expression is null or an
empty string then the pattern will only match a null or empty
string.PatternSyntaxException
- if the
regular expression could not be compiledpublic PatternWithGroups(String regex, int[] groupIndexes) throws PatternSyntaxException
regex
- the regular expression. If the expression is null or an
empty string then the pattern will only match a null or empty
string.groupIndexes
- the array of group indexes to capturing groups.PatternSyntaxException
- if the
regular expression could not be compiledpublic PatternWithGroups(Pattern regexPattern) throws IllegalArgumentException
regexPattern
- the regular expression patternIllegalArgumentException
- if the regexPattern is null.public PatternWithGroups(Pattern regexPattern, int[] groupIndexes) throws IllegalArgumentException
regexPattern
- the regular expression patterngroupIndexes
- the array of group indexes to capturing groups.IllegalArgumentException
- if the regexPattern is null.public final String getRegex()
public final int[] getGroupIndexes()
public final MatchResult match(CharSequence cs)
cs
- the char sequence to match against the template.public final boolean match(CharSequence cs, List<String> groupValues) throws IllegalArgumentException
cs
- the char sequence to match against the template.groupValues
- the list to add the values of a pattern's
capturing groups if matching is successful. The values are added
in the same order as the pattern's capturing groups. The list
is cleared before values are added.IllegalArgumentException
- if the group values is null.public final boolean match(CharSequence cs, List<String> groupNames, Map<String,String> groupValues) throws IllegalArgumentException
cs
- the char sequence to match against the template.groupNames
- the list names associated with a pattern's
capturing groups. The names MUST be in the same order as the
pattern's capturing groups and the size MUST be equal to or
less than the number of capturing groups.groupValues
- the map to add the values of a pattern's
capturing groups if matching is successful. A values is put
into the map using the group name associated with the
capturing group. The map is cleared before values are added.IllegalArgumentException
- if group values is null.Copyright © 2012-2014, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.