de.susebox.jtopas

Class StringSource

java.lang.Object

de.susebox.jtopas.StringSource

All Implemented Interfaces:

CharSequenceTokenizerSource, TokenizerSource, java.lang.CharSequence

public class StringSource
extends java.lang.Object
implements CharSequenceTokenizerSource

Implementation of the TokenizerSource and its extension CharSequenceTokenizerSource for strings. It is a shortcut for:

   String           myData = "...";
   TokenizerSource  source = new ReaderSource(new StringReader(myData));

The class also provides a faster access to the data in a string through the methods of the CharSequence interface. Since this interface was only introduced with Java 1.4, this class can only be used with 1.4 or higher Java versions.

Author:

Heiko Blau

See Also:

TokenizerSource, CharSequenceTokenizerSource, CharArraySource

Constructor Summary

Constructors

Constructor and Description
StringSource(java.lang.String data) Constructing a StringSource on the given String.

Method Summary

Modifier and Type	Method and Description
char	charAt(int index) Implements CharSequence.charAt(int) for this class.
int	length() Implements CharSequence.length() for this class.
int	read(char[] cbuf, int offset, int maxChars) This method copies the available data into the given buffer according to the given offset and maximum character count.
java.lang.CharSequence	subSequence(int start, int end) Implements CharSequence.subSequence(int, int) for this class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Constructor Detail

StringSource

public StringSource(java.lang.String data)

Constructing a StringSource on the given String. A null value is handled like an empty string.

Parameters:

data - the string

Method Detail

read

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

This method copies the available data into the given buffer according to the given offset and maximum character count. See TokenizerSource.read(char[], int, int) for details.

Specified by:

read in interface TokenizerSource

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

charAt

public char charAt(int index)

Implements CharSequence.charAt(int) for this class.

Specified by:

charAt in interface java.lang.CharSequence

Parameters:

index - which character to retrieve

Returns:

the character at the given index

length

public int length()

Implements CharSequence.length() for this class.

Specified by:

length in interface java.lang.CharSequence

Returns:

the number of available characters

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Implements CharSequence.subSequence(int, int) for this class.

Specified by:

subSequence in interface java.lang.CharSequence

Parameters:

start - the new CharSequence contains the characters from and including this position

end - the new CharSequence contains the characters up to and excluding this position

Returns:

a part of this CharSequence