Build 1.0_r1(from source)

java.io
Class StringReader

java.lang.Object
  extended by java.io.Reader
      extended by java.io.StringReader
All Implemented Interfaces:
Closeable, Readable

public class StringReader
extends Reader

StringReader is used as a character input stream on a String.

See Also:
StringWriter

Field Summary
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
StringReader(String str)
          Construct a StringReader on the String str.
 
Method Summary
 void close()
          This method closes this StringReader.
 void mark(int readLimit)
          Set a Mark position in this Reader.
 boolean markSupported()
          Returns a boolean indicating whether or not this StringReader supports mark() and reset().
 int read()
          Reads a single character from this StringReader and returns the result as an int.
 int read(char[] buf, int offset, int len)
          Reads at most count characters from this Reader and stores them at offset in the character array buf.
 boolean ready()
          Returns a boolean indicating whether or not this StringReader is ready to be read without blocking.
 void reset()
          Reset this StringReader's position to the last mark() location.
 long skip(long ns)
          Skips count number of characters in this Reader.
 
Methods inherited from class java.io.Reader
read, read
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringReader

public StringReader(String str)
Construct a StringReader on the String str. The size of the reader is set to the length() of the String and the Object to synchronize access through is set to str.

Parameters:
str - the String to filter reads on.
Method Detail

close

public void close()
This method closes this StringReader. Once it is closed, you can no longer read from it. Only the first invocation of this method has any effect.

Specified by:
close in interface Closeable
Specified by:
close in class Reader

mark

public void mark(int readLimit)
          throws IOException
Set a Mark position in this Reader. The parameter readLimit is ignored for StringReaders. Sending reset() will reposition the reader back to the marked position provided the mark has not been invalidated.

Overrides:
mark in class Reader
Parameters:
readLimit - ignored for StringReaders.
Throws:
IOException - If an error occurs attempting mark this StringReader.

markSupported

public boolean markSupported()
Returns a boolean indicating whether or not this StringReader supports mark() and reset(). This method always returns true.

Overrides:
markSupported in class Reader
Returns:
true if mark() and reset() are supported, false otherwise. This implementation always returns true.

read

public int read()
         throws IOException
Reads a single character from this StringReader and returns the result as an int. The 2 higher-order bytes are set to 0. If the end of reader was encountered then return -1.

Overrides:
read in class Reader
Returns:
the character read or -1 if end of reader.
Throws:
IOException - If the StringReader is already closed.

read

public int read(char[] buf,
                int offset,
                int len)
         throws IOException
Description copied from class: Reader
Reads at most count characters from this Reader and stores them at offset in the character array buf. Returns the number of characters actually read or -1 if the end of reader was encountered.

Specified by:
read in class Reader
Parameters:
buf - character array to store the read characters
offset - offset in buf to store the read characters
len - how many characters should be read in
Returns:
how many characters were successfully read in or else -1 if the end of the reader was detected.
Throws:
IOException - If the Reader is already closed or some other IO error occurs.

ready

public boolean ready()
              throws IOException
Returns a boolean indicating whether or not this StringReader is ready to be read without blocking. If the result is true, the next read() will not block. If the result is false this Reader may or may not block when read() is sent. The implementation in StringReader always returns true even when it has been closed.

Overrides:
ready in class Reader
Returns:
true if the receiver will not block when read() is called, false if unknown or blocking will occur.
Throws:
IOException - If an IO error occurs.

reset

public void reset()
           throws IOException
Reset this StringReader's position to the last mark() location. Invocations of read()/skip() will occur from this new location. If this Reader was not marked, the StringReader is reset to the beginning of the String.

Overrides:
reset in class Reader
Throws:
IOException - If this StringReader has already been closed.

skip

public long skip(long ns)
          throws IOException
Description copied from class: Reader
Skips count number of characters in this Reader. Subsequent read()'s will not return these characters unless reset() is used. This method may perform multiple reads to read count characters.

Overrides:
skip in class Reader
Parameters:
ns - how many characters should be passed over
Returns:
how many characters were successfully passed over
Throws:
IOException - If the Reader is closed when the call is made or if an IO error occurs during the operation.

Build 1.0_r1(from source)

Please submit a feedback, bug or feature