jsimple.io

Class ByteArrayInputStream

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.InputStream

jsimple.io.ByteArrayInputStream

All Implemented Interfaces:

java.lang.AutoCloseable

public class ByteArrayInputStream
extends InputStream

This class was based on, and modified from, the Apache Harmony java.io.ByteArrayInputStream class. Unlike the Java InputStream class, this doesn't support mark, reset, or skip, doesn't throw any checked exceptions, and none of the methods are synchronized.

A specialized InputStream for reading the contents of a byte array.

Since:

10/8/12 8:34 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf The byte array containing the bytes to stream over.
protected int	count The total number of bytes initially available in the byte array buf.
protected int	pos The current position within the byte array.

Constructor Summary

Constructors

Constructor and Description
ByteArrayInputStream(byte[] buf) Constructs a new ByteArrayInputStream on the byte array buf.
ByteArrayInputStream(byte[] buf, int offset, int length) Constructs a new ByteArrayInputStream on the byte array buf with the initial position set to offset and the number of bytes available set to offset + length.
ByteArrayInputStream(ByteArrayRange byteArrayRange) Constructs a new ByteArrayInputStream on the byte array range.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream.
int	read() Reads a single byte from the source byte array and returns it as an integer in the range from 0 to 255.
int	read(byte[] b, int offset, int length) Reads at most len bytes from this stream and stores them in byte array b starting at offset.

Methods inherited from class jsimple.io.InputStream

copyTo, copyToByteArray, finalize, read, readFully, readFully

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

buf

protected byte[] buf

The byte array containing the bytes to stream over.

pos

protected int pos

The current position within the byte array.

count

protected int count

The total number of bytes initially available in the byte array buf.

Constructor Detail

ByteArrayInputStream

public ByteArrayInputStream(byte[] buf)

Constructs a new ByteArrayInputStream on the byte array buf.

Parameters:

buf - the byte array to stream over.

ByteArrayInputStream

public ByteArrayInputStream(ByteArrayRange byteArrayRange)

Constructs a new ByteArrayInputStream on the byte array range.

Parameters:

byteArrayRange - the byte array range to stream over

ByteArrayInputStream

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

Constructs a new ByteArrayInputStream on the byte array buf with the initial position set to offset and the number of bytes available set to offset + length.

Parameters:

buf - the byte array to stream over.

offset - the initial position in buf to start streaming from.

length - the number of bytes available for streaming.

Method Detail

close

public void close()

Description copied from class: InputStream

Closes this stream. If the stream is already closed, then this method should do nothing. Concrete implementations of this class should free any resources during close.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class InputStream

read

public int read()

Reads a single byte from the source byte array and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source array has been reached.

Specified by:

read in class InputStream

Returns:

the byte read or -1 if the end of this stream has been reached.

read

public int read(byte[] b,
                int offset,
                int length)

Reads at most len bytes from this stream and stores them in byte array b starting at offset. This implementation reads bytes from the source byte array.

Specified by:

read in class InputStream

Parameters:

b - the byte array in which to store the bytes read

offset - the initial position in b to store the bytes read from this stream

length - the maximum number of bytes to store in b

Returns:

the number of bytes actually read or -1 if no bytes were read and the end of the stream was encountered