com.nobigsoftware.dfalex

Interface StringMatchIterator<MATCHRESULT>

All Superinterfaces:

java.util.Iterator<MATCHRESULT>

public interface StringMatchIterator<MATCHRESULT>
extends java.util.Iterator<MATCHRESULT>

An Iterator that provides access to the pattern matches in a string

StringSearcher.searchString(String) produces these.

Method Summary

Modifier and Type	Method and Description
int	matchEndPosition() Get the position of the end of the last match in the string.
MATCHRESULT	matchResult() Get the result of the last match.
int	matchStartPosition() Get the position of the start of the last match in the string.
java.lang.String	matchValue() Get the string value of the last match
boolean	reposition(int pos) rewind (or jump forward) to a given position in the source string

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

matchStartPosition

int matchStartPosition()

Get the position of the start of the last match in the string.

Returns:

the index of the first character in the last match

Throws:

java.lang.IllegalStateException - unless called after a valid call to {Iterator.next()

matchEndPosition

int matchEndPosition()

Get the position of the end of the last match in the string.

Returns:

the index after the last character in the last match

Throws:

java.lang.IllegalStateException - unless called after a valid call to {Iterator.next()

matchValue

java.lang.String matchValue()

Get the string value of the last match

Note that a new string is allocated by the first call to this method for each match.

Returns:

the source portion of the source string corresponding to the last match

Throws:

java.lang.IllegalStateException - unless called after a valid call to {Iterator.next()

matchResult

MATCHRESULT matchResult()

Get the result of the last match.

Returns:

the MATCHRESULT returned by the last call to Iterator.next()

Throws:

java.lang.IllegalStateException - unless called after a valid call to {Iterator.next()

reposition

boolean reposition(int pos)

rewind (or jump forward) to a given position in the source string

The next match returned will be the one (if any) that starts at a position >= pos

IMPORTANT: If this method returns true, you must call Iterator.next() to get the result of the next match. Until then calls to the the match accessor methods will continue to return information from the previous call to Iterator.next().

Parameters:

pos - new position in the source string to search from

Returns:

true if there is a match after the given position. The same value will be returned from {Iterator.hasNext()