Class ArbitraryDataInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Author:
- Andrew Pavlin, KA2DDO
-
Constructor Summary
ConstructorDescriptionArbitraryDataInputStream
(DataInput dataInput) Create an new ArbitraryDataInputStream wrapper around the specified DataInput. -
Method Summary
Modifier and TypeMethodDescriptionvoid
mark
(int readlimit) Marks the current position in this input stream.boolean
Tests if this input stream supports themark
andreset
methods.int
read()
Reads the next byte of data from the input stream.int
read
(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer arrayb
.int
read
(byte[] b, int off, int len) Reads up tolen
bytes of data from the input stream into an array of bytes.Methods inherited from class java.io.InputStream
available, close, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo
-
Constructor Details
-
ArbitraryDataInputStream
Create an new ArbitraryDataInputStream wrapper around the specified DataInput. Note that one could do this to a DataInputStream, but it would be redundant.- Parameters:
dataInput
- dataInput implementor to wrap
-
-
Method Details
-
read
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.A subclass must provide an implementation of this method.
- 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.
-
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.Marking a closed stream should not have any effect on the stream.
The
mark
method ofInputStream
does nothing.- Overrides:
mark
in classInputStream
- Parameters:
readlimit
- the maximum limit of bytes that can be read before the mark position becomes invalid.- See Also:
-
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;false
otherwise.- See Also:
-
read
Reads some number of bytes from the input stream and stores them into the buffer arrayb
. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.If the length of
b
is zero, then no bytes are read and0
is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value-1
is returned; otherwise, at least one byte is read and stored intob
.The first byte read is stored into element
b[0]
, the next one intob[1]
, and so on. The number of bytes read is, at most, equal to the length ofb
. Let k be the number of bytes actually read; these bytes will be stored in elementsb[0]
throughb[
k-1]
, leaving elementsb[
k]
throughb[b.length-1]
unaffected.The
read(b)
method for classInputStream
has the same effect as:read(b, 0, b.length)
- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.- Returns:
- the total number of bytes read into the buffer, or
-1
is there is no more data because the end of the stream has been reached. - Throws:
IOException
- If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.NullPointerException
- ifb
isnull
.- See Also:
-
read
Reads up tolen
bytes of data from the input stream into an array of bytes. An attempt is made to read as many aslen
bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.This method blocks until input data is available, end of file is detected, or an exception is thrown.
If
len
is zero, then no bytes are read and0
is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value-1
is returned; otherwise, at least one byte is read and stored intob
.The first byte read is stored into element
b[off]
, the next one intob[off+1]
, and so on. The number of bytes read is, at most, equal tolen
. Let k be the number of bytes actually read; these bytes will be stored in elementsb[off]
throughb[off+
k-1]
, leaving elementsb[off+
k]
throughb[off+len-1]
unaffected.In every case, elements
b[0]
throughb[off]
and elementsb[off+len]
throughb[b.length-1]
are unaffected.The
read(b,
off,
len)
method for classInputStream
simply calls the methodread()
repeatedly. If the first such call results in anIOException
, that exception is returned from the call to theread(b,
off,
len)
method. If any subsequent call toread()
results in aIOException
, the exception is caught and treated as if it were end of file; the bytes read up to that point are stored intob
and the number of bytes read before the exception occurred is returned. The default implementation of this method blocks until the requested amount of input datalen
has been read, end of file is detected, or an exception is thrown. Subclasses are encouraged to provide a more efficient implementation of this method.- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in arrayb
at which the data is written.len
- the maximum number of bytes to read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
IOException
- If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.NullPointerException
- Ifb
isnull
.IndexOutOfBoundsException
- Ifoff
is negative,len
is negative, orlen
is greater thanb.length - off
- See Also:
-