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

Class NDocumentOutputStream

java.lang.Object

java.io.OutputStream

org.docx4j.org.apache.poi.poifs.filesystem.NDocumentOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class NDocumentOutputStream
extends OutputStream

This class provides methods to write a DocumentEntry managed by a NPOIFSFileSystem instance.

Field Summary

Fields

Modifier and Type	Field	Description
private ByteArrayOutputStream	_buffer	our buffer, when null we're into normal blocks
private boolean	_closed	have we been closed?
private NPOIFSDocument	_document	the actual Document
private int	_document_size	the Document's size
private DocumentProperty	_property	and its Property
private NPOIFSStream	_stream	our main block stream, when we're into normal blocks
private OutputStream	_stream_output

Constructor Summary

Constructors

Constructor	Description
NDocumentOutputStream(DirectoryEntry parent, String name)	Create an OutputStream to create the specified new Entry
NDocumentOutputStream(DocumentEntry document)	Create an OutputStream from the specified DocumentEntry.

Method Summary

Modifier and Type	Method	Description
private void	checkBufferSize()
void	close()
private void	dieIfClosed()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush, nullOutputStream

Methods inherited from class java.lang.Object

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

Field Details

_document_size

private int _document_size

the Document's size

_closed

private boolean _closed

have we been closed?

_document

private NPOIFSDocument _document

the actual Document

_property

private DocumentProperty _property

and its Property

_buffer

private ByteArrayOutputStream _buffer

our buffer, when null we're into normal blocks

_stream

private NPOIFSStream _stream

our main block stream, when we're into normal blocks

_stream_output

private OutputStream _stream_output

Constructor Details

NDocumentOutputStream

public NDocumentOutputStream(DocumentEntry document)
                      throws IOException

Create an OutputStream from the specified DocumentEntry. The specified entry will be emptied.

Parameters:

document - the DocumentEntry to be written

Throws:

IOException

NDocumentOutputStream

public NDocumentOutputStream(DirectoryEntry parent,
 String name)
                      throws IOException

Create an OutputStream to create the specified new Entry

Parameters:

parent - Where to create the Entry

name - Name of the new entry

Throws:

IOException

Method Details

dieIfClosed

private void dieIfClosed()
                  throws IOException

Throws:

IOException

checkBufferSize

private void checkBufferSize()
                      throws IOException

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException