Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.io.ByteArrayInputStream

java.lang.Object
    |
    +----java.io.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.

Since:
JDK1.0
See Also:
StringBufferInputStream

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

Constructor Summary
 ByteArrayInputStream(byte[] buf)
Creates a new byte array input stream that reads data from the specified byte array.
 ByteArrayInputStream(byte[] buf, int offset, int length)
Creates a new byte array input stream that reads data from the specified byte array.
 

Method Summary
int  available()
Returns the number of bytes that can be read from this input stream without blocking.
void  mark(int readAheadLimit)
Set the current marked position in the stream.
boolean  markSupported()
Tests if ByteArrayInputStream supports mark/reset.
int  read()
Reads the next byte of data from this input stream.
int  read(byte[] b, int off, int len)
Reads up to len bytes of data into an array of bytes from this input stream.
void  reset()
Resets the buffer to the marked position.
long  skip(long n)
Skips n bytes of input from this input stream.
 
Methods inherited from class java.io.InputStream
 available, close, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

buf

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

pos

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

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.

count

protected int count
The index one greater than the last valid character in the input stream buffer.
Constructor Detail

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.

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.
Method Detail

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 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

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.
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

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.
Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Overrides:
skip in class InputStream

available

public 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

markSupported

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

mark

public void mark(int readAheadLimit)
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

reset

public 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

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.