加载中...
The Wayback Machine - https://sup1a9wrlpyh5li9ro.vcoronado.top/web/20090319161025/http://developer.android.com:80/reference/java/io/StringReader.html
public class

StringReader

extends Reader
java.lang.Object
   ↳ java.io.Reader
     ↳ java.io.StringReader

Class Overview

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

See Also

Summary

[Expand]
Inherited Fields
From class java.io.Reader
Public Constructors
StringReader(String str)
Construct a StringReader on the String str.
Public Methods
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(char[] buf, int offset, int len)
Reads at most count characters from this Reader and stores them at offset in the character array buf.
int read()
Reads a single character from this StringReader and returns the result as an int.
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.
[Expand]
Inherited Methods
From class java.io.Reader
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.Readable

Public Constructors

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.

Public Methods

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.

public void mark (int readLimit)

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.

Parameters
readLimit ignored for StringReaders.
Throws
IOException If an error occurs attempting mark this StringReader.

public boolean markSupported ()

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

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

public 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. Returns the number of characters actually read or -1 if the end of reader was encountered.

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

public int read ()

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.

Returns
  • the character read or -1 if end of reader.
Throws
IOException If the StringReader is already closed.

public boolean ready ()

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.

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.

public void reset ()

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.

Throws
IOException If this StringReader has already been closed.

public long skip (long ns)

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.

Parameters
ns how many characters should be passed over
Returns
  • how many characters were successfully passed over
Throws
IOException