org.zkoss.poi.poifs.filesystem

Class DocumentInputStream

java.lang.Object

java.io.InputStream

org.zkoss.poi.poifs.filesystem.DocumentInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, LittleEndianInput

Direct Known Subclasses:

NDocumentInputStream, ODocumentInputStream

public class DocumentInputStream
extends InputStream
implements LittleEndianInput

This class provides methods to read a DocumentEntry managed by a POIFSFileSystem or NPOIFSFileSystem instance. It creates the appropriate one, and delegates, allowing us to work transparently with the two.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EOF returned by read operations if we're at end of document
protected static int	SIZE_INT
protected static int	SIZE_LONG
protected static int	SIZE_SHORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentInputStream() For use by downstream implementations
	DocumentInputStream(DocumentEntry document) Create an InputStream from the specified DocumentEntry
	DocumentInputStream(NPOIFSDocument document) Create an InputStream from the specified Document
	DocumentInputStream(POIFSDocument document) Create an InputStream from the specified Document

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	mark(int ignoredReadlimit)
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
byte	readByte()
double	readDouble()
void	readFully(byte[] buf)
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 java.lang.Object

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

Field Detail

EOF

protected static final int EOF

returned by read operations if we're at end of document

See Also:

Constant Field Values

SIZE_SHORT

protected static final int SIZE_SHORT

See Also:

Constant Field Values

SIZE_INT

protected static final int SIZE_INT

See Also:

Constant Field Values

SIZE_LONG

protected static final int SIZE_LONG

See Also:

Constant Field Values

Constructor Detail

DocumentInputStream

protected DocumentInputStream()

For use by downstream implementations

DocumentInputStream

public DocumentInputStream(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?)

DocumentInputStream

public DocumentInputStream(POIFSDocument document)

Create an InputStream from the specified Document

Parameters:

document - the Document to be read

DocumentInputStream

public DocumentInputStream(NPOIFSDocument document)

Create an InputStream from the specified Document

Parameters:

document - the Document to be read

Method Detail

available

public int available()

Specified by:

available in interface LittleEndianInput

Overrides:

available in class InputStream

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

mark

public void mark(int ignoredReadlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods.

Overrides:

markSupported in class InputStream

Returns:

true always

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

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 InputStream

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

readByte

public byte readByte()

Specified by:

readByte in interface LittleEndianInput

readDouble

public double readDouble()

Specified by:

readDouble in interface LittleEndianInput

readShort

public short readShort()

Specified by:

readShort in interface LittleEndianInput

readFully

public void readFully(byte[] buf)

Specified by:

readFully in interface LittleEndianInput

readFully

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

Specified by:

readFully in interface LittleEndianInput

readLong

public long readLong()

Specified by:

readLong in interface LittleEndianInput

readInt

public int readInt()

Specified by:

readInt in interface LittleEndianInput

readUShort

public int readUShort()

Specified by:

readUShort in interface LittleEndianInput

readUByte

public int readUByte()

Specified by:

readUByte in interface LittleEndianInput