Closeable
, AutoCloseable
BufferedInputStream
, CheckedInputStream
, CipherInputStream
, DataInputStream
, DeflaterInputStream
, DigestInputStream
, InflaterInputStream
, LineNumberInputStream
, ProgressMonitorInputStream
, PushbackInputStream
A FilterInputStream
wraps 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 select methods of InputStream
with versions that pass all requests to the wrapped input stream. Subclasses of FilterInputStream
may of course override any methods declared or inherited by FilterInputStream
, and may also provide additional fields and methods.
Fields
The input stream to be filtered.
Constructors
protected
Creates a FilterInputStream
by assigning the argument in
to the field this.in
so as to remember it for later use.
int
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.
void
Closes this input stream and releases any system resources associated with the stream.
void
Marks the current position in this input stream.
boolean
Tests if this input stream supports the mark
and reset
methods.
int
Reads the next byte of data from the input stream.
int
Reads up to b.length
bytes of data from this input stream into an array of bytes.
int
read(byte[] b, int off, int len)
Reads up to len
bytes of data from this input stream into an array of bytes.
void
Repositions this stream to the position at the time the mark
method was last called on this input stream.
long
Skips over and discards n
bytes of data from the input stream.
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
The input stream to be filtered.
Creates a FilterInputStream
by assigning the argument in
to the field this.in
so as to remember it for later use.
in
- the underlying input stream, or null
if this instance is to be created without an underlying stream.
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.
read
in class InputStream
in.read()
and returns the result.
-1
if the end of the stream is reached.
IOException
- if an I/O error occurs.
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.
read
in class InputStream
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.
b
- the buffer into which the data is read.
-1
if there is no more data because the end of the stream has been reached.
IOException
- if an I/O error occurs.
throws
IOExceptionReads 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.
read
in class InputStream
in.read(b, off, len)
and returns the result.
b
- the buffer into which the data is read.
off
- the start offset in array b
at which the data is written.
len
- the maximum number of bytes to read.
-1
if there is no more data because the end of the stream has been reached.
NullPointerException
- If b
is null
.
IndexOutOfBoundsException
- If off
is negative, len
is negative, or len
is greater than b.length - off
IOException
- if an I/O error occurs.
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.
skip
in class InputStream
in.skip(n)
and returns the result.
n
- the number of bytes to be skipped.
IOException
- if in.skip(n)
throws an IOException.
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.
available
in class InputStream
in.available()
.
IOException
- if an I/O error occurs.
Closes this input stream and releases any system resources associated with the stream.
close
in interface AutoCloseable
close
in interface Closeable
close
in class InputStream
in.close()
.
IOException
- if an I/O error occurs.
public void mark(int readlimit)
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.
mark
in class InputStream
in.mark(readlimit)
.
readlimit
- the maximum limit of bytes that can be read before the mark position becomes invalid.
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.
reset
in class InputStream
in.reset()
.
IOException
- if this stream has not been marked or if the mark has been invalidated.
public boolean markSupported()
Tests if this input stream supports the mark
and reset
methods.
markSupported
in class InputStream
in.markSupported()
.
true
if this stream type supports the mark
and reset
method; false
otherwise.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4