java.io
Class FilterInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.FilterInputStream

Direct Known Subclasses:

BufferedInputStream, DataInputStream, DigestInputStream, LineNumberInputStream, NonBlockingInputStream, javax.swing.JEditorPane.PageStream, ProgressMonitorInputStream, PushbackInputStream

public class FilterInputStream

extends InputStream

Untamed: A FilterInputStream contains some other input stream, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterInputStream itself simply overrides all methods of InputStream with versions that pass all requests to the contained input stream. Subclasses of FilterInputStream may further override some of these methods and may also provide additional methods and fields.

Since:

JDK1.0

Version:

1.24, 12/03/01

Author:

Jonathan Payne

Field Summary

protected InputStream

in The input stream to be filtered.

Fields inherited from class java.io.InputStream

Constructor Summary

protected

FilterInputStream(InputStream in) Creates a FilterInputStream by assigning the argument in to the field this.in so as to remember it for later use.

Method Summary

int	available() Enabled: Returns the number of bytes that can be read from this input stream without blocking.
void	close() Enabled: Closes this input stream and releases any system resources associated with the stream.
void	mark(int readlimit) Enabled: Marks the current position in this input stream.
boolean	markSupported() Enabled: Tests if this input stream supports the mark and reset methods.
int	read() Enabled: Reads the next byte of data from this input stream.
int	read(byte[] b) Enabled: Reads up to byte.length bytes of data from this input stream into an array of bytes.
int	read(byte[] b, int off, int len) Enabled: Reads up to len bytes of data from this input stream into an array of bytes.
void	reset() Enabled: Repositions this stream to the position at the time the mark method was last called on this input stream.
long	skip(long n) Enabled: Skips over and discards n bytes of data from the input stream.

Methods inherited from class java.io.InputStream

__printOn, getCryptoHash, readAvailable

Methods inherited from class java.lang.Object

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

Field Detail

in

protected InputStream in

The input stream to be filtered.

Constructor Detail

FilterInputStream

protected FilterInputStream(InputStream in)

Creates a FilterInputStream by assigning the argument in to the field this.in so as to remember it for later use.

Parameters:

in - the underlying input stream, or null if this instance is to be created without an underlying stream.

Method Detail

read

public int read()
         throws IOException

Enabled: 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 method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

This method simply performs in.read() and returns the result.

Specified by:

read in class InputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached.

IOException

See Also:

java.io.FilterInputStream#in

read

public int read(byte[] b)
         throws IOException

Enabled: Reads up to byte.length bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

This method simply performs the call read(b, 0, b.length) and returns the result. It is important that it does not do in.read(b) instead; certain subclasses of FilterInputStream depend on the implementation strategy actually used.

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is 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.

IOException

See Also:

java.io.FilterInputStream#read(byte[], int, int)

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Enabled: Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

This method simply performs in.read(b, off, len) and returns the result.

Overrides:

read in class 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.

IOException

See Also:

java.io.FilterInputStream#in

skip

public long skip(long n)
          throws IOException

Enabled: Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

This method simply performs in.skip(n).

Overrides:

skip in class InputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

IOException

available

public int available()
              throws IOException

Enabled: Returns the number of bytes that can be read from this input stream without blocking.

This method simply performs in.available(n) and returns the result.

Overrides:

available in class InputStream

Returns:

the number of bytes that can be read from the input stream without blocking.

IOException

See Also:

java.io.FilterInputStream#in

close

public void close()
           throws IOException

Enabled: Closes this input stream and releases any system resources associated with the stream. This method simply performs in.close().

Overrides:

close in class InputStream

IOException

See Also:

java.io.FilterInputStream#in

mark

public void mark(int readlimit)

Enabled: Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

This method simply performs in.mark(readlimit).

Overrides:

mark in class InputStream

Parameters:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

See Also:

java.io.FilterInputStream#in, java.io.FilterInputStream#reset()

reset

public void reset()
           throws IOException

Enabled: Repositions this stream to the position at the time the mark method was last called on this input stream.

This method simply performs in.reset().

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Overrides:

reset in class InputStream

IOException

See Also:

java.io.FilterInputStream#in, java.io.FilterInputStream#mark(int)

markSupported

public boolean markSupported()

Enabled: Tests if this input stream supports the mark and reset methods. This method simply performs in.markSupported().

Overrides:

markSupported in class InputStream

Returns:

true if this stream type supports the mark and reset method; false otherwise.

See Also:

java.io.FilterInputStream#in, java.io.InputStream#mark(int), java.io.InputStream#reset()