Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache.poi.poifs » filesystem » [javadoc | source]
org.apache.poi.poifs.filesystem
public class: DocumentOutputStream [javadoc | source]
java.lang.Object
   java.io.OutputStream
      org.apache.poi.poifs.filesystem.DocumentOutputStream

All Implemented Interfaces:
    Closeable, Flushable

This class provides a wrapper over an OutputStream so that Document writers can't accidently go over their size limits
Constructor:
 DocumentOutputStream(OutputStream stream,
    int limit) 
    Create a DocumentOutputStream
    Parameters:
    stream - the OutputStream to which the data is actually read
    limit - the maximum number of bytes that can be written
Method from org.apache.poi.poifs.filesystem.DocumentOutputStream Summary:
close,   flush,   write,   write,   write,   writeFiller
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.poifs.filesystem.DocumentOutputStream Detail:
 public  void close() throws IOException 
    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.
 public  void flush() throws IOException 
    Flushes this output stream and forces any buffered output bytes to be written out.
 public  void write(int b) throws IOException 
    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.
 public  void write(byte[] b) throws IOException 
    Writes b.length bytes from the specified byte array to this output stream.
 public  void write(byte[] b,
    int off,
    int len) throws IOException 
    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.

  void writeFiller(int totalLimit,
    byte fill) throws IOException 
    write the rest of the document's data (fill in at the end)