java.io
Class StringReader

java.lang.Object
  |
  +--java.io.Reader
        |
        +--java.io.StringReader

public class StringReader

extends Reader

Safe: A character stream whose source is a string.

Since:

JDK1.1

Version:

1.16, 01/12/03

Author:

Mark Reinhold

Field Summary

private int	length
private int	mark
private int	next
private String	str

Fields inherited from class java.io.Reader

lock

Constructor Summary

StringReader(String s)
Enabled: Create a new string reader.

Method Summary

void	close() Enabled: Close the stream.
private void	ensureOpen() Check to make sure that the stream has not been closed
void	mark(int readAheadLimit) Enabled: Mark the present position in the stream.
boolean	markSupported() Enabled: Tell whether this stream supports the mark() operation, which it does.
int	read() Enabled: Read a single character.
int	read(char[] cbuf, int off, int len) Enabled: Read characters into a portion of an array.
boolean	ready() Enabled: Tell whether this stream is ready to be read.
void	reset() Enabled: Reset the stream to the most recent mark, or to the beginning of the string if it has never been marked.
long	skip(long ns) Enabled: Skip characters.

Methods inherited from class java.io.Reader

getText, getTwine, iterate, iterate, read, readChar, readString

Methods inherited from class java.lang.Object

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

Field Detail

str

private String str

length

private int length

next

private int next

mark

private int mark

Constructor Detail

StringReader

public StringReader(String s)

Enabled: Create a new string reader.

Parameters:

s - String providing the character stream.

Method Detail

ensureOpen

private void ensureOpen()
                 throws IOException

Check to make sure that the stream has not been closed

IOException

read

public int read()
         throws IOException

Enabled: Read a single character.

Overrides:

read in class Reader

Returns:

The character read, or -1 if the end of the stream has been reached

IOException

read

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

Enabled: Read characters into a portion of an array.

Specified by:

read in class Reader

Parameters:

cbuf - Destination buffer

off - Offset at which to start writing characters

len - Maximum number of characters to read

Returns:

The number of characters read, or -1 if the end of the stream has been reached

IOException

skip

public long skip(long ns)
          throws IOException

Enabled: Skip characters.

Overrides:

skip in class Reader

Parameters:

ns - The number of characters to skip

Returns:

The number of characters actually skipped

IOException

ready

public boolean ready()
              throws IOException

Enabled: Tell whether this stream is ready to be read.

Overrides:

ready in class Reader

Returns:

True if the next read() is guaranteed not to block for input

IOException

markSupported

public boolean markSupported()

Enabled: Tell whether this stream supports the mark() operation, which it does.

Overrides:

markSupported in class Reader

Returns:

true if and only if this stream supports the mark operation.

mark

public void mark(int readAheadLimit)
          throws IOException

Enabled: Mark the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.

Overrides:

mark in class Reader

Parameters:

readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a string, there is no actual limit, so this argument must not be negative, but is otherwise ignored.

IOException

reset

public void reset()
           throws IOException

Enabled: Reset the stream to the most recent mark, or to the beginning of the string if it has never been marked.

Overrides:

reset in class Reader

IOException

close

public void close()

Enabled: Close the stream.

Specified by:

close in class Reader