de.susebox.jtopas

Interface TokenizerSource

All Known Subinterfaces:

CharSequenceTokenizerSource

All Known Implementing Classes:

CharArraySource, ReaderSource, StringSource

public interface TokenizerSource

This interface describes the data source for a Tokenizer. It is a simplification of the Reader class (java.io.Reader).

Author:

Heiko Blau

See Also:

Tokenizer

Method Summary

Modifier and Type	Method and Description
int	read(char[] cbuf, int offset, int maxChars) A basic method to supply character data for a Tokenizer.

Method Detail

read

int read(char[] cbuf,
         int offset,
         int maxChars)
  throws java.lang.Exception

A basic method to supply character data for a Tokenizer. Note that the more complicated operations of buffering, skipping etc. are done by the Tokenizer implementation using this data source. An implementation of this interface should therefore avoid caching data itself. Otherwise, storing data is done twice wasting memory.
In correspondence to the methods in Reader this method returns -1 on end-of-file (EOF).

Parameters:

cbuf - buffer to receive data

offset - position from where the data should be inserted in cbuf

maxChars - maximum number of characters to be read into cbuf

Returns:

actually read characters or -1 on an end-of-file condition

Throws:

java.lang.Exception - anything that could happen during read, most likely IOException