Package org.docx4j.org.apache.poi.poifs.filesystem

Class ODocumentInputStream

java.lang.Object

java.io.InputStream

org.docx4j.org.apache.poi.poifs.filesystem.DocumentInputStream

org.docx4j.org.apache.poi.poifs.filesystem.ODocumentInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, LittleEndianInput

public final class ODocumentInputStream
extends DocumentInputStream

This class provides methods to read a DocumentEntry managed by a OPOIFSFileSystem instance.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	_closed	have we been closed?
private int	_current_offset	current offset into the Document
private DataInputBlock	_currentBlock	the data block containing the current stream pointer
private OPOIFSDocument	_document	the actual Document
private int	_document_size	the Document's size
private int	_marked_offset	current marked offset into the Document (used by mark and reset)

Fields inherited from class org.docx4j.org.apache.poi.poifs.filesystem.DocumentInputStream

EOF, SIZE_INT, SIZE_LONG, SIZE_SHORT

Constructor Summary

Constructors

Constructor	Description
ODocumentInputStream(DocumentEntry document)	Create an InputStream from the specified DocumentEntry
ODocumentInputStream(OPOIFSDocument document)	Create an InputStream from the specified Document

Method Summary

Modifier and Type	Method	Description
private boolean	atEOD()
int	available()
private void	checkAvaliable(int requestedSize)
void	close()
private void	dieIfClosed()
private DataInputBlock	getDataInputBlock(int offset)
void	mark(int ignoredReadlimit)
int	read()
int	read(byte[] b, int off, int len)
byte	readByte()
double	readDouble()
void	readFully(byte[] buf, int off, int len)
int	readInt()
long	readLong()
short	readShort()
int	readUByte()
int	readUShort()
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)

Methods inherited from class org.docx4j.org.apache.poi.poifs.filesystem.DocumentInputStream

markSupported, read, readFully, readUInt

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_current_offset

private int _current_offset

current offset into the Document

_marked_offset

private int _marked_offset

current marked offset into the Document (used by mark and reset)

_document_size

private int _document_size

the Document's size

_closed

private boolean _closed

have we been closed?

_document

private OPOIFSDocument _document

the actual Document

_currentBlock

private DataInputBlock _currentBlock

the data block containing the current stream pointer

Constructor Details

ODocumentInputStream

public ODocumentInputStream(DocumentEntry document)
                     throws IOException

Create an InputStream from the specified DocumentEntry

Parameters:

document - the DocumentEntry to be read

Throws:

IOException - if the DocumentEntry cannot be opened (like, maybe it has been deleted?)

ODocumentInputStream

public ODocumentInputStream(OPOIFSDocument document)

Create an InputStream from the specified Document

Parameters:

document - the Document to be read

Method Details

available

public int available()

Specified by:

available in interface LittleEndianInput

Overrides:

available in class DocumentInputStream

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class DocumentInputStream

mark

public void mark(int ignoredReadlimit)

Overrides:

mark in class DocumentInputStream

getDataInputBlock

private DataInputBlock getDataInputBlock(int offset)

read

public int read()
         throws IOException

Overrides:

read in class DocumentInputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class DocumentInputStream

Throws:

IOException

reset

public void reset()

Repositions this stream to the position at the time the mark() method was last called on this input stream. If mark() has not been called this method repositions the stream to its beginning.

Overrides:

reset in class DocumentInputStream

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class DocumentInputStream

Throws:

IOException

dieIfClosed

private void dieIfClosed()
                  throws IOException

Throws:

IOException

atEOD

private boolean atEOD()

checkAvaliable

private void checkAvaliable(int requestedSize)

readByte

public byte readByte()

Specified by:

readByte in interface LittleEndianInput

Overrides:

readByte in class DocumentInputStream

readDouble

public double readDouble()

Specified by:

readDouble in interface LittleEndianInput

Overrides:

readDouble in class DocumentInputStream

readShort

public short readShort()

Specified by:

readShort in interface LittleEndianInput

Overrides:

readShort in class DocumentInputStream

readFully

public void readFully(byte[] buf,
 int off,
 int len)

Specified by:

readFully in interface LittleEndianInput

Overrides:

readFully in class DocumentInputStream

readLong

public long readLong()

Specified by:

readLong in interface LittleEndianInput

Overrides:

readLong in class DocumentInputStream

readInt

public int readInt()

Specified by:

readInt in interface LittleEndianInput

Overrides:

readInt in class DocumentInputStream

readUShort

public int readUShort()

Specified by:

readUShort in interface LittleEndianInput

Overrides:

readUShort in class DocumentInputStream

readUByte

public int readUByte()

Specified by:

readUByte in interface LittleEndianInput

Overrides:

readUByte in class DocumentInputStream