java.io
Class StringBufferInputStream
java.lang.Object
|
+--java.io.InputStream
|
+--java.io.StringBufferInputStream
public class
StringBufferInputStreamextends
InputStream This class permits a
String
to be read as an input stream.
The low eight bits of each character in the
String
are the
bytes that are returned. The high eight bits of each character are
discarded.
The mark/reset functionality in this class behaves differently than
normal. The mark()
method is always ignored and the
reset()
method always resets in stream to start reading from
position 0 in the String. Note that since this method does not override
markSupported()
in InputStream
, calling that
method will return false
.
Note that this class is deprecated because it does not properly handle
16-bit Java characters. It is provided for backwards compatibility only
and should not be used for new development. The StringReader
class should be used instead.
Authors:- Aaron M. Renn (arenn@urbanophile.com)
- Warren Levy <warrenl@cygnus.com>
buffer
protected String buffer
The String which is the input to this stream.
count
protected int count
The length of the String buffer.
pos
protected int pos
Position of the next byte in buffer to be read.
StringBufferInputStream
public StringBufferInputStream(java.lang.String s)
Create a new StringBufferInputStream
that will read bytes
from the passed in String
. This stream will read from the
beginning to the end of the String
.
Parameters:
available
public int available()
This method returns the number of bytes available to be read from this
stream. The value returned will be equal to count - pos
.
Returns:
- The number of bytes that can be read from this stream before
blocking, which is all of them
read
public int read()
This method reads one byte from the stream. The pos
counter
is advanced to the next byte to be read. The byte read is returned as
an int in the range of 0-255. If the stream position is already at the
end of the buffer, no byte is read and a -1 is returned in order to
indicate the end of the stream.
Returns:
- The byte read, or -1 if end of stream
read
public int read(byte[] b, int off, int len)
This method reads bytes from the stream and stores them into a caller
supplied buffer. It starts storing the data at index
offset
into the buffer and attempts to read
len
bytes. This method
can return before reading the number of bytes requested if the end of the
stream is encountered first. The actual number of bytes read is
returned. If no bytes can be read because the stream is already at
the end of stream position, a -1 is returned.
This method does not block.
Parameters:
Returns:
- The actual number of bytes read, or -1 if end of stream.
reset
public void reset()
This method sets the read position in the stream to the beginning
setting the pos
variable equal to 0. Note that this differs
from the common implementation of the reset()
method.
skip
public long skip(long n)
This method attempts to skip the requested number of bytes in the
input stream. It does this by advancing the pos
value by the
specified number of bytes. It this would exceed the length of the
buffer, then only enough bytes are skipped to position the stream at
the end of the buffer. The actual number of bytes skipped is returned.
Parameters:
Returns:
- The actual number of bytes skipped.
String
to be read as an input stream. The low eight bits of each character in theString
are the bytes that are returned. The high eight bits of each character are discarded.The mark/reset functionality in this class behaves differently than normal. The
mark()
method is always ignored and thereset()
method always resets in stream to start reading from position 0 in the String. Note that since this method does not overridemarkSupported()
inInputStream
, calling that method will returnfalse
.Note that this class is deprecated because it does not properly handle 16-bit Java characters. It is provided for backwards compatibility only and should not be used for new development. The
StringReader
class should be used instead.