de.susebox.jtopas.spi

Interface PatternHandler.Result

Enclosing interface:

PatternHandler

public static interface PatternHandler.Result

An inner interface for the pattern match result.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getGroups() Returns the capturing groups of a match.
int	getLengthOfMatch() Returns the number of characters that are part of a match.
TokenizerProperty	getProperty() Returns the TokenizerProperty that describes the pattern that matches data passed to PatternHandler.matches(de.susebox.jtopas.spi.DataProvider).

Method Detail

getProperty

TokenizerProperty getProperty()

Returns the TokenizerProperty that describes the pattern that matches data passed to PatternHandler.matches(de.susebox.jtopas.spi.DataProvider). The returned value is not null.

Returns:

the pattern property of a successful match

getLengthOfMatch

int getLengthOfMatch()

Returns the number of characters that are part of a match.

Returns:

length of match

getGroups

java.lang.String[] getGroups()
                      throws TokenizerException

Returns the capturing groups of a match. It is used if the calling tokenizer needs these groups (e. g. if the flag de.susebox.jtopas.TokenizerProperties#F_RETURN_IMAGE_PARTS is set).
The return value must not be null or empty. The first element (array index 0) must contain the whole pattern match (as described in the Java 1.4 documentation for Matcher or the newer Java 1.5 MatchResult).

Returns:

the capturing groups of the last pattern match in PatternHandler.matches(de.susebox.jtopas.spi.DataProvider).

Throws:

TokenizerException