All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.StringBufferInputStream 

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.StringBufferInputStream
public class StringBufferInputStream
extends InputStream
Note: StringBufferInputStream is deprecated. This class does not properly convert characters into bytes. As of JDK 1.1, the preferred way to create a stream from a string is via the StringReader class.

This class allows an application to create an input stream in which the bytes read are supplied by the contents of a string. Applications can also read bytes from a byte array by using a ByteArrayInputStream.

Only the low eight bits of each character in the string are used by this class.

See Also:
ByteArrayInputStream, StringReader

Variable Index

o buffer
The string from which bytes are read.
o count
The number of valid characters in the input stream buffer.
o pos
The index of the next character to read from the input stream buffer.

Constructor Index

o StringBufferInputStream(String)
Creates a string input stream to read data from the specified string.

Method Index

o available()
Returns the number of bytes that can be read from the input stream without blocking.
o read()
Reads the next byte of data from this input stream.
o read(byte[], int, int)
Reads up to len bytes of data from this input stream into an array of bytes.
o reset()
Resets the input stream to begin reading from the first character of this input stream's underlying buffer.
o skip(long)
Skips n bytes of input from this input stream.

Variables

o buffer 
Properties Inheritable 
    buffer=String
The string from which bytes are read.

o pos 
Properties Inheritable 
   pos=int
The index of the next character to read from the input stream buffer.

See Also:
buffer
o count 
Properties Inheritable 
   count=int
The number of valid characters in the input stream buffer.

See Also:
buffer

Constructors

o StringBufferInputStream 
    method StringBufferInputStream(s=String) public
Creates a string input stream to read data from the specified string.

Parameters:
s - the underlying input buffer.

Methods

o read 
    method read() returns int public    protect
Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned.

The read method of StringBufferInputStream cannot block. It returns the low eight bits of the next character in this input stream's buffer.

Returns:
the next byte of data, or -1 if the end of the stream is reached.
Overrides:
read in class InputStream
o read 
    method read(b=byte[], -
                off=int, -
                len=int) returns int public    protect
Reads up to len bytes of data from this input stream into an array of bytes.

The read method of StringBufferInputStream cannot block. It copies the low eight bits from the characters in this input stream's buffer into the byte array argument.

Parameters:
b - the buffer into which the data is read.
off - the start offset of the data.
len - the maximum number of bytes read.
Returns:
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Overrides:
read in class InputStream
o skip 
    method skip(n=long) returns long public    protect
Skips n bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached.

Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Overrides:
skip in class InputStream
o available 
    method available() returns int public    protect
Returns the number of bytes that can be read from the input stream without blocking.

Returns:
the value of count - pos, which is the number of bytes remaining to be read from the input buffer.
Overrides:
available in class InputStream
o reset 
    method reset()  public    protect
Resets the input stream to begin reading from the first character of this input stream's underlying buffer.

Overrides:
reset in class InputStream 
All Packages  Class Hierarchy  This Package  Previous  Next  Index