jsimple.io

Class StringReader

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.Reader

jsimple.io.StringReader

All Implemented Interfaces:

java.lang.AutoCloseable

public class StringReader
extends Reader

This class was based on, and modified from, the Apache Harmony java.io.StringReader class. Unlike the standard Java StringReader class, this doesn't do locking, doesn't throw any checked exceptions, and doesn't support mark/reset/skip.

A specialized Reader that reads characters from a String in a sequential manner.

See Also:

StringWriter

Constructor Summary

Constructors

Constructor and Description
StringReader(java.lang.String str) Construct a new StringReader with str as source.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this reader.
int	read() Reads a single character from the source string and returns it as an integer with the two higher-order bytes set to 0.
int	read(char[] buf, int offset, int length) Reads at most len characters from the source string and stores them at offset in the character array buf.

Methods inherited from class jsimple.io.Reader

read

Methods inherited from class java.lang.Object

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

Constructor Detail

StringReader

public StringReader(java.lang.String str)

Construct a new StringReader with str as source. The size of the reader is set to the length() of the string.

Parameters:

str - the source string for this reader.

Method Detail

close

public void close()

Closes this reader. Once it is closed, read operations on this reader will throw an IOException. Only the first invocation of this method has any effect.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class AutoCloseable

read

public int read()

Reads a single character from the source string and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if the end of the source string has been reached.

Overrides:

read in class Reader

Returns:

the character read or -1 if the end of the source string has been reached

Throws:

IOException - if this reader is closed

read

public int read(char[] buf,
                int offset,
                int length)

Reads at most len characters from the source string and stores them at offset in the character array buf. Returns the number of characters actually read or -1 if the end of the source string has been reached.

Specified by:

read in class Reader

Parameters:

buf - the character array to store the characters read

offset - the initial position in buffer to store the characters read from this reader

length - the maximum number of characters to read

Returns:

the number of characters read or -1 if the end of the reader has been reached

Throws:

java.lang.IndexOutOfBoundsException - if offset < 0 or len < 0, or if offset + len is greater than the size of buf.

IOException - if this reader is closed