RegexMatcher

java.lang.Object
- org.mdiutil.util.regex.RegexMatcher

```
public class RegexMatcher
extends Object
```
A regex matcher. It encapsulates a java.util.regex.Matcher. The main methods of this class are:
- The getPatternName() method which returns the name of the pattern defined in the RegexCollection which is associated with this pattern
- The getPattern() method which returns the RegexPattern defined in the RegexCollection which is associated with this pattern
- The getMatcher() method which returns the underlying Matcher

Field Summary

Fields
Modifier and Type Field and Description

static RegexMatcher UNMATCHED
The unmatched matcher.

Fields
Modifier and Type	Field and Description
`static RegexMatcher`	`UNMATCHED` The unmatched matcher.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`end()` Returns the offset after the last character matched.
`int`	`end(int group)` Returns the offset after the last character of the subsequence captured by the given group during the previous match operation.
`int`	`end(String name)` Returns the offset after the last character of the subsequence captured by the given named-capturing group during the previous match operation.
`boolean`	`find()` Attempts to find the next subsequence of the input sequence that matches the pattern.
`boolean`	`find(int start)` Resets this matcher and then attempts to find the next subsequence of the input sequence that matches the pattern, starting at the specified index.
`Matcher`	`getMatcher()` The matcher.
`RegexPattern`	`getPattern()` The pattern.
`String`	`getPatternName()` The pattern name.
`String`	`group()` Returns the input subsequence matched by the previous match.
`String`	`group(int group)` Returns the input subsequence captured by the given group during the previous match operation.
`String`	`group(String name)` Returns the input subsequence captured by the given capturing group during the previous match operation.
`int`	`groupCount()` Returns the number of capturing groups in this matcher's pattern.
`boolean`	`isUnmatched()` Return true if the pattern is the UNMATCHED matcher.
`boolean`	`matches()` Attempts to match the underying matcher region against the pattern.
`int`	`start()` Returns the start index of the previous match.
`int`	`start(int group)` Returns the start index of the subsequence captured by the given group during the previous match operation.
`int`	`start(String name)` Returns the start index of the subsequence captured by the given named-capturing group during the previous match operation.

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

- Field Detail
  - UNMATCHED
```
public static final RegexMatcher UNMATCHED
```
    The unmatched matcher. This matcher has no associated matcher:
    - The getMatcher() method will return the RegexPattern.UNMATCHED instance
    - The getMatcher() method will return null
    - All metgods which return a boolean result will return false
    - All metgods which return an int result will return -1
- Method Detail
  - getPattern
```
public RegexPattern getPattern()
```
    The pattern.
    
    Returns:
    
    the pattern
  - isUnmatched
```
public boolean isUnmatched()
```
    Return true if the pattern is the UNMATCHED matcher.
    
    Returns:
    
    true if the pattern is the UNMATCHED matcher
  - getPatternName
```
public String getPatternName()
```
    The pattern name.
    
    Returns:
    
    the name
  - getMatcher
```
public Matcher getMatcher()
```
    The matcher.
    
    Returns:
    
    the matcher
  - matches
```
public boolean matches()
```
    Attempts to match the underying matcher region against the pattern. Defers to the underlying Matcher.
    
    Returns:
    
    true if, and only if, the entire region sequence matches this matcher's pattern
  - group
```
public String group()
```
    Returns the input subsequence matched by the previous match. Defers to the underlying Matcher.
    
    Returns:
    
    The (possibly empty) subsequence matched by the previous match, in string form
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
  - group
```
public String group(int group)
```
    Returns the input subsequence captured by the given group during the previous match operation. Defers to the underlying Matcher.
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    Returns:
    
    The (possibly empty) subsequence captured by the group during the previous match, or null if the group failed to match part of the input
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
    
    IndexOutOfBoundsException - If there is no capturing group in the pattern with the given index
  - group
```
public String group(String name)
```
    Returns the input subsequence captured by the given capturing group during the previous match operation. Defers to the underlying Matcher.
    
    Parameters:
    
    name - The name of a named-capturing group in this matcher's pattern
    
    Returns:
    
    The (possibly empty) subsequence captured by the named group during the previous match, or null if the group failed to match part of the input
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
    
    IllegalArgumentException - If there is no capturing group in the pattern with the given name
  - groupCount
```
public int groupCount()
```
    Returns the number of capturing groups in this matcher's pattern. Defers to the underlying Matcher.
    
    Returns:
    
    The number of capturing groups in this matcher's pattern
  - find
```
public boolean find()
```
    Attempts to find the next subsequence of the input sequence that matches the pattern. Defers to the underlying Matcher.
    
    Returns:
    
    true if, and only if, a subsequence of the input sequence matches this matcher's pattern
  - find
```
public boolean find(int start)
```
    Resets this matcher and then attempts to find the next subsequence of the input sequence that matches the pattern, starting at the specified index. Defers to the underlying Matcher. Defers to the underlying Matcher.
    
    Parameters:
    
    start - the index to start searching for a match
    
    Returns:
    
    true if, and only if, a subsequence of the input sequence starting at the given index matches this matcher's pattern
    
    Throws:
    
    IndexOutOfBoundsException - If start is less than zero or if start is greater than the length of the input sequence.
  - end
```
public int end()
```
    Returns the offset after the last character matched. Defers to the underlying Matcher.
    
    Returns:
    
    The offset after the last character matched
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
  - start
```
public int start()
```
    Returns the start index of the previous match. Defers to the underlying Matcher.
    
    Returns:
    
    The index of the first character matched
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
  - start
```
public int start(int group)
```
    Returns the start index of the subsequence captured by the given group during the previous match operation. Defers to the underlying Matcher.
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    Returns:
    
    The index of the first character captured by the group, or -1 if the match was successful but the group itself did not match anything
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
    
    IndexOutOfBoundsException - If there is no capturing group in the pattern with the given index
  - start
```
public int start(String name)
```
    Returns the start index of the subsequence captured by the given named-capturing group during the previous match operation. Defers to the underlying Matcher.
    
    Parameters:
    
    name - The name of a named-capturing group in this matcher's pattern
    
    Returns:
    
    The index of the first character captured by the group, or -1 if the match was successful but the group itself did not match anything
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
    
    IllegalArgumentException - If there is no capturing group in the pattern with the given name
  - end
```
public int end(int group)
```
    Returns the offset after the last character of the subsequence captured by the given group during the previous match operation. Defers to the underlying Matcher.
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    Returns:
    
    The offset after the last character captured by the group, or -1 if the match was successful but the group itself did not match anything
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
    
    IndexOutOfBoundsException - If there is no capturing group in the pattern with the given index
  - end
```
public int end(String name)
```
    Returns the offset after the last character of the subsequence captured by the given named-capturing group during the previous match operation. Defers to the underlying Matcher.
    
    Parameters:
    
    name - The name of a named-capturing group in this matcher's pattern
    
    Returns:
    
    The offset after the last character captured by the group, or -1 if the match was successful but the group itself did not match anything
    
    Throws:
    
    IllegalStateException - If no match has yet been attempted, or if the previous match operation failed
    
    IllegalArgumentException - If there is no capturing group in the pattern with the given name

Class RegexMatcher

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNMATCHED

Method Detail

getPattern

isUnmatched

getPatternName

getMatcher

matches

group

group

group

groupCount

find

find

end

start

start

start

end

end