java.io
Class ByteArrayInputStream

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.io.InputStream sample code for java.io.InputStream definition code for java.io.InputStream 
      extended by java.io.ByteArrayInputStream
All Implemented Interfaces:
Closeable sample code for java.io.Closeable definition code for java.io.Closeable

public class ByteArrayInputStream
extends InputStream sample code for java.io.InputStream definition code for java.io.InputStream

A ByteArrayInputStream contains an internal buffer that contains bytes that may be read from the stream. An internal counter keeps track of the next byte to be supplied by the read method.

Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Since:
JDK1.0
See Also:
StringBufferInputStream sample code for java.io.StringBufferInputStream definition code for java.io.StringBufferInputStream

Field Summary
protected  byte[] buf sample code for java.io.ByteArrayInputStream.buf definition code for java.io.ByteArrayInputStream.buf
          An array of bytes that was provided by the creator of the stream.
protected  int count sample code for java.io.ByteArrayInputStream.count definition code for java.io.ByteArrayInputStream.count
          The index one greater than the last valid character in the input stream buffer.
protected  int mark sample code for java.io.ByteArrayInputStream.mark definition code for java.io.ByteArrayInputStream.mark
          The currently marked position in the stream.
protected  int pos sample code for java.io.ByteArrayInputStream.pos definition code for java.io.ByteArrayInputStream.pos
          The index of the next character to read from the input stream buffer.
 
Constructor Summary
ByteArrayInputStream sample code for java.io.ByteArrayInputStream.ByteArrayInputStream(byte[]) definition code for java.io.ByteArrayInputStream.ByteArrayInputStream(byte[]) (byte[] buf)
          Creates a ByteArrayInputStream so that it uses buf as its buffer array.
ByteArrayInputStream sample code for java.io.ByteArrayInputStream.ByteArrayInputStream(byte[], int, int) definition code for java.io.ByteArrayInputStream.ByteArrayInputStream(byte[], int, int) (byte[] buf, int offset, int length)
          Creates ByteArrayInputStream that uses buf as its buffer array.
 
Method Summary
 int available sample code for java.io.ByteArrayInputStream.available() definition code for java.io.ByteArrayInputStream.available() ()
          Returns the number of bytes that can be read from this input stream without blocking.
 void close sample code for java.io.ByteArrayInputStream.close() definition code for java.io.ByteArrayInputStream.close() ()
          Closing a ByteArrayInputStream has no effect.
 void mark sample code for java.io.ByteArrayInputStream.mark(int) definition code for java.io.ByteArrayInputStream.mark(int) (int readAheadLimit)
          Set the current marked position in the stream.
 boolean markSupported sample code for java.io.ByteArrayInputStream.markSupported() definition code for java.io.ByteArrayInputStream.markSupported() ()
          Tests if this InputStream supports mark/reset.
 int read sample code for java.io.ByteArrayInputStream.read() definition code for java.io.ByteArrayInputStream.read() ()
          Reads the next byte of data from this input stream.
 int read sample code for java.io.ByteArrayInputStream.read(byte[], int, int) definition code for java.io.ByteArrayInputStream.read(byte[], int, int) (byte[] b, int off, int len)
          Reads up to len bytes of data into an array of bytes from this input stream.
 void reset sample code for java.io.ByteArrayInputStream.reset() definition code for java.io.ByteArrayInputStream.reset() ()
          Resets the buffer to the marked position.
 long skip sample code for java.io.ByteArrayInputStream.skip(long) definition code for java.io.ByteArrayInputStream.skip(long) (long n)
          Skips n bytes of input from this input stream.
 
Methods inherited from class java.io.InputStream sample code for java.io.InputStream definition code for java.io.InputStream
read sample code for java.io.InputStream.read(byte[]) definition code for java.io.InputStream.read(byte[])
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

buf sample code for java.io.ByteArrayInputStream.buf

protected byte[] buf
An array of bytes that was provided by the creator of the stream. Elements buf[0] through buf[count-1] are the only bytes that can ever be read from the stream; element buf[pos] is the next byte to be read.


pos sample code for java.io.ByteArrayInputStream.pos

protected int pos
The index of the next character to read from the input stream buffer. This value should always be nonnegative and not larger than the value of count. The next byte to be read from the input stream buffer will be buf[pos].


mark sample code for java.io.ByteArrayInputStream.mark

protected int mark
The currently marked position in the stream. ByteArrayInputStream objects 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.

If no mark has been set, then the value of mark is the offset passed to the constructor (or 0 if the offset was not supplied).

Since:
JDK1.1

count sample code for java.io.ByteArrayInputStream.count

protected int count
The index one greater than the last valid character in the input stream buffer. This value should always be nonnegative and not larger than the length of buf. It is one greater than the position of the last byte within buf that can ever be read from the input stream buffer.

Constructor Detail

ByteArrayInputStream sample code for java.io.ByteArrayInputStream(byte[]) definition code for java.io.ByteArrayInputStream(byte[])

