Package org.apache.commons.io.input
Class UnsynchronizedBufferedInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.UnsynchronizedFilterInputStream
-
- org.apache.commons.io.input.UnsynchronizedBufferedInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public final class UnsynchronizedBufferedInputStream extends UnsynchronizedFilterInputStream
An unsynchronized version ofBufferedInputStream
, not thread-safe.Wraps an existing
InputStream
and buffers the input. Expensive interaction with the underlying input stream is minimized, since most (smaller) requests can be satisfied by accessing the buffer alone. The drawback is that some extra space is required to hold the buffer and that copying takes place when filling that buffer, but this is usually outweighed by the performance benefits.To build an instance, see
UnsynchronizedBufferedInputStream.Builder
.A typical application pattern for the class looks like this:
UnsynchronizedBufferedInputStream s = new UnsynchronizedBufferedInputStream.Builder(). .setInputStream(new FileInputStream("file.java")) .setBufferSize(8192) .get();
Provenance: Apache Harmony and modified.
- Since:
- 2.12.0
- See Also:
BufferedInputStream
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UnsynchronizedBufferedInputStream.Builder
Builds a newUnsynchronizedBufferedInputStream
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
Returns the number of bytes that are available before this stream will block.void
close()
Closes this stream.void
mark(int readlimit)
Sets a mark position in this stream.boolean
markSupported()
Indicates whetherBufferedInputStream
supports themark()
andreset()
methods.int
read()
Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.int
read(byte[] buffer, int offset, int length)
Reads at mostlength
bytes from this stream and stores them in byte arraybuffer
starting at offsetoffset
.void
reset()
Resets this stream to the last marked location.long
skip(long amount)
Skipsamount
number of bytes in this stream.-
Methods inherited from class org.apache.commons.io.input.UnsynchronizedFilterInputStream
builder, read
-
-
-
-
Method Detail
-
available
public int available() throws java.io.IOException
Returns the number of bytes that are available before this stream will block. This method returns the number of bytes available in the buffer plus those available in the source stream.- Overrides:
available
in classUnsynchronizedFilterInputStream
- Returns:
- the number of bytes available before blocking.
- Throws:
java.io.IOException
- if this stream is closed.
-
close
public void close() throws java.io.IOException
Closes this stream. The source stream is closed and any resources associated with it are released.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classUnsynchronizedFilterInputStream
- Throws:
java.io.IOException
- if an error occurs while closing this stream.
-
mark
public void mark(int readlimit)
Sets a mark position in this stream. The parameterreadlimit
indicates how many bytes can be read before a mark is invalidated. Callingreset()
will reposition the stream back to the marked position ifreadlimit
has not been surpassed. The underlying buffer may be increased in size to allowreadlimit
number of bytes to be supported.- Overrides:
mark
in classUnsynchronizedFilterInputStream
- Parameters:
readlimit
- the number of bytes that can be read before the mark is invalidated.- See Also:
reset()
-
markSupported
public boolean markSupported()
Indicates whetherBufferedInputStream
supports themark()
andreset()
methods.- Overrides:
markSupported
in classUnsynchronizedFilterInputStream
- Returns:
true
for BufferedInputStreams.- See Also:
mark(int)
,reset()
-
read
public int read() throws java.io.IOException
Reads a single byte from this stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source string has been reached. If the internal buffer does not contain any available bytes then it is filled from the source stream and the first byte is returned.- Overrides:
read
in classUnsynchronizedFilterInputStream
- Returns:
- the byte read or -1 if the end of the source stream has been reached.
- Throws:
java.io.IOException
- if this stream is closed or another IOException occurs.
-
read
public int read(byte[] buffer, int offset, int length) throws java.io.IOException
Reads at mostlength
bytes from this stream and stores them in byte arraybuffer
starting at offsetoffset
. Returns the number of bytes actually read or -1 if no bytes were read and the end of the stream was encountered. If all the buffered bytes have been used, a mark has not been set and the requested number of bytes is larger than the receiver's buffer size, this implementation bypasses the buffer and simply places the results directly intobuffer
.- Overrides:
read
in classUnsynchronizedFilterInputStream
- 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.length
- the maximum number of bytes to store inbuffer
.- Returns:
- the number of bytes actually read or -1 if end of stream.
- Throws:
java.lang.IndexOutOfBoundsException
- ifoffset < 0
orlength < 0
, or ifoffset + length
is greater than the size ofbuffer
.java.io.IOException
- if the stream is already closed or another IOException occurs.
-
reset
public void reset() throws java.io.IOException
Resets this stream to the last marked location.- Overrides:
reset
in classUnsynchronizedFilterInputStream
- Throws:
java.io.IOException
- if this stream is 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:
mark(int)
-
skip
public long skip(long amount) throws java.io.IOException
Skipsamount
number of bytes in this stream. Subsequentread()
's will not return these bytes unlessreset()
is used.- Overrides:
skip
in classUnsynchronizedFilterInputStream
- Parameters:
amount
- the number of bytes to skip.skip
does nothing and returns 0 ifamount
is less than zero.- Returns:
- the number of bytes actually skipped.
- Throws:
java.io.IOException
- if this stream is closed or another IOException occurs.- See Also:
UnsynchronizedFilterInputStream.mark(int)
,UnsynchronizedFilterInputStream.reset()
-
-