public class DocumentInputStream extends InputStream
Modifier and Type | Field and Description |
---|---|
private boolean |
_closed |
private int |
_current_offset |
private POIFSDocument |
_document |
private int |
_document_size |
private int |
_marked_offset |
private byte[] |
_tiny_buffer |
private static int |
EOD |
private RandomAccessInputStream |
stream |
Constructor and Description |
---|
DocumentInputStream(DocumentEntry document,
RandomAccessInputStream stream)
Create an InputStream from the specified DocumentEntry
|
DocumentInputStream(POIFSDocument document,
RandomAccessInputStream stream)
Create an InputStream from the specified Document
|
Modifier and Type | Method and Description |
---|---|
private boolean |
atEOD() |
int |
available()
Returns 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.
|
void |
close()
Closes this input stream and releases any system resources
associated with the stream.
|
private void |
dieIfClosed() |
void |
mark(int ignoredReadlimit)
Marks the current position in this input stream.
|
boolean |
markSupported()
Tests if this input stream supports the mark and reset 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 array b.
|
int |
read(byte[] b,
int off,
int len)
Reads up to len bytes of data from the input stream into an
array of bytes.
|
void |
reset()
Repositions this stream to the position at the time the mark
method was last called on this input stream.
|
long |
skip(long n)
Skips over and discards n bytes of data from this input
stream.
|
private int _current_offset
private int _marked_offset
private int _document_size
private boolean _closed
private POIFSDocument _document
private byte[] _tiny_buffer
private RandomAccessInputStream stream
private static final int EOD
public DocumentInputStream(DocumentEntry document, RandomAccessInputStream stream) throws IOException
document
- the DocumentEntry to be readIOException
- if the DocumentEntry cannot be opened
(like, maybe it has been deleted?)public DocumentInputStream(POIFSDocument document, RandomAccessInputStream stream) throws IOException
document
- the Document to be readIOException
- if the DocumentEntry cannot be opened
(like, maybe it has been deleted?)public int available() throws IOException
available
in class InputStream
IOException
- on error (such as the stream has been
closed)public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class InputStream
IOException
public void mark(int ignoredReadlimit)
The readlimit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated. This implementation, however, does not care.
The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than readlimit bytes are read from the stream before reset is called. But this stream will.
mark
in class InputStream
ignoredReadlimit
- the maximum limit of bytes that can be
read before the mark position becomes
invalid. Ignored by this
implementation.public boolean markSupported()
markSupported
in class InputStream
public int read() throws IOException
read
in class InputStream
IOException
public int read(byte[] b) throws IOException, NullPointerException
If b is null, a NullPointerException is thrown. If the length of b is zero, then no bytes are read and 0 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 into b.
The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.
The read(b) method for class InputStream has the same effect as:
read(b, 0, b.length)
read
in class InputStream
b
- the buffer into which the data is read.IOException
NullPointerException
public int read(byte[] b, int off, int len) throws IOException, NullPointerException, IndexOutOfBoundsException
The definition of this method in java.io.InputStream allows it to block, but it won't.
If b is null, a NullPointerException is thrown.
If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.
If len is zero, then no bytes are read and 0 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 into b.
The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.
In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.
If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.
read
in class InputStream
b
- the buffer into which the data is read.off
- the start offset in array b at which the data is
written.len
- the maximum number of bytes to read.IOException
NullPointerException
IndexOutOfBoundsException
public void reset()
The general contract of reset is:
All well and good ... this class's markSupported method returns true and this method does not care whether you've called mark at all, or whether you've exceeded the number of bytes specified in the last call to mark. We're basically walking a byte array ... mark and reset to your heart's content.
reset
in class InputStream
public long skip(long n) throws IOException
skip
in class InputStream
n
- the number of bytes to be skipped.IOException
private void dieIfClosed() throws IOException
IOException
private boolean atEOD()
Copyright © 2016 Open Microscopy Environment