AbstractScanBuffer

Overview

Package

Class

Tree

Deprecated

Index

Help

GXPARSE hosted by

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ca.gorman.util.scan.spi
Class AbstractScanBuffer

java.lang.Object
  ca.gorman.util.scan.spi.AbstractScanBuffer

All Implemented Interfaces:: Expandable, InputScanBuffer, ScanBuffer, CharSequence

public abstract class AbstractScanBuffer
extends Object
implements InputScanBuffer
extends Object
implements InputScanBuffer

A ScanBuffer factory.

AbstractScanBuffer holds only references and indices to the data in the CharSequence. Consequently, a change in the content of a CharSequence can produce a change in the content of any buffer or sub-buffer. If a non-volatile character sequence is required, from a buffer or sub-buffer, the sequence should be obtained by invoking the toString() method on the buffer, sub-buffer, or a subsequence of the buffer or sub-buffer. Sub-sequences and strings are obtained directly from the underlying CharSequence, thereby exploiting all of the efficiencies in the implementation of the CharSequence.

Constructor Summary
`protected`	`AbstractScanBuffer(CharSequence charSequence)` Construct on a `CharSequence that has a fixed length.`
`protected`	`AbstractScanBuffer(CharSequence charSequence, InputControl inputControl)` Construct on a `CharSequence with a length that can be increased by a request from the AbstractScanBuffer.`

Method Summary
`MatchedText`	`accept(int length)` Remove a prefix of the `ScanBuffer` from the `ScanBuffer` and create a `MatchedText` containing the same characters.
`MatchedText`	`act(ScanRule scanRule)` Test a `ScanRule` for a match against a leading prefix of the `ScanBuffer` and invoke the corresponding `action` if the match succeeds.
`char`	`charAt(int index)`
`void`	`discardMatchedText()` Release all previously `accepted input` data.
`boolean`	`expand()` Increase the amount of data in the buffer, if the buffer supports expansion.
`int`	`fill()` Read characters into free space in the buffer.
`Map<String,CharSequence>`	`getMap()` Get the map that supports `saving` and `retrieving` character sequences as temporary values.
`boolean`	`hitLast()` Indicate whether the last character in the buffer has been accessed since the previous invocation of this function.
`int`	`length()`
`static AbstractScanBuffer`	`newInstance(CharSequence charSequence)` Create a `AbstractScanBuffer` for scanning and matching on a `CharSequence that has a fixed length.`
`static AbstractScanBuffer`	`newInstance(CharSequence charSequence, InputControl inputControl)` Create a `AbstractScanBuffer` for scanning and matching on a `CharSequence with a length that can be increased by a request from the AbstractScanBuffer.`
`CharSequence`	`put(String key, CharSequence value)` Save a `CharSequence` for later `retrieval` in an `action`.
`ScanState`	`setScanState(ScanState scanState)` Set a reference to the `scanner state` for use by the `buffer match and act` method.
`ScanBuffer`	`subBuffer(int offset)` Get a new buffer, beginning at the specified offset from the beginning of the buffer, and continuing to the end of the parent buffer.
`CharSequence`	`subSequence(int start, int end)`
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail