java.lang.Object | ||
↳ | java.io.InputStream | |
↳ | java.io.StringBufferInputStream |
This class was deprecated
in API level 1.
Use StringReader
instead.
A specialized InputStream
that reads bytes from a String
in
a sequential manner.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
buffer | The source string containing the data to read. | ||||||||||
count | The total number of characters in the source string. | ||||||||||
pos | The current position within the source string. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a new
StringBufferInputStream with str as
source. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns an estimated number of bytes that can be read or skipped without blocking for more
input.
| |||||||||||
Reads a single byte from the source string and returns it as an integer
in the range from 0 to 255.
| |||||||||||
Reads up to
byteCount bytes from this stream and stores them in
the byte array buffer starting at byteOffset . | |||||||||||
Resets this stream to the beginning of the source string.
| |||||||||||
Skips
charCount characters in the source string. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.io.InputStream
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
| |||||||||||
From interface
java.lang.AutoCloseable
|
Construct a new StringBufferInputStream
with str
as
source. The size of the stream is set to the length()
of the
string.
str | the source string for this stream. |
---|
NullPointerException | if str is null .
|
---|
Returns an estimated number of bytes that can be read or skipped without blocking for more input.
Note that this method provides such a weak guarantee that it is not very useful in practice.
Firstly, the guarantee is "without blocking for more input" rather than "without blocking": a read may still block waiting for I/O to complete — the guarantee is merely that it won't have to wait indefinitely for data to be written. The result of this method should not be used as a license to do I/O on a thread that shouldn't be blocked.
Secondly, the result is a conservative estimate and may be significantly smaller than the actual number of bytes available. In particular, an implementation that always returns 0 would be correct. In general, callers should only use this method if they'd be satisfied with treating the result as a boolean yes or no answer to the question "is there definitely data ready?".
Thirdly, the fact that a given number of bytes is "available" does not guarantee that a read or skip will actually read or skip that many bytes: they may read or skip fewer.
It is particularly important to realize that you must not use this method to
size a container and assume that you can read the entirety of the stream without needing
to resize the container. Such callers should probably write everything they read to a
ByteArrayOutputStream
and convert that to a byte array. Alternatively, if you're
reading from a file, length()
returns the current length of the file (though
assuming the file's length can't change may be incorrect, reading a file is inherently
racy).
The default implementation of this method in InputStream
always returns 0.
Subclasses should override this method if they are able to indicate the number of bytes
available.
Reads a single byte from the source string and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source string has been reached.
Reads up to byteCount
bytes from this stream and stores them in
the byte array buffer
starting at byteOffset
.
Returns the number of bytes actually read or -1 if the end of the stream
has been reached.
Resets this stream to the beginning of the source string.
Skips charCount
characters in the source string. It does nothing and
returns 0 if charCount
is negative. Less than charCount
characters are
skipped if the end of the source string is reached before the operation
completes.