Package ca.gorman.util.scan

Text scanning tools that can do pattern matching and recursive descent parsing in character sequences, character streams, and character buffers.

See:
Description

Interface Summary

AsynchronousScanState	External view of the current state of an asynchronous Scanner.
Expandable	Control interface for increasing the capacity of a buffer or other object.
InputControl	Control interface for a buffer with modifiable content and capacity.
InputScanBuffer	The sequence of characters that are currently available for pattern matching.
MatchedText	A sequence of characters that have been matched in a ScanBuffer.
RuleList	List of rules used by a Scanner to recognize and act on character sequences.
ScanAction	A superclass used to subclass ScanMatch as a ScanRule.
ScanBuffer	A view into the a subsequence of the sequence of characters that are currently available for pattern matching.
ScanMatch	A rule for matching subsequences of characters in a ScanBuffer and returning the subsequences as instances of MatchedText..
Scanner	Control interface for a character scanning, matching, and translation engine.
ScanRule	A rule for recognizing and acting on character sequences in a ScanBuffer.
ScanState	Control interface between an active Scanner and an action invoked by the Scanner.

Class Summary

AbstractRuleList	Abstract realization of RuleList.
AbstractScanRule	Abstract realization of ScanRule that takes no action on a successful match.
InputControl.Default	An implementation of InputControl with methods that do nothing.
Modifier	Modifiers for constructing a new ScanRule instance from other ScanRule instances.
RegexFactory	Produces rules for recognizing regular expressions.
ScannerFactory	Factory for Scanners.
ScanningReader	A Reader with a character scanning and matching preprocessor.
ScanningWriter	A Writer with a character scanning and matching postprocessor.
ScanRuleDelegator	Realization of ScanRule that delegates to a ScanMatch and a scanAction.

Exception Summary

DataChangedException

Unchecked exception thrown when a method is invoked on a CharSequence that has changed since it was created.

Package ca.gorman.util.scan Description

Text scanning tools that can do pattern matching and recursive descent parsing in character sequences, character streams, and character buffers.

A ScanRule is a pattern-action rule similar to those that can be used in awk and perl. Unlike the rules in awk and perl, a ScanRule can suspend itself by invoking another ScanRule on the same ScanBuffer, and either continue scanning the ScanBuffer after the second ScanRule returns with matching text, or reject a match when the second ScanRule returns without a match. This feature supports recursive-descent parsing, like recognition of nested sets of parentheses.

The package is based on interfaces and factory classes so that the implementation can be changed without affecting application code.

Package Specification

Related Documentation