ca.gorman.util.scan
Interface ScanMatch

All Known Subinterfaces:

ScanRule

All Known Implementing Classes:

AbstractScanRule, ScanRuleDelegator

public interface ScanMatch

A rule for matching subsequences of characters in a ScanBuffer and returning the subsequences as instances of MatchedText..

All subclasses of ScanMatch are immutable and have reentrant methods. They are thread-safe, and can be used for recursive matching.

Method Summary

MatchedText

match(ScanBuffer scanBuffer) Test characters at the beginning of a ScanBuffer, removing any matching CharSequence and returning it as MatchedText.

Method Detail

match

MatchedText match(ScanBuffer scanBuffer)
                  throws IOException

Test characters at the beginning of a ScanBuffer, removing any matching CharSequence and returning it as MatchedText.

This method is reentrant and thread-safe.

Returns:

the matched text, or null if there is no match.

Throws:

IOException