public ByteArrayInputStream(byte[] buf)
Creates a ByteArrayInputStream so that it uses buf as its buffer array. The buffer array is not copied. The initial value of pos is 0 and the initial value of count is the length of buf.

Parameters:
buf - the input buffer.

ByteArrayInputStream sample code for java.io.ByteArrayInputStream(byte[], int, int) definition code for java.io.ByteArrayInputStream(byte[], int, int)

public ByteArrayInputStream(byte[] buf,
                            int offset,
                            int length)
Creates ByteArrayInputStream that uses buf as its buffer array. The initial value of pos is offset and the initial value of count is the minimum of offset+length and buf.length. The buffer array is not copied. The buffer's mark is set to the specified offset.

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 sample code for java.io.ByteArrayInputStream.read() definition code for java.io.ByteArrayInputStream.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.

This read method cannot block.

Specified by:
read sample code for java.io.InputStream.read() definition code for java.io.InputStream.read() in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
Returns:
the next byte of data, or -1 if the end of the stream has been reached.

read sample code for java.io.ByteArrayInputStream.read(byte[], int, int) definition code for java.io.ByteArrayInputStream.read(byte[], int, int)

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. If pos equals count, then -1 is returned to indicate end of file. Otherwise, the number k of bytes read is equal to the smaller of len and count-pos. If k is positive, then bytes buf[pos] through buf[pos+k-1] are copied into b[off] through b[off+k-1] in the manner performed by System.arraycopy. The value k is added into pos and k is returned.

This read method cannot block.

Overrides:
read sample code for java.io.InputStream.read(byte[], int, int) definition code for java.io.InputStream.read(byte[], int, int) in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
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.
See Also:
InputStream.read() sample code for java.io.InputStream.read() definition code for java.io.InputStream.read()

skip sample code for java.io.ByteArrayInputStream.skip(long) definition code for java.io.ByteArrayInputStream.skip(long)

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. The actual number k of bytes to be skipped is equal to the smaller of n and count-pos. The value k is added into pos and k is returned.

Overrides:
skip sample code for java.io.InputStream.skip(long) definition code for java.io.InputStream.skip(long) in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.

available sample code for java.io.ByteArrayInputStream.available() definition code for java.io.ByteArrayInputStream.available()

public int available()
Returns the number of bytes that can be read from this input stream without blocking. The value returned is count - pos, which is the number of bytes remaining to be read from the input buffer.

Overrides:
available sample code for java.io.InputStream.available() definition code for java.io.InputStream.available() in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
Returns:
the number of bytes that can be read from the input stream without blocking.

markSupported sample code for java.io.ByteArrayInputStream.markSupported() definition code for java.io.ByteArrayInputStream.markSupported()

public boolean markSupported()
Tests if this InputStream supports mark/reset. The markSupported method of ByteArrayInputStream always returns true.

Overrides:
markSupported sample code for java.io.InputStream.markSupported() definition code for java.io.InputStream.markSupported() in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
Returns:
true if this stream instance supports the mark and reset methods; false otherwise.
Since:
JDK1.1
See Also:
InputStream.mark(int) sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) , InputStream.reset() sample code for java.io.InputStream.reset() definition code for java.io.InputStream.reset()

mark sample code for java.io.ByteArrayInputStream.mark(int) definition code for java.io.ByteArrayInputStream.mark(int)

public void mark(int readAheadLimit)
Set the current marked position in the stream. ByteArrayInputStream objects are marked at position zero by default when constructed. They may be marked at another position within the buffer by this method.

If no mark has been set, then the value of the mark is the offset passed to the constructor (or 0 if the offset was not supplied).

Note: The readAheadLimit for this class has no meaning.

Overrides:
mark sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
Parameters:
readAheadLimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
Since:
JDK1.1
See Also:
InputStream.reset() sample code for java.io.InputStream.reset() definition code for java.io.InputStream.reset()

reset sample code for java.io.ByteArrayInputStream.reset() definition code for java.io.ByteArrayInputStream.reset()

public void reset()
Resets the buffer to the marked position. The marked position is 0 unless another position was marked or an offset was specified in the constructor.

Overrides:
reset sample code for java.io.InputStream.reset() definition code for java.io.InputStream.reset() in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
See Also:
InputStream.mark(int) sample code for java.io.InputStream.mark(int) definition code for java.io.InputStream.mark(int) , IOException sample code for java.io.IOException definition code for java.io.IOException

close sample code for java.io.ByteArrayInputStream.close() definition code for java.io.ByteArrayInputStream.close()

public void close()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Specified by:
close sample code for java.io.Closeable.close() definition code for java.io.Closeable.close() in interface Closeable sample code for java.io.Closeable definition code for java.io.Closeable
Overrides:
close sample code for java.io.InputStream.close() definition code for java.io.InputStream.close() in class InputStream sample code for java.io.InputStream definition code for java.io.InputStream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.