ByteArrayInputStream - Android SDK

Summary: Fields | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

ByteArrayInputStream

extends InputStream

java.lang.Object
↳	java.io.InputStream
	↳	java.io.ByteArrayInputStream

Class Overview

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

Summary

Fields
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	mark	The current mark position.
protected int	pos	The current position within the byte array.

Public Constructors
	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`.

Public Methods
synchronized int	available() Returns the number of remaining bytes.
void	close() Closes this stream and frees resources associated with this stream.
synchronized void	mark(int readlimit) Sets a mark position in this ByteArrayInputStream.
boolean	markSupported() Indicates whether this stream supports the `mark()` and `reset()` methods.
synchronized int	read() Reads a single byte from the source byte array and returns it as an integer in the range from 0 to 255.
synchronized int	read(byte[] buffer, int byteOffset, int byteCount) Reads up to `byteCount` bytes from this stream and stores them in the byte array `buffer` starting at `byteOffset`.
synchronized void	reset() Resets this stream to the last marked location.
synchronized long	skip(long byteCount) Skips `byteCount` bytes in this InputStream.

[Expand]

Inherited Methods

From class java.io.InputStream

int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this stream.
void	mark(int readlimit) Sets a mark position in this InputStream.
boolean	markSupported() Indicates whether this stream supports the `mark()` and `reset()` methods.
int	read(byte[] buffer) Equivalent to `read(buffer, 0, buffer.length)`.
abstract int	read() Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer, int byteOffset, int byteCount) Reads up to `byteCount` bytes from this stream and stores them in the byte array `buffer` starting at `byteOffset`.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips at most `byteCount` bytes in this stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.AutoCloseable

Fields

protected byte[] buf

Added in API level 1

The byte array containing the bytes to stream over.

protected int count

Added in API level 1

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

protected int mark

Added in API level 1

The current mark position. Initially set to 0 or the offset parameter within the constructor.

protected int pos

Added in API level 1

The current position within the byte array.

Public Constructors

public ByteArrayInputStream (byte[] buf)

Added in API level 1

Constructs a new ByteArrayInputStream on the byte array buf.

Parameters

buf	the byte array to stream over.

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

Added in API level 1

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.

Public Methods

public synchronized int available ()

Added in API level 1

Returns the number of remaining bytes.

Returns

count - pos

public void close ()

Added in API level 1

Closes this stream and frees resources associated with this stream.

Throws

IOException	if an I/O error occurs while closing this stream.

public synchronized void mark (int readlimit)

Added in API level 1

Sets a mark position in this ByteArrayInputStream. The parameter readlimit is ignored. Sending reset() will reposition the stream back to the marked position.

Parameters

readlimit	ignored.

public boolean markSupported ()

Added in API level 1

Indicates whether this stream supports the mark() and reset() methods. Returns true since this class supports these methods.

Returns

always true.

public synchronized int read ()

Added in API level 1

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.

Returns

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

public synchronized int read (byte[] buffer, int byteOffset, int byteCount)

Added in API level 1

Reads up to byteCount bytes from this stream and stores them in the byte array buffer starting at byteOffset. Returns the number of bytes actually read or -1 if the end of the stream has been reached.

public synchronized void reset ()

Added in API level 1

Resets this stream to the last marked location. This implementation resets the position to either the marked position, the start position supplied in the constructor or 0 if neither has been provided.

public synchronized long skip (long byteCount)

Added in API level 1

Skips byteCount bytes in this InputStream. Subsequent calls to read will not return these bytes unless reset is used. This implementation skips byteCount number of bytes in the target stream. It does nothing and returns 0 if byteCount is negative.

Returns

the number of bytes actually skipped.

Results

Interfaces

Classes

Exceptions

Errors

ByteArrayInputStream

Class Overview

See Also

Summary

Fields

protected byte[] buf

protected int count

protected int mark

protected int pos

Public Constructors

public ByteArrayInputStream (byte[] buf)

Parameters

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

Parameters

Public Methods

public synchronized int available ()

Returns

public void close ()

Throws

public synchronized void mark (int readlimit)

Parameters

See Also

public boolean markSupported ()

Returns

See Also

public synchronized int read ()

Returns

public synchronized int read (byte[] buffer, int byteOffset, int byteCount)

public synchronized void reset ()

See Also

public synchronized long skip (long byteCount)

Returns