Apache POI - Common 5.3.0 · org.apache.poi.poifs.filesystem.DocumentOutputStream

Modifier and Type	Field and Description
private UnsynchronizedByteArrayOutputStream	_buffer our buffer, when null we're into normal blocks
private boolean	_closed have we been closed?
private final POIFSDocument	_document the actual Document
private int	_document_size the Document's size, i.e. the size of the big block data - mini block data is cached and not counted
private final long	_limit a write limit or -1 if unlimited
private final DocumentProperty	_property and its Property
private POIFSStream	_stream our main block stream, when we're into normal blocks
private OutputStream	_stream_output

Access	Constructor and Description
public	DocumentOutputStream(DocumentEntry the DocumentEntry to be written document) Create an OutputStream from the specified DocumentEntry.
public	DocumentOutputStream(DirectoryEntry Where to create the Entry parent, String Name of the new entry name) Create an OutputStream to create the specified new Entry
pack-priv	DocumentOutputStream(DocumentEntry the DocumentEntry to which the data is actually written document, long the maximum number of bytes that can be written limit) Create a DocumentOutputStream
pack-priv	DocumentOutputStream(POIFSDocument document, long limit)

Method Summary

Modifier and Type	Method and Description
private void	checkBufferSize()
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
private static DocumentEntry	createDocument(DirectoryEntry parent, String name)
private static POIFSDocument	getDocument(DocumentEntry document)
public long	Returns: the amount of written bytes size()
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited from java.io.OutputStream:: flush nullOutputStream write

Field Detail

_buffer	back to summary
private UnsynchronizedByteArrayOutputStream _buffer our buffer, when null we're into normal blocks

_closed	back to summary
private boolean _closed have we been closed?

_document	back to summary
private final POIFSDocument _document the actual Document

_document_size	back to summary
private int _document_size the Document's size, i.e. the size of the big block data - mini block data is cached and not counted

_limit	back to summary
private final long _limit a write limit or -1 if unlimited

_property	back to summary
private final DocumentProperty _property and its Property

_stream	back to summary
private POIFSStream _stream our main block stream, when we're into normal blocks

_stream_output	back to summary
private OutputStream _stream_output

Constructor Detail

DocumentOutputStream	back to summary
public DocumentOutputStream(DocumentEntry document) throws IOException Create an OutputStream from the specified DocumentEntry. The specified entry will be emptied. Parameters document:DocumentEntry the DocumentEntry to be written

DocumentOutputStream

back to summary

public DocumentOutputStream(DocumentEntry document) throws IOException

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

Parameters

document:DocumentEntry: the DocumentEntry to be written

DocumentOutputStream	back to summary
public DocumentOutputStream(DirectoryEntry parent, String name) throws IOException Create an OutputStream to create the specified new Entry Parameters parent:DirectoryEntry Where to create the Entry name:String Name of the new entry

DocumentOutputStream

back to summary

public DocumentOutputStream(DirectoryEntry parent, String name) throws IOException

Create an OutputStream to create the specified new Entry

Parameters

parent:DirectoryEntry: Where to create the Entry
name:String: Name of the new entry

DocumentOutputStream	back to summary
pack-priv DocumentOutputStream(DocumentEntry document, long limit) throws IOException Create a DocumentOutputStream Parameters document:DocumentEntry the DocumentEntry to which the data is actually written limit:long the maximum number of bytes that can be written

DocumentOutputStream

back to summary

pack-priv DocumentOutputStream(DocumentEntry document, long limit) throws IOException

Create a DocumentOutputStream

Parameters

document:DocumentEntry: the DocumentEntry to which the data is actually written
limit:long: the maximum number of bytes that can be written

DocumentOutputStream	back to summary
pack-priv DocumentOutputStream(POIFSDocument document, long limit) throws IOException

Method Detail

checkBufferSize	back to summary
private void checkBufferSize() throws IOException

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

createDocument	back to summary
private static DocumentEntry createDocument(DirectoryEntry parent, String name) throws IOException

getDocument	back to summary
private static POIFSDocument getDocument(DocumentEntry document) throws IOException

size	back to summary
public long size() Returns:long the amount of written bytes

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. 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. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

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

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

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.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

public final Class DocumentOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail