Home » openjdk-7 » java » io » [javadoc | source]
public class: StringReader [javadoc | source]

All Implemented Interfaces:
    Closeable, Readable

A character stream whose source is a string.
Fields inherited from java.io.Reader:
 public StringReader(String s) 
    Creates a new string reader.
    s - String providing the character stream.
Method from java.io.StringReader Summary:
close,   mark,   markSupported,   read,   read,   ready,   reset,   skip
Methods from java.io.Reader:
close,   mark,   markSupported,   read,   read,   read,   read,   ready,   reset,   skip
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.StringReader Detail:
 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.
 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.
 public boolean markSupported() 
    Tells whether this stream supports the mark() operation, which it does.
 public int read() throws IOException 
    Reads a single character.
 public int read(char[] cbuf,
    int off,
    int len) throws IOException 
    Reads characters into a portion of an array.
 public boolean ready() throws IOException 
    Tells whether this stream is ready to be read.
 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.
 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 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.