Package org.apache.commons.io.input
Class UnsynchronizedFilterInputStream
java.lang.Object
java.io.InputStream
org.apache.commons.io.input.UnsynchronizedFilterInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
UnsynchronizedBufferedInputStream
An unsynchronized version of
FilterInputStream
, not thread-safe.
Wraps an existing InputStream
and performs some transformation on the input data while it is being read. Transformations can be anything from a
simple byte-wise filtering input data to an on-the-fly compression or decompression of the underlying stream. Input streams that wrap another input stream
and provide some additional functionality on top of it usually inherit from this class.
To build an instance, use UnsynchronizedFilterInputStream.Builder
.
Provenance: Apache Harmony and modified.
- Since:
- 2.12.0
- See Also:
-
Nested Class Summary
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of bytes that are available before this stream will block.builder()
Constructs a newUnsynchronizedFilterInputStream.Builder
.void
close()
Closes this stream.void
mark
(int readLimit) Sets a mark position in this stream.boolean
Indicates whether this stream supportsmark()
andreset()
.int
read()
Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255.int
read
(byte[] buffer) Reads bytes from this stream and stores them in the byte arraybuffer
.int
read
(byte[] buffer, int offset, int count) Reads at mostcount
bytes from this stream and stores them in the byte arraybuffer
starting atoffset
.void
reset()
Resets this stream to the last marked location.long
skip
(long count) Skipscount
number of bytes in this stream.
-
Field Details
-
inputStream
The source input stream that is filtered.
-
-
Method Details
-
builder
Constructs a newUnsynchronizedFilterInputStream.Builder
.- Returns:
- a new
UnsynchronizedFilterInputStream.Builder
.
-
available
Returns the number of bytes that are available before this stream will block.- Overrides:
available
in classInputStream
- Returns:
- the number of bytes available before blocking.
- Throws:
IOException
- if an error occurs in this stream.
-
close
Closes this stream. This implementation closes the filtered stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- if an error occurs while closing this stream.
-
mark
Sets a mark position in this stream. The parameterreadLimit
indicates how many bytes can be read before the mark is invalidated. Sendingreset()
will reposition this stream back to the marked position, provided thatreadLimit
has not been surpassed.This implementation sets a mark in the filtered stream.
- Overrides:
mark
in classInputStream
- Parameters:
readLimit
- the number of bytes that can be read from this stream before the mark is invalidated.- See Also:
-
markSupported
Indicates whether this stream supportsmark()
andreset()
. This implementation returns whether or not the filtered stream supports marking.- Overrides:
markSupported
in classInputStream
- Returns:
true
ifmark()
andreset()
are supported,false
otherwise.- See Also:
-
read
Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of this stream has been reached.- Specified by:
read
in classInputStream
- Returns:
- the byte read or -1 if the end of the filtered stream has been reached.
- Throws:
IOException
- if the stream is closed or another IOException occurs.
-
read
Reads bytes from this stream and stores them in the byte arraybuffer
. Returns the number of bytes actually read or -1 if no bytes were read and the end of this stream was encountered. This implementation reads bytes from the filtered stream.- Overrides:
read
in classInputStream
- Parameters:
buffer
- the byte array in which to store the read bytes.- Returns:
- the number of bytes actually read or -1 if the end of the filtered stream has been reached while reading.
- Throws:
IOException
- if this stream is closed or another IOException occurs.
-
read
Reads at mostcount
bytes from this stream and stores them in the byte arraybuffer
starting atoffset
. Returns the number of bytes actually read or -1 if no bytes have been read and the end of this stream has been reached. This implementation reads bytes from the filtered stream.- Overrides:
read
in classInputStream
- Parameters:
buffer
- the byte array in which to store the bytes read.offset
- the initial position inbuffer
to store the bytes read from this stream.count
- the maximum number of bytes to store inbuffer
.- Returns:
- the number of bytes actually read or -1 if the end of the filtered stream has been reached while reading.
- Throws:
IOException
- if this stream is closed or another I/O error occurs.
-
reset
Resets this stream to the last marked location. This implementation resets the target stream.- Overrides:
reset
in classInputStream
- Throws:
IOException
- if this stream is already closed, no mark has been set or the mark is no longer valid because more thanreadLimit
bytes have been read since setting the mark.- See Also:
-
skip
Skipscount
number of bytes in this stream. Subsequentread()
's will not return these bytes unlessreset()
is used. This implementation skipscount
number of bytes in the filtered stream.- Overrides:
skip
in classInputStream
- Parameters:
count
- the number of bytes to skip.- Returns:
- the number of bytes actually skipped.
- Throws:
IOException
- if this stream is closed or another IOException occurs.- See Also:
-