Class StringReader

public StringReader(String buffer)

Create a new StringReader that will read chars from the passed in String. This stream will read from the beginning to the end of the String.

Parameters:

buffer - The String this stream will read from.

public void close()

Closes the stream. Any futher attempts to read from the stream may generate an IOException.

Specified by:

close in interface Closeable

close in interface AutoCloseable

Overrides:

close in interface Reader

public void mark(int readAheadLimit)
            throws IOException

Marks a position in the input to which the stream can be "reset" by calling the reset() method. The parameter readlimit is the number of chars that can be read from the stream after setting the mark before the mark becomes invalid. For example, if mark() is called with a read limit of 10, then when 11 chars of data are read from the stream before the reset() method is called, then the mark is invalid and the stream object instance is not required to remember the mark.

Overrides:

mark in interface Reader

Parameters:

Throws:

IOException - If an error occurs such as mark not being supported for this class

public boolean markSupported()

Returns a boolean that indicates whether the mark/reset methods are supported in this class. Those methods can be used to remember a specific point in the stream and reset the stream to that point.

This method always returns false in this class, but subclasses can override this method to return true if they support mark/reset functionality.

Overrides:

markSupported in interface Reader

Returns:

true if mark/reset functionality is supported, false otherwise

public int read()
            throws IOException

Reads an char from the input stream and returns it as an int in the range of 0-65535. This method also will return -1 if the end of the stream has been reached.

This method will block until the char can be read.

Overrides:

read in interface Reader

Returns:

The char read or -1 if end of stream

Throws:

IOException - If an error occurs

public int read(char[] b,
                int off,
                int len)
            throws IOException

public boolean ready()
            throws IOException

This method determines if the stream is ready to be read. This class is always ready to read and so always returns true, unless close() has previously been called in which case an IOException is thrown.

Overrides:

ready in interface Reader

Returns:

true to indicate that this object is ready to be read.

Throws:

IOException - If the stream is closed.

public void reset()
            throws IOException

Sets the read position in the stream to the previously marked position or to 0 (i.e., the beginning of the stream) if the mark has not already been set.

Overrides:

reset in interface Reader

public long skip(long n)
            throws IOException

This method attempts to skip the requested number of chars in the input stream. It does this by advancing the pos value by the specified number of chars. It this would exceed the length of the buffer, then only enough chars are skipped to position the stream at the end of the buffer. The actual number of chars skipped is returned.

Overrides:

skip in interface Reader

Parameters:

n - The requested number of chars to skip

Returns:

The actual number of chars skipped.