Android - An Open Handset Alliance Project

java.io
public class

java.io.FilterInputStream

java.lang.Object
	java.io.InputStream		Closeable
		java.io.FilterInputStream

FilteredInputStream is a class which takes an input stream and filters the input in some way. The filtered view may be a buffered view or one which uncompresses data before returning bytes read. FilterInputStreams are meant for byte streams.

Known Direct Subclasses

BufferedInputStream, CheckedInputStream, CipherInputStream, DataInputStream, DigestInputStream, InflaterInputStream, LineNumberInputStream, PushbackInputStream

Known Indirect Subclasses

GZIPInputStream, JarInputStream, ZipInputStream

Summary

Fields

protected InputStream in The target InputStream which is being filtered.

Protected Constructors

					FilterInputStream(InputStream in)
					Constructs a new FilterInputStream on the InputStream `in`.

Public Methods

	int	available()
		Answers a int representing the number of bytes that are available before this FilterInputStream will block.
	void	close()
		Close this FilterInputStream.
synchronized	void	mark(int readlimit)
		Set a Mark position in this FilterInputStream.
	boolean	markSupported()
		Answers a boolean indicating whether or not this FilterInputStream supports mark() and reset().
	int	read(byte[] buffer, int offset, int count)
		Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`.
	int	read(byte[] buffer)
		Reads bytes from this FilterInputStream and stores them in byte array `buffer`.
	int	read()
		Reads a single byte from this FilterInputStream and returns the result as an int.
synchronized	void	reset()
		Reset this FilterInputStream to the last marked location.
	long	skip(long count)
		Skips `count` number of bytes in this InputStream.

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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.io.Closeable

Details

Fields

protected InputStream in

The target InputStream which is being filtered.

Protected Constructors

protected FilterInputStream(InputStream in)

Constructs a new FilterInputStream on the InputStream in. All reads are now filtered through this stream.

Parameters

in	The non-null InputStream to filter reads on.

Public Methods

public int available()

Answers a int representing the number of bytes that are available before this FilterInputStream will block. This method returns the number of bytes available in the target stream.

Returns

the number of bytes available before blocking.

Throws

IOException	If an error occurs in this stream.

public void close()

Close this FilterInputStream. This implementation closes the target stream.

Throws

IOException	If an error occurs attempting to close this stream.

public synchronized void mark(int readlimit)

Set a Mark position in this FilterInputStream. The parameter readLimit indicates how many bytes can be read before a mark is invalidated. Sending reset() will reposition the Stream back to the marked position provided readLimit has not been surpassed.

This implementation sets a mark in the target stream.

Parameters

readlimit	the number of bytes to be able to read before invalidating the mark.

public boolean markSupported()

Answers a boolean indicating whether or not this FilterInputStream supports mark() and reset(). This implementation answers whether or not the target stream supports marking.

Returns

true if mark() and reset() are supported, false otherwise.

public int read(byte[] buffer, int offset, int count)

Reads at most count bytes from this FilterInputStream and stores them in byte array buffer starting at offset. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered. This implementation reads bytes from the target stream.

Parameters

buffer	the byte array in which to store the read bytes.
offset	the offset in `buffer` to store the read bytes.
count	the maximum number of bytes to store in `buffer`.

Returns

the number of bytes actually read or -1 if end of stream.

Throws

IOException	If the stream is already closed or another IOException occurs.

public int read(byte[] buffer)

Reads bytes from this FilterInputStream and stores them in byte array buffer. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered. This implementation reads bytes from the target stream.

Parameters

buffer	the byte array in which to store the read bytes.

Returns

the number of bytes actually read or -1 if end of stream.

Throws

IOException	If the stream is already closed or another IOException occurs.

public int read()

Reads a single byte from this FilterInputStream and returns the result as an int. The low-order byte is returned or -1 of the end of stream was encountered. This implementation returns a byte from the target stream.

Returns

the byte read or -1 if end of stream.

Throws

IOException	If the stream is already closed or another IOException occurs.

public synchronized void reset()

Reset this FilterInputStream to the last marked location. If the readlimit has been passed or no mark has been set, throw IOException. This implementation resets the target stream.

Throws

IOException	If the stream is already closed or another IOException occurs.

public long skip(long count)

Skips count number of bytes in this InputStream. Subsequent read()'s will not return these bytes unless reset() is used. This implementation skips count number of bytes in the target stream.

Parameters

count	the number of bytes to skip.

Returns

the number of bytes actually skipped.

Throws

IOException	If the stream is already closed or another IOException occurs.

BufferedInputStream	`BufferedInputStream` is a class which takes an input stream and buffers the input.
CheckedInputStream	The CheckedInputStream class is used to maintain a running Checksum of all data read from a stream.
CipherInputStream
DataInputStream	DataInputStream is a filter class which can read typed data from a Stream.
DigestInputStream
InflaterInputStream	InflaterOutputStream read data which has been compressed using the DEFLATE compression method.
LineNumberInputStream	This class is deprecated. Use LineNumberReader
PushbackInputStream	PushbackInputStream is a filter class which allows bytes read to be pushed back into the stream so that they can be reread.

GZIPInputStream	The GZIPInputStream class is used to read data stored in the GZIP format.
JarInputStream
ZipInputStream	ZipInputStream is an input stream for reading zip files.

		int	available()
			Answers a int representing then number of bytes that are available before this InputStream will block.
		void	close()
			Close the InputStream.
		void	mark(int readlimit)
			Set a Mark position in this InputStream.
		boolean	markSupported()
			Answers a boolean indicating whether or not this InputStream supports mark() and reset().
		int	read(byte[] b, int offset, int length)
			Reads at most `length` bytes from the Stream and stores them in byte array `b` starting at `offset`.
		int	read(byte[] b)
			Reads bytes from the Stream and stores them in byte array `b`.
abstract		int	read()
			Reads a single byte from this InputStream and returns the result as an int.
	synchronized	void	reset()
			Reset this InputStream to the last marked location.
		long	skip(long n)
			Skips `n` number of bytes in this InputStream.

				void	close()
					Close the object and release any system resources it holds.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.io.FilterInputStream

Known Direct Subclasses

Known Indirect Subclasses

See Also

Summary

Fields

Protected Constructors

Public Methods

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Details

Fields

protected InputStream in

Protected Constructors

protected FilterInputStream(InputStream in)

Parameters

Public Methods

public int available()

Returns

Throws

public void close()

Throws

public synchronized void mark(int readlimit)

Parameters

public boolean markSupported()

Returns

public int read(byte[] buffer, int offset, int count)

Parameters

Returns

Throws

public int read(byte[] buffer)

Parameters

Returns

Throws

public int read()

Returns

Throws

public synchronized void reset()

Throws

public long skip(long count)

Parameters

Returns

Throws