Save This Page
Home » openjdk-7 » java » io » [javadoc | source]
java.io
public class: ByteArrayInputStream [javadoc | source]
java.lang.Object
   java.io.InputStream
      java.io.ByteArrayInputStream

All Implemented Interfaces:
    Closeable

Direct Known Subclasses:
    ZInputStream

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.

Field Summary
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. 
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]
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 -
 
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:
 public ByteArrayInputStream(byte[] buf) 
 public ByteArrayInputStream(byte[] buf,
    int offset,
    int length) 
Method from java.io.ByteArrayInputStream Summary:
available,   close,   mark,   markSupported,   read,   read,   reset,   skip
Methods from java.io.InputStream:
available,   close,   mark,   markSupported,   read,   read,   read,   reset,   skip
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.ByteArrayInputStream Detail:
 public synchronized int available() 
    Returns the number of remaining bytes that can be read (or skipped over) from this input stream.

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

 public  void close() throws 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.

 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.

 public boolean markSupported() 
    Tests if this InputStream supports mark/reset. The markSupported method of ByteArrayInputStream always returns true.
 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.

    This read method cannot block.

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

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