PatternWithGroups (Commons URI

java.lang.Object
- de.weltraumschaf.commons.uri.PatternWithGroups

```
class PatternWithGroups
extends Object
```
A pattern for matching a string against a regular expression and returning capturing group values for any capturing groups present in the expression. #renamed com.sun.jersey.api.uri.UriPattern

Author:

Paul Sandoz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class PatternWithGroups.EmptyStringMatchResult

private class PatternWithGroups.GroupIndexMatchResult

Nested Classes
Modifier and Type	Class and Description
`private static class`	`PatternWithGroups.EmptyStringMatchResult`
`private class`	`PatternWithGroups.GroupIndexMatchResult`

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static PatternWithGroups`	`EMPTY` The empty pattern that matches the null or empty string.
`private static int[]`	`EMPTY_INT_ARRAY`
`private static PatternWithGroups.EmptyStringMatchResult`	`EMPTY_STRING_MATCH_RESULT`
`private int[]`	`groupIndexes` The array of group indexes to capturing groups.
`private String`	`regex` The regular expression for matching and obtaining capturing group values.
`private Pattern`	`regexPattern` The compiled regular expression of `#regex`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PatternWithGroups()` Construct an empty pattern.
`(package private)`	`PatternWithGroups(Pattern regexPattern)` Construct a new pattern.
`(package private)`	`PatternWithGroups(Pattern regexPattern, int[] groupIndexes)` Construct a new pattern.
`(package private)`	`PatternWithGroups(String regex)` Construct a new pattern.
`(package private)`	`PatternWithGroups(String regex, int[] groupIndexes)` Construct a new pattern.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static Pattern`	`compile(String regex)`
`boolean`	`equals(Object obj)`
`(package private) int[]`	`getGroupIndexes()` Get the group indexes.
`(package private) String`	`getRegex()` Get the regular expression.
`int`	`hashCode()`
`(package private) MatchResult`	`match(CharSequence cs)` Match against the pattern.
`(package private) boolean`	`match(CharSequence cs, List<String> groupValues)` Match against the pattern.
`(package private) boolean`	`match(CharSequence cs, List<String> groupNames, Map<String,String> groupValues)` Match against the pattern.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_INT_ARRAY
```
private static final int[] EMPTY_INT_ARRAY
```
  - EMPTY
```
static final PatternWithGroups EMPTY
```
    The empty pattern that matches the null or empty string.
  - regex
```
private final String regex
```
    The regular expression for matching and obtaining capturing group values.
  - regexPattern
```
private final Pattern regexPattern
```
    The compiled regular expression of #regex.
  - groupIndexes
```
private final int[] groupIndexes
```
    The array of group indexes to capturing groups.
  - EMPTY_STRING_MATCH_RESULT
```
private static final PatternWithGroups.EmptyStringMatchResult EMPTY_STRING_MATCH_RESULT
```
- Constructor Detail
  - PatternWithGroups
```
protected PatternWithGroups()
```
    Construct an empty pattern.
  - PatternWithGroups
```
PatternWithGroups(String regex)
           throws PatternSyntaxException
```
    Construct a new pattern.
    
    Parameters:
    
    regex - the regular expression. If the expression is null or an empty string then the pattern will only match a null or empty string.
    
    Throws:
    
    PatternSyntaxException - if the regular expression could not be compiled
  - PatternWithGroups
```
PatternWithGroups(String regex,
                  int[] groupIndexes)
           throws PatternSyntaxException
```
    Construct a new pattern.
    
    Parameters:
    
    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.
    
    Throws:
    
    PatternSyntaxException - if the regular expression could not be compiled
  - PatternWithGroups
```
PatternWithGroups(Pattern regexPattern)
           throws IllegalArgumentException
```
    Construct a new pattern.
    
    Parameters:
    
    regexPattern - the regular expression pattern
    
    Throws:
    
    IllegalArgumentException - if the regexPattern is null.
  - PatternWithGroups
```
PatternWithGroups(Pattern regexPattern,
                  int[] groupIndexes)
           throws IllegalArgumentException
```
    Construct a new pattern.
    
    Parameters:
    
    regexPattern - the regular expression pattern
    
    groupIndexes - the array of group indexes to capturing groups.
    
    Throws:
    
    IllegalArgumentException - if the regexPattern is null.
- Method Detail
  - compile
```
private static Pattern compile(String regex)
                        throws PatternSyntaxException
```
    Throws:
    
    PatternSyntaxException
  - getRegex
```
final String getRegex()
```
    Get the regular expression.
    
    Returns:
    
    the regular expression.
  - getGroupIndexes
```
final int[] getGroupIndexes()
```
    Get the group indexes.
    
    Returns:
    
    the group indexes.
  - match
```
final MatchResult match(CharSequence cs)
```
    Match against the pattern.
    
    Parameters:
    
    cs - the char sequence to match against the template.
    
    Returns:
    
    the match result, otherwise null if no match occurs.
  - match
```
final boolean match(CharSequence cs,
                    List<String> groupValues)
             throws IllegalArgumentException
```
    Match against the pattern.
    If a matched then the capturing group values (if any) will be added to a list passed in as parameter.
    
    Parameters:
    
    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.
    
    Returns:
    
    true if the char sequence matches the pattern, otherwise false.
    
    Throws:
    
    IllegalArgumentException - if the group values is null.
  - match
```
final boolean match(CharSequence cs,
                    List<String> groupNames,
                    Map<String,String> groupValues)
             throws IllegalArgumentException
```
    Match against the pattern.
    If a matched then the capturing group values (if any) will be added to a list passed in as parameter.
    
    Parameters:
    
    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.
    
    Returns:
    
    true if the matches the pattern, otherwise false.
    
    Throws:
    
    IllegalArgumentException - if group values is null.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class PatternWithGroups

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_INT_ARRAY

EMPTY

regex

regexPattern

groupIndexes

EMPTY_STRING_MATCH_RESULT

Constructor Detail

PatternWithGroups

PatternWithGroups

PatternWithGroups

PatternWithGroups

PatternWithGroups

Method Detail

compile

getRegex

getGroupIndexes

match

match

match

hashCode

equals

toString