java.lang.Object
java.io.InputStream
java.io.FilterInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
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.- Since:
- 1.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCreates aFilterInputStreamby assigning the argumentinto the fieldthis.inso as to remember it for later use. -
Method Summary
Modifier and TypeMethodDescriptionintReturns 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.voidclose()Closes this input stream and releases any system resources associated with the stream.voidmark(int readlimit) Marks the current position in this input stream.booleanTests if this input stream supports themarkandresetmethods.intread()Reads the next byte of data from the input stream.intread(byte[] b) Reads up tob.lengthbytes of data from this input stream into an array of bytes.intread(byte[] b, int off, int len) Reads up tolenbytes of data from this input stream into an array of bytes.voidreset()Repositions this stream to the position at the time themarkmethod was last called on this input stream.longskip(long n) Skips over and discardsnbytes of data from the input stream.Methods declared in class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Field Details
-
in
The input stream to be filtered.
-
-
Constructor Details
-
FilterInputStream
Creates aFilterInputStreamby assigning the argumentinto the fieldthis.inso as to remember it for later use.- Parameters:
in- the underlying input stream, ornullif this instance is to be created without an underlying stream.
-
-
Method Details
-
read
Reads the next byte of data from the input stream. The value byte is returned as anintin the range0to255. If no byte is available because the end of the stream has been reached, the value-1is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.- Specified by:
readin classInputStream- Implementation Requirements:
- This method simply performs
in.read()and returns the result. - Returns:
- the next byte of data, or
-1if the end of the stream is reached. - Throws:
IOException- if an I/O error occurs.- See Also:
-
read
Reads up tob.lengthbytes of data from this input stream into an array of bytes. This method blocks until some input is available.- Overrides:
readin classInputStream- Implementation Requirements:
- This method simply performs the call
read(b, 0, b.length)and returns the result. It is important that it does not doin.read(b)instead; certain subclasses ofFilterInputStreamdepend on the implementation strategy actually used. - Parameters:
b- the buffer into which the data is read.- Returns:
- the total number of bytes read into the buffer, or
-1if there is no more data because the end of the stream has been reached. - Throws:
IOException- if an I/O error occurs.- See Also:
-
read
Reads up tolenbytes of data from this input stream into an array of bytes. Iflenis not zero, the method blocks until some input is available; otherwise, no bytes are read and0is returned.- Overrides:
readin classInputStream- Implementation Requirements:
- This method simply performs
in.read(b, off, len)and returns the result. - Parameters:
b- the buffer into which the data is read.off- the start offset in arraybat which the data is written.len- the maximum number of bytes to read.- Returns:
- the total number of bytes read into the buffer, or
-1if there is no more data because the end of the stream has been reached. - Throws:
NullPointerException- Ifbisnull.IndexOutOfBoundsException- Ifoffis negative,lenis negative, orlenis greater thanb.length - offIOException- if an I/O error occurs.- See Also:
-
skip
Skips over and discardsnbytes of data from the input stream. Theskipmethod may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly0. The actual number of bytes skipped is returned.- Overrides:
skipin classInputStream- Implementation Requirements:
- This method simply performs
in.skip(n)and returns the result. - Parameters:
n- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
IOException- ifin.skip(n)throws an IOException.- See Also:
-
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.- Overrides:
availablein classInputStream- Implementation Requirements:
- This method returns the result of
in.available(). - Returns:
- an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.
- Throws:
IOException- if an I/O error occurs.
-
close
Closes this input stream and releases any system resources associated with the stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classInputStream- Implementation Requirements:
- This method simply performs
in.close(). - Throws:
IOException- if an I/O error occurs.- See Also:
-
mark
public void mark(int readlimit) Marks the current position in this input stream. A subsequent call to theresetmethod repositions this stream at the last marked position so that subsequent reads re-read the same bytes.The
readlimitargument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.- Overrides:
markin classInputStream- Implementation Requirements:
- This method simply performs
in.mark(readlimit). - Parameters:
readlimit- the maximum limit of bytes that can be read before the mark position becomes invalid.- See Also:
-
reset
Repositions this stream to the position at the time themarkmethod 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.
- Overrides:
resetin classInputStream- Implementation Requirements:
- This method simply performs
in.reset(). - Throws:
IOException- if this stream has not been marked or if the mark has been invalidated.- See Also:
-
markSupported
public boolean markSupported()Tests if this input stream supports themarkandresetmethods.- Overrides:
markSupportedin classInputStream- Implementation Requirements:
- This method simply performs
in.markSupported(). - Returns:
trueif this stream type supports themarkandresetmethod;falseotherwise.- See Also:
-