| java.lang.Object
 java.io.OutputStream
org.apache.poi.poifs.filesystem.DocumentOutputStream
| DocumentOutputStream | | public class DocumentOutputStream extends OutputStream (Code) | | This class provides a wrapper over an OutputStream so that Document
writers can't accidently go over their size limits
author:
Marc Johnson (mjohnson at apache dot org) |
| Method Summary | |
| public void | close()
Closes this output stream and releases any system resources
associated with this stream. | | public void | flush()
Flushes this output stream and forces any buffered output bytes
to be written out. | | public void | write(int b)
Writes the specified byte to this output stream. | | public void | write(byte b)
Writes b.length bytes from the specified byte array
to this output stream. | | public void | write(byte b, int off, int len)
Writes len bytes from the specified byte array starting at
offset off to this output stream. | | void | writeFiller(int totalLimit, byte fill)
|
| DocumentOutputStream | | DocumentOutputStream(OutputStream stream, int limit)(Code) | | Create a DocumentOutputStream
Parameters:
stream - the OutputStream to which the data is actuallyread
Parameters:
limit - the maximum number of bytes that can be written |
| close | | public void close() throws IOException(Code) | | 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.
exception:
IOException - if an I/O error occurs. |
| flush | | public void flush() throws IOException(Code) | | Flushes this output stream and forces any buffered output bytes
to be written out.
exception:
IOException - if an I/O error occurs. |
| write | | public void write(int b) throws IOException(Code) | | 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 - the byte.
exception:
IOException - if an I/O error occurs. In particular,an IOException may be thrown if theoutput stream has been closed, or if thewriter tries to write too much data. |
| write | | public void write(byte b) throws IOException(Code) | | Writes b.length bytes from the specified byte array
to this output stream.
Parameters:
b - the data.
exception:
IOException - if an I/O error occurs. |
| write | | public void write(byte b, int off, int len) throws IOException(Code) | | 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 - the data.
Parameters:
off - the start offset in the data.
Parameters:
len - the number of bytes to write.
exception:
IOException - if an I/O error occurs. In particular,an IOException is thrown if theoutput stream is closed or if the writertries to write too many bytes. |
| writeFiller | | void writeFiller(int totalLimit, byte fill) throws IOException(Code) | | write the rest of the document's data (fill in at the end)
Parameters:
totalLimit - the actual number of bytes the correspondingdocument must fill
Parameters:
fill - the byte to fill remaining space with
exception:
IOException - on I/O error |
|
|