Package java.io

Previous

Java API

Index

Next

Class ByteArrayInputStream

public  class  java.io.ByteArrayInputStream
    extends  java.io.InputStream  
{
        // Fields
    protected byte buf[];	
    protected int count;	
    protected int pos;	

        // Constructors
    public ByteArrayInputStream(byte  buf[]);	
    public ByteArrayInputStream(byte  buf[], int offset, int  length);
 
        // 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 byte array. Applications can also read bytes from a string by using a StringBufferInputStream .

Fields

buf

protected byte buf[] 

The byte array containing the data.

count

protected int count 

The index one greater than the last valid character in the input stream buffer.

pos

protected int pos 

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

Constructors

ByteArrayInputStream

public ByteArrayInputStream(byte  buf[]) 

Creates a new byte array input stream which reads data from the specified byte array. The byte array is not copied.

Parameter	Description
buf	the input buffer

ByteArrayInputStream

public ByteArrayInputStream(byte  buf[], int  offset, int  length) 

Creates a new byte array input stream which reads data from the specified byte array. Up to length characters are to be read from the byte array, starting at the indicated offset.

The byte array is not copied.

Parameter	Description
buf	the input buffer
offset	the offset in the buffer of the first byte to read
length	the maximum number of bytes to read from the buffer.

Methods

available

public int available() 

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

The available method of ByteArrayInputStream returns the value of count - pos, which is the number of bytes remaining to be read from the input buffer.

Return Value:

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

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 the end of the stream has been reached, the value -1 is returned.

The read method of ByteArrayInputStream cannot block.

Return Value:

Returns the next byte of data, or -1 if the end of the stream has been reached.

Overrides:

read in class InputStream .

read

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

Reads up to len bytes of data into an array of bytes from this input stream. This read method cannot block.

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 this input stream to begin reading from the same position at which it first started reading from the 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 .