OpenJDK 27 · java.io.FilterInputStream · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected volatile InputStream	in The input stream to be filtered.

Access	Constructor and Description
protected	FilterInputStream(InputStream the underlying input stream, or `null` if this instance is to be created without an underlying stream. in) Creates a `FilterInputStream` by assigning the argument `in` to the field `this.in` so as to remember it for later use.

Method Summary

Modifier and Type	Method and Description
public int	Returns: an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking. available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public void	mark(int readlimit) Overrides java.io.InputStream.mark. Marks the current position in this input stream.
public boolean	Returns: `true` if this stream type supports the `mark` and `reset` method; `false` otherwise. markSupported() Overrides java.io.InputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] b) Overrides java.io.InputStream.read. Reads up to `b.length` bytes of data from this input stream into an array of bytes.
public int	read(byte[] b, int off, int len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
public void	reset() Overrides java.io.InputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.
public long	Returns: the actual number of bytes skipped. skip(long n) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from the input stream.

Inherited from java.io.InputStream:: nullInputStream readAllBytes readNBytes readNBytes skipNBytes transferTo

in	back to summary
protected volatile InputStream in The input stream to be filtered.

FilterInputStream	back to 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. Parameters in:InputStream the underlying input stream, or `null` if this instance is to be created without an underlying stream.

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Implementation Specification This method returns the result of `in.available()`. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Implementation Specification

This method returns the result of in.available().

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Implementation Specification This method simply performs `in.close()`. Annotations @Override Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#in`

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Implementation Specification

This method simply performs in.close().

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.FilterInputStream#in

mark back to summary

mark	back to summary
public void mark(int readlimit) Overrides java.io.InputStream.mark. 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. Implementation Specification This method simply performs `in.mark(readlimit)`. Annotations @Override See Also `java.io.FilterInputStream#in`, `java.io.FilterInputStream#reset()`

public void mark(int readlimit)

Overrides java.io.InputStream.mark.

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.

Implementation Specification

This method simply performs in.mark(readlimit).

Annotations

@Override

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.InputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods. Implementation Specification This method simply performs `in.markSupported()`. Returns:boolean `true` if this stream type supports the `mark` and `reset` method; `false` otherwise. Annotations @Override See Also `java.io.FilterInputStream#in`, `java.io.InputStream#mark(int)`, `java.io.InputStream#reset()`

public boolean markSupported()

Overrides java.io.InputStream.markSupported.

Tests if this input stream supports the mark and reset methods.

Implementation Specification

This method simply performs in.markSupported().

Returns:boolean

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

Annotations

@Override

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the 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. Implementation Specification This method simply performs `in.read()` and returns the result. Annotations @Override Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#in`

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the 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.

Implementation Specification

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.FilterInputStream#in

read back to summary

read	back to summary
public int read(byte[] b) throws IOException Overrides java.io.InputStream.read. Reads up to `b.length` bytes of data from this input stream into an array of bytes. This method blocks until some input is available. Implementation Specification 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. Annotations @Override Exceptions IOException: if an I/O error occurs. See Also `java.io.FilterInputStream#read(byte[], int, int)`

public int read(byte[] b) throws IOException

Overrides java.io.InputStream.read.

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

Implementation Specification

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.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. Implementation Specification This method simply performs `in.read(b, off, len)` and returns the result. Annotations @Override Exceptions IOException: if an I/O error occurs. NullPointerException: If `b` is `null`. IndexOutOfBoundsException: If `off` is negative, `len` is negative, or `len` is greater than `b.length - off` See Also `java.io.FilterInputStream#in`

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

Overrides java.io.InputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Implementation Specification

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: If b is null.
IndexOutOfBoundsException:: If off is negative, len is negative, or len is greater than b.length - off

See Also

java.io.FilterInputStream#in

reset back to summary

reset	back to summary
public void reset() throws IOException Overrides java.io.InputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream. 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. Implementation Specification This method simply performs `in.reset()`. Annotations @Override Exceptions IOException: if this stream has not been marked or if the mark has been invalidated. See Also `java.io.FilterInputStream#in`, `java.io.FilterInputStream#mark(int)`

public void reset() throws IOException

Overrides java.io.InputStream.reset.

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

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.

Implementation Specification

This method simply performs in.reset().

Annotations

@Override

Exceptions

IOException:: if this stream has not been marked or if the mark has been invalidated.

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.InputStream.skip. 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. Implementation Specification This method simply performs `in.skip(n)` and returns the result. Returns:long the actual number of bytes skipped. Annotations @Override Exceptions IOException: if `in.skip(n)` throws an IOException.

public long skip(long n) throws IOException

Overrides java.io.InputStream.skip.

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.

Implementation Specification

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

Returns:long

the actual number of bytes skipped.

Annotations

@Override

Exceptions

IOException:: if in.skip(n) throws an IOException.

public Class FilterInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail