java.util.regex
Interface MatchResult

All Known Implementing Classes:

Matcher, MatchResultImpl

public interface MatchResult

Holds the results of a successful match of a Pattern against a given string. The result is divided into groups, with one group for each pair of parentheses in the regular expression and an additional group for the whole regular expression. The start, end, and contents of each group can be queried.

Since:

Android 1.0

See Also:

Matcher, Matcher.toMatchResult()

Method Summary

int	end() Returns the index of the first character following the text that matched the whole regular expression.
int	end(int group) Returns the index of the first character following the text that matched a given group.
String	group() Returns the text that matched the whole regular expression.
String	group(int group) Returns the text that matched a given group of the regular expression.
int	groupCount() Returns the number of groups in the result, which is always equal to the number of groups in the original regular expression.
int	start() Returns the index of the first character of the text that matched the whole regular expression.
int	start(int group) Returns the index of the first character of the text that matched a given group.

Method Detail

end

int end()

Returns the index of the first character following the text that matched the whole regular expression.

Returns:

the character index.

Since:

Android 1.0

end

int end(int group)

Returns the index of the first character following the text that matched a given group.

Parameters:

group - the group, ranging from 0 to groupCount() - 1, with 0 representing the whole pattern.

Returns:

the character index.

Since:

Android 1.0

group

String group()

Returns the text that matched the whole regular expression.

Returns:

the text.

Since:

Android 1.0

group

String group(int group)

Returns the text that matched a given group of the regular expression.

Parameters:

group - the group, ranging from 0 to groupCount() - 1, with 0 representing the whole pattern.

Returns:

the text that matched the group.

Since:

Android 1.0

groupCount

int groupCount()

Returns the number of groups in the result, which is always equal to the number of groups in the original regular expression.

Returns:

the number of groups.

Since:

Android 1.0

start

int start()

Returns the index of the first character of the text that matched the whole regular expression.

Returns:

the character index.

Since:

Android 1.0

start

int start(int group)

Returns the index of the first character of the text that matched a given group.

Parameters:

group - the group, ranging from 0 to groupCount() - 1, with 0 representing the whole pattern.

Returns:

the character index.

Since:

Android 1.0