net.sf.expectit

Interface Result

All Superinterfaces:

MatchResult

All Known Subinterfaces:

MultiResult

All Known Implementing Classes:

SimpleResult

public interface Result
extends MatchResult

A representation of the result of a single match operation.

The interface contains methods to query the results of the match against an expression.

Method Summary

Modifier and Type	Method and Description
boolean	canStopMatching() Indicates that the matching operation won't have a different result at any point in the future and there is no need to wait for the successful match.
String	getBefore() Returns a part of the input string from the beginning until the starting position of the match.
String	getInput() Gets latest input string passed to the matcher before it returns.
boolean	isSuccessful() Indicates whether the match was successful or not.

Methods inherited from interface java.util.regex.MatchResult

end, end, group, group, groupCount, start, start

Method Detail

getInput

String getInput()

Gets latest input string passed to the matcher before it returns. The input represents the state of the internal buffer.

Returns:

the input string.

isSuccessful

boolean isSuccessful()

Indicates whether the match was successful or not.

Returns:

true if the match succeeded, or false otherwise.

getBefore

String getBefore()

Returns a part of the input string from the beginning until the starting position of the match. Never returns null.

Returns:

the string before the match

Throws:

IllegalStateException - if the match operation failed

canStopMatching

boolean canStopMatching()

Indicates that the matching operation won't have a different result at any point in the future and there is no need to wait for the successful match. The process can stop matching and return the program control to the user.

Returns:

the flag.