File	Doc	Category	Size	Date	Package
DocumentOutputStream.java	API Doc	Apache Poi 3.0.1	5551	Mon Jan 01 12:39:34 GMT 2007	org.apache.poi.poifs.filesystem

DocumentOutputStream

• java.lang.Object
  • java.io.OutputStream

Fields Summary
private OutputStream	stream
private int	limit
private int	written

Constructors Summary
DocumentOutputStream(OutputStream stream, int limit) Create a DocumentOutputStream param stream the OutputStream to which the data is actually read param limit the maximum number of bytes that can be written this.stream = stream; this.limit = limit; this.written = 0;

Methods Summary
public void	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. exception IOException if an I/O error occurs. // ignore this call
public void	flush() Flushes this output stream and forces any buffered output bytes to be written out. exception IOException if an I/O error occurs. stream.flush();
private void	limitCheck(int toBeWritten) if ((written + toBeWritten) > limit) { throw new IOException("tried to write too much data"); } written += toBeWritten;
public void	write(int b) 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. param b the byte. exception IOException if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed, or if the writer tries to write too much data. limitCheck(1); stream.write(b);
public void	write(byte[] b) Writes b.length bytes from the specified byte array to this output stream. param b the data. exception IOException if an I/O error occurs. write(b, 0, b.length);
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. 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. param b the data. param off the start offset in the data. param len the number of bytes to write. exception IOException if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed or if the writer tries to write too many bytes. limitCheck(len); stream.write(b, off, len);
void	writeFiller(int totalLimit, byte fill) write the rest of the document's data (fill in at the end) param totalLimit the actual number of bytes the corresponding document must fill param fill the byte to fill remaining space with exception IOException on I/O error if (totalLimit > written) { byte[] filler = new byte[ totalLimit - written ]; Arrays.fill(filler, fill); stream.write(filler); }