Package java.io

Previous

Java API

Index

Next

Class StringBufferInputStream

public  class  java.io.StringBufferInputStream
    extends  java.io.InputStream  
{
        // Fields
    protected String buffer;	
    protected int count;	
    protected int pos;	

        // Constructors
    public StringBufferInputStream(String  s);	

        // Methods
    public int available();	
    public int read();	
    public int read(byte  b[], int  off, int  len);	
    public void reset();	
    public long skip(long  n);	
}

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.

Fields

buffer

protected String buffer 

The string from which bytes are read.

count

protected int count 

The number of valid characters in the input stream buffer .

pos

protected int pos 

The index of the next character to read from the input stream buffer .

Constructors

StringBufferInputStream

public StringBufferInputStream(String  s) 

Creates a string input stream to read data from the specified string

Parameter	Description
s	the underlying input buffer

Methods

available

public int available() 

Determines the number of bytes that can be read from the input stream without blocking.

Return Value:

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 .

read

public int read() 

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 8 bits of the next character in this input stream's buffer.

Return Value:

Returns the next byte of data, or -1 if the end of the stream is reachedend of the stream is reached.

Overrides:

read in class InputStream .

read

public int read(byte  b[], int  off, int  len) 

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 8- bits from the characters in this input stream's buffer into the byte array argument.

Return Value:

Returns the total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.

Parameter	Description
b	the buffer into which the data is read
off	the start offset of the data
len	the maximum number of bytes read

Overrides:

read in class InputStream .

reset

public void reset() 

Resets the input stream to begin reading from the first character of this input stream's underlying buffer.

Overrides:

reset in class InputStream .

skip

public long skip(long  n) 

Skips n bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached.

Return Value:

Returns the actual number of bytes skipped.

Parameter	Description
n	the number of bytes to be skipped

Overrides:

skip in class InputStream .