java.util.regex

Class Matcher

java.lang.Object

java.util.regex.Matcher

All Implemented Interfaces:

MatchResult

public final class Matcher
extends Object
implements MatchResult

Method Summary

Modifier and Type	Method and Description
int	end() Returns the offset after the last match.
int	end(int group) Returns the index after the subsequence captured by the given group.
boolean	find() Find next match (if any) in the string.
boolean	find(int ofs) Find next match (if any) in the string.
String	group() Returns the input subsequence captured by the previous match.
String	group(int group) Returns the input sequence captured by the given group.
String	group(String name) Returns the input sequence captured by the named capturing group.
int	groupCount() Returns the number of capture groups.
boolean	lookingAt() Returns true if the string has at least one match by the pattern.
boolean	matches() Returns true if and only if the string is matched by the pattern.
Pattern	pattern() Returns the regex machine used by this matcher.
String	replaceAll(String replacement) Replaces every matched subsequence.
String	replaceFirst(String replacement) Replaces the first matched subsequence.
Matcher	reset() Reset this matcher.
Matcher	reset(String str) Reset this matcher with a new input string.
int	start() Returns the offset of the last match.
int	start(int group) Returns the start index of the subsequence captured by the given group.
MatchResult	toMatchResult() Returns the match state of this matcher.
Matcher	usePattern(Pattern p) Changes the pattern used by this matcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

pattern

public Pattern pattern()

Returns the regex machine used by this matcher.

Returns:

instance of this machine

usePattern

public Matcher usePattern(Pattern p)

Changes the pattern used by this matcher.

Parameters:

p - new pattern

Returns:

instance of this machine using the new pattern

matches

public boolean matches()

Returns true if and only if the string is matched by the pattern.

Returns:

true on match

lookingAt

public boolean lookingAt()

Returns true if the string has at least one match by the pattern.

Returns:

true if there is a match

find

public boolean find()

Find next match (if any) in the string. This starts at the beginning or immediately after that last match. The method returns true if a match is found.

Returns:

true if, and only if, a subsequence of the input sequence matches this matcher's pattern

find

public boolean find(int ofs)

Find next match (if any) in the string. This starts at the defined offset. The method returns true if a match is found.

Parameters:

ofs - offset indicating where to start the search

Returns:

true if a match was found

reset

public Matcher reset()

Reset this matcher.

Returns:

this instance of the matcher

reset

public Matcher reset(String str)

Reset this matcher with a new input string.

Parameters:

str - new pattern

Returns:

instance of this machine now ready to use the new pattern

groupCount

public int groupCount()

Returns the number of capture groups.

Specified by:

groupCount in interface MatchResult

Returns:

count of capture groups

group

public String group()

Returns the input subsequence captured by the previous match.

Specified by:

group in interface MatchResult

Returns:

String containing the matched input data

group

public String group(int group)
             throws IndexOutOfBoundsException,
                    IllegalStateException

Returns the input sequence captured by the given group.

Specified by:

group in interface MatchResult

Parameters:

group - group index

Returns:

string containing the matched input data

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

public String group(String name)

Returns the input sequence captured by the named capturing group.

Parameters:

name - group name

Returns:

null

start

public int start()

Returns the offset of the last match.

Specified by:

start in interface MatchResult

Returns:

offset of the last successful match

start

public int start(int group)
          throws IndexOutOfBoundsException,
                 IllegalStateException

Returns the start index of the subsequence captured by the given group.

Specified by:

start in interface MatchResult

Parameters:

group - group index

Returns:

starting index of match

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

end

public int end()

Returns the offset after the last match.

Specified by:

end in interface MatchResult

Returns:

offset to position following the last match

end

public int end(int group)
        throws IndexOutOfBoundsException,
               IllegalStateException

Returns the index after the subsequence captured by the given group.

Specified by:

end in interface MatchResult

Parameters:

group - group index

Returns:

index of position following the match

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

replaceAll

public String replaceAll(String replacement)

Replaces every matched subsequence.

Parameters:

replacement - used to replace matching data

Returns:

result of the replacement

replaceFirst

public String replaceFirst(String replacement)

Replaces the first matched subsequence.

Parameters:

replacement - used to replace the matching data

Returns:

result of the replacement

toMatchResult

public MatchResult toMatchResult()

Returns the match state of this matcher.

Returns:

state