Class: java.io.StringReader

  • public class StringReader
  • extends Reader
A character stream whose source is a string.
Authors:
@author Mark Reinhold
Since:
@since JDK1.1

Inheritance

Superclass tree: Implements:

Methods

  • StringReadertop

    public StringReader(String s)
    Creates a new string reader.
    Parameters:
    @param s String providing the character stream.
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close()
    Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), or reset() invocations will throw an IOException. Closing a previously closed stream has no effect.
    Specified by:
    close from Closeable
    Override hierarchy:
    close from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • marktop

    public void mark(int readAheadLimit) throws IOException
    Marks the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.
    Parameters:
    @param 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.
    Exceptions:
    @exception IllegalArgumentException If readAheadLimit is < 0
    @exception IOException If an I/O error occurs
    Override hierarchy:
    mark from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • markSupportedtop

    public boolean markSupported()
    Tells whether this stream supports the mark() operation, which it does.
    Return:
    @return true if and only if this stream supports the mark operation.
    Override hierarchy:
    markSupported from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public int read() throws IOException
    Reads a single character.
    Return:
    @return The character read, or -1 if the end of the stream has been reached
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    read from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public int read(char[] cbuf, int off, int len) throws IOException
    Reads characters into a portion of an array.
    Parameters:
    @param cbuf Destination buffer
    @param off Offset at which to start writing characters
    @param len Maximum number of characters to read
    Return:
    @return The number of characters read, or -1 if the end of the stream has been reached
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    read from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readytop

    public boolean ready() throws IOException
    Tells whether this stream is ready to be read.
    Return:
    @return True if the next read() is guaranteed not to block for input
    Exceptions:
    @exception IOException If the stream is closed
    Override hierarchy:
    ready from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • resettop

    public void reset() throws IOException
    Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked.
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    reset from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • skiptop

    public long skip(long ns) throws IOException
    Skips the specified number of characters in the stream. Returns the number of characters that were skipped.

    The ns parameter may be negative, even though the skip method of the java.io.Reader superclass throws an exception in this case. Negative values of ns cause the stream to skip backwards. Negative return values indicate a skip backwards. It is not possible to skip backwards past the beginning of the string.

    If the entire string has been read or skipped, then this method has no effect and always returns 0.

    Return:
    @return The number of characters actually skipped
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    skip from Reader
    Related Links:
    Google Code Search
    Stack Overflow