oracle.adfnmc.java.io
Class StringReader

java.lang.Object
  java.io.Reader
      oracle.adfnmc.java.io.StringReader

public class StringReader
extends java.io.Reader

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

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

StringReader(java.lang.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() Answers 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)
boolean	ready() Answers 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)

Methods inherited from class java.io.Reader

read

Methods inherited from class java.lang.Object

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

Constructor Detail

StringReader

public StringReader(java.lang.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 class java.io.Reader

mark

public void mark(int readLimit)
          throws java.io.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 java.io.Reader

Parameters:

readLimit - ignored for StringReaders.

Throws:

java.io.IOException - If an error occurs attempting mark this StringReader.

markSupported

public boolean markSupported()

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

Overrides:

markSupported in class java.io.Reader

Returns:

true if mark() and reset() are supported, false otherwise. This implementation always returns true.

read

public int read()
         throws java.io.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 java.io.Reader

Returns:

the character read or -1 if end of reader.

Throws:

java.io.IOException - If the StringReader is already closed.

read

public int read(char[] buf,
                int offset,
                int len)
         throws java.io.IOException

Specified by:

read in class java.io.Reader

Throws:

java.io.IOException

ready

public boolean ready()
              throws java.io.IOException

Answers 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 java.io.Reader

Returns:

true if the receiver will not block when read() is called, false if unknown or blocking will occur.

Throws:

java.io.IOException - If an IO error occurs.

reset

public void reset()
           throws java.io.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 java.io.Reader

Throws:

java.io.IOException - If this StringReader has already been closed.

skip

public long skip(long ns)
          throws java.io.IOException

Overrides:

skip in class java.io.Reader

Throws:

java.io.IOException