Class java.io.ByteArrayInputStream 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.ByteArrayInputStream 

Object
   |
   +----InputStream
           |
           +----java.io.ByteArrayInputStream
public class ByteArrayInputStream
extends InputStream
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.

Version:
1.22, 07/01/98
Author:
Arthur van Hoff
Since:
JDK1.0
See Also:
StringBufferInputStream

Variable Index

o buf
The byte array containing the data.
o count
The index one greater than the last valid character in the input stream buffer.
o mark
The currently marked position in the stream.
o pos
The index of the next character to read from the input stream buffer.

Constructor Index

o java.io.ByteArrayInputStream(byte[])
Creates a new byte array input stream that reads data from the specified byte array.
o java.io.ByteArrayInputStream(byte[], int, int)
Creates a new byte array input stream that reads data from the specified byte array.

Method Index

o available()
Returns the number of bytes that can be read from this input stream without blocking.
o mark(int)
Set the current marked position in the stream.
o markSupported()
Tests if ByteArrayInputStream supports mark/reset.
o read()
Reads the next byte of data from this input stream.
o read(byte[], int, int)
Reads up to len bytes of data into an array of bytes from this input stream.
o reset()
Resets the buffer to the marked position.
o skip(long)
Skips n bytes of input from this input stream.

Variables

o buf 
protected byte[] buf
The byte array containing the data.

Since: JDK1.0
o count 
protected int count
The index one greater than the last valid character in the input stream buffer.

Since: JDK1.0
o mark 
protected int mark
The currently marked position in the stream. ByteArrayInputStreams are marked at position zero by default when constructed. They may be marked at another position within the buffer by the mark() method. The current buffer position is set to this point by the reset() method.

Since: JDK1.1
o pos 
protected int pos
The index of the next character to read from the input stream buffer.

Since: JDK1.0

Constructors

o ByteArrayInputStream 
public ByteArrayInputStream(byte buf)
Creates a new byte array input stream that reads data from the specified byte array. The byte array is not copied.

Parameters:
buf - the input buffer.
Since:
JDK1.0
o ByteArrayInputStream 
public ByteArrayInputStream(byte buf,
                            int offset,
                            int length)
Creates a new byte array input stream that 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.

Parameters:
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.
Since:
JDK1.0

Methods

o available 
public synchronized int available()
Returns 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.

Returns:
the number of bytes that can be read from the input stream without blocking.
Overrides:
available in class InputStream
Since:
JDK1.0
o mark 
public void mark(int markpos)
Set the current marked position in the stream. ByteArrayInputStreams are marked at position zero by default when constructed. They may be marked at another position within the buffer by this method.

Overrides:
mark in class InputStream
Since:
JDK1.1
o markSupported 
public boolean markSupported()
Tests if ByteArrayInputStream supports mark/reset.

Overrides:
markSupported in class InputStream
Since:
JDK1.1
o read 
public synchronized 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 ByteArrayInputStream cannot block.

Returns:
the next byte of data, or -1 if the end of the stream has been reached.
Overrides:
read in class InputStream
Since:
JDK1.0
o read 
public synchronized 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.

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
Since:
JDK1.0
o reset 
public synchronized void reset()
Resets the buffer to the marked position. The marked position is the beginning unless another position was marked.

Overrides:
reset in class InputStream
Since:
JDK1.0
o skip 
public synchronized 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.

Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Overrides:
skip in class InputStream
Since:
JDK1.0 
All Packages  Class Hierarchy  This Package  Previous  Next  Index