Class DocumentOutputStream

  • All Implemented Interfaces:
    Closeable, Flushable, AutoCloseable

    public class DocumentOutputStream
    extends OutputStream
    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 Detail

      • write

        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.
        Specified by:
        write in class OutputStream
        Parameters:
        b - the byte.
        Throws:
        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.
      • write

        public void write​(byte[] b)
                   throws IOException
        Writes b.length bytes from the specified byte array to this output stream.
        Overrides:
        write in class OutputStream
        Parameters:
        b - the data.
        Throws:
        IOException - if an I/O error occurs.
      • write

        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.

        Overrides:
        write in class OutputStream
        Parameters:
        b - the data.
        off - the start offset in the data.
        len - the number of bytes to write.
        Throws:
        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.
      • close

        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.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
        Overrides:
        close in class OutputStream
        Throws:
        IOException - if an I/O error occurs.