java.util.regex

Interface MatchResult

All Known Implementing Classes:

Matcher

public interface MatchResult

Method Summary

Modifier and Type	Method and Description
int	end() Returns the offset of the last character matched.
int	end(int group) Returns the offset after the last character of the subsequence captured by the given group during this match.
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.
int	groupCount() Returns the number of capturing groups in the matched results pattern.
int	start() Returns the start index of the match.
int	start(int group) Returns the start index of the subsequence captured by the given group during this match.

Method Detail

end

int end()
 throws IllegalStateException

Returns the offset of the last character matched.

Returns:

offset The offset after the last character matched

Throws:

IllegalStateException - If no match has yet been attempted, or if the previous match operation failed

end

int end(int group)
 throws IndexOutOfBoundsException,
        IllegalStateException

Returns the offset after the last character of the subsequence captured by the given group during this match.

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:

IndexOutOfBoundsException - If there is no capturing group in the pattern with the given index

IllegalStateException - If no match has yet been attempted, or if the previous match operation failed

group

String group()

Returns the input subsequence matched by the previous match.

Returns:

The (possibly empty) subsequence matched by the previous match, in string form

group

String group(int group)

Returns the input subsequence captured by the given group during the previous match operation.

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

groupCount

int groupCount()

Returns the number of capturing groups in the matched results pattern.

Returns:

The number of capturing groups in this matcher's pattern

start

int start()
   throws IllegalStateException

Returns the start index of the match.

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

int start(int group)
   throws IndexOutOfBoundsException,
          IllegalStateException

Returns the start index of the subsequence captured by the given group during this match.

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:

IndexOutOfBoundsException - If there is no capturing group in the pattern with the given index

IllegalStateException - If no match has yet been attempted, or if the previous match operation failed