Package org.jmrtd.io
Class SplittableInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.jmrtd.io.SplittableInputStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class SplittableInputStream extends InputStream
An input stream which will wrap another input stream (and yield the same bytes) and which can spawn new fresh input stream copies (usinggetInputStream(int)
) (that also yield the same bytes).- Version:
- $Revision: 1763 $
- Author:
- The JMRTD team ([email protected])
-
-
Constructor Summary
Constructors Constructor Description SplittableInputStream(InputStream inputStream, int length)
Wraps an input stream so that copy streams can be split off.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
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 invocation of a method for this input stream.void
close()
Closes this input stream and releases any system resources associated with the stream.int
getBytesBuffered()
Returns the number of buffered bytes in the underlying buffer.InputStream
getInputStream(int position)
Gets a copy of the inputstream positioned atposition
.int
getLength()
Returns the length of the underlying buffer.int
getPosition()
Returns the position within the input stream (the number of bytes read since this input stream was constructed).void
mark(int readlimit)
Marks the current position in this input stream.boolean
markSupported()
Tests if this input stream supports themark
andreset
methods.int
read()
Reads the next byte of data from the input stream.void
reset()
Repositions this stream to the position at the time themark
method was last called on this input stream.long
skip(long n)
Skips over and discardsn
bytes of data from this input stream.void
updateFrom(SplittableInputStream other)
Updates this stream's buffer based on some other stream's buffer.-
Methods inherited from class java.io.InputStream
read, read, readAllBytes, readNBytes, transferTo
-
-
-
-
Constructor Detail
-
SplittableInputStream
public SplittableInputStream(InputStream inputStream, int length)
Wraps an input stream so that copy streams can be split off.- Parameters:
inputStream
- the original input streamlength
- the precise length of bytes that the original input stream provides
-
-
Method Detail
-
updateFrom
public void updateFrom(SplittableInputStream other)
Updates this stream's buffer based on some other stream's buffer.- Parameters:
other
- the other stream
-
getInputStream
public InputStream getInputStream(int position)
Gets a copy of the inputstream positioned atposition
.- Parameters:
position
- a position between0
andgetPosition()
- Returns:
- a fresh input stream
-
getPosition
public int getPosition()
Returns the position within the input stream (the number of bytes read since this input stream was constructed).- Returns:
- the position within this input stream
-
read
public int read() throws IOException
Reads the next byte of data from the input stream. The value byte is returned as anint
in the range0
to255
. 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.- Specified by:
read
in classInputStream
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached - Throws:
IOException
- if an I/O error occurs
-
skip
public long skip(long n) throws IOException
Skips over and discardsn
bytes of data from this input stream. Theskip
method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly0
. This may result from any of a number of conditions; reaching end of file beforen
bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. Ifn
is negative, no bytes are skipped.- Overrides:
skip
in classInputStream
- Parameters:
n
- the number of bytes to be skipped- Returns:
- the actual number of bytes skipped
- Throws:
IOException
- if the stream does not support seek, or if some other I/O error occurs
-
available
public int available() throws 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 invocation of a method for this input stream. The next invocation 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:
available
in classInputStream
- Returns:
- an estimate of the number of bytes that can be read (or skipped
over) from this input stream without blocking or
0
when it reaches the end of the input stream - Throws:
IOException
- on error
-
close
public void close() throws IOException
Closes this input stream and releases any system resources associated with the stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- on error
-
mark
public void mark(int readlimit)
Marks the current position in this input stream. A subsequent call to thereset
method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.The
readlimit
arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated.The general contract of
mark
is that, if the methodmarkSupported
returnstrue
, the stream somehow remembers all the bytes read after the call tomark
and stands ready to supply those same bytes again if and whenever the methodreset
is called. However, the stream is not required to remember any data at all if more thanreadlimit
bytes are read from the stream beforereset
is called.- Overrides:
mark
in classInputStream
- Parameters:
readlimit
- the maximum limit of bytes that can be read before the mark position becomes invalid- See Also:
InputStream.reset()
-
reset
public void reset() throws IOException
Repositions this stream to the position at the time themark
method was last called on this input stream. The general contract ofreset
is:- If the method
markSupported
returnstrue
, then:- If the method
mark
has not been called since the stream was created, or the number of bytes read from the stream sincemark
was last called is larger than the argument tomark
at that last call, then anIOException
might be thrown. - If such an
IOException
is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call tomark
(or since the start of the file, ifmark
has not been called) will be resupplied to subsequent callers of theread
method, followed by any bytes that otherwise would have been the next input data as of the time of the call toreset
.
- If the method
- If the method
markSupported
returnsfalse
, then:- The call to
reset
may throw anIOException
. - If an
IOException
is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of theread
method depend on the particular type of the input stream.
- The call to
- Overrides:
reset
in classInputStream
- Throws:
IOException
- if this stream has not been marked or if the mark has been invalidatedIOException
- on error- See Also:
InputStream.mark(int)
,IOException
- If the method
-
markSupported
public boolean markSupported()
Tests if this input stream supports themark
andreset
methods. Whether or notmark
andreset
are supported is an invariant property of a particular input stream instance. ThemarkSupported
method ofInputStream
returnsfalse
.- Overrides:
markSupported
in classInputStream
- Returns:
true
if this stream instance supports the mark and reset methods andfalse
otherwise- See Also:
InputStream.mark(int)
,InputStream.reset()
-
getLength
public int getLength()
Returns the length of the underlying buffer.- Returns:
- the length of the underlying buffer
-
getBytesBuffered
public int getBytesBuffered()
Returns the number of buffered bytes in the underlying buffer.- Returns:
- the number of buffered bytes in the underlying buffer
-
-