java.io
Class StringBufferInputStream
- Closeable
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.
protected String | buffer - The String which is the input to this stream.
|
protected int | count - The length of the String buffer.
|
protected int | pos - Position of the next byte in buffer to be read.
|
int | available() - This method returns the number of bytes available to be read from this
stream.
|
int | read() - This method reads one byte from the stream.
|
int | read(byte[] b, int off, int len) - This method reads bytes from the stream and stores them into a caller
supplied buffer.
|
void | reset() - This method sets the read position in the stream to the beginning
setting the
pos variable equal to 0.
|
long | skip(long n) - This method attempts to skip the requested number of bytes in the
input stream.
|
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
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(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
.
s
- The String
this stream will read from.
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
.
- available in interface InputStream
- 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.
- read in interface InputStream
- 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.
- read in interface InputStream
b
- The array into which the bytes read should be stored.off
- The offset into the array to start storing byteslen
- The requested number of bytes to read
- 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.
- reset in interface InputStream
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.
- skip in interface InputStream
n
- The requested number of bytes to skip
- The actual number of bytes skipped.
StringBufferInputStream.java -- Read an String as a stream
Copyright (C) 1998, 1999, 2001, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.