Package com.helger.commons.io.stream

Class NonBlockingBufferedOutputStream

java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
com.helger.commons.io.stream.WrappedOutputStream
com.helger.commons.io.stream.NonBlockingBufferedOutputStream
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable
public class NonBlockingBufferedOutputStream extends WrappedOutputStream
A non-synchronized copy of the class BufferedOutputStream.
Author:
Philip Helger
See Also:

  • Field Details

    • m_aBuf

      protected byte[] m_aBuf
      The internal buffer where data is stored.

    • m_nCount

      protected int m_nCount
      The number of valid bytes in the buffer. This value is always in the range 0 through buf.length; elements buf[0] through buf[count-1] contain valid byte data.

  • Constructor Details

    • NonBlockingBufferedOutputStream

      public NonBlockingBufferedOutputStream(@Nonnull OutputStream aOS)
      Creates a new buffered output stream to write data to the specified underlying output stream.
      Parameters:
      aOS - the underlying output stream.

    • NonBlockingBufferedOutputStream

      public NonBlockingBufferedOutputStream(@Nonnull OutputStream aOS, @Nonnegative int nSize)
      Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.
      Parameters:
      aOS - the underlying output stream.
      nSize - the buffer size.
      Throws:
      IllegalArgumentException - if size <= 0.

  • Method Details

    • write

      public void write(int b) throws IOException
      Writes the specified byte to this buffered output stream.
      Overrides:
      write in class FilterOutputStream
      Parameters:
      b - the byte to be written.
      Throws:
      IOException - if an I/O error occurs.

    • write

      public void write(byte[] aBuf, int nOfs, int nLen) throws IOException
      Writes len bytes from the specified byte array starting at offset off to this buffered output stream.

      Ordinarily this method stores bytes from the given array into this stream's buffer, flushing the buffer to the underlying output stream as needed. If the requested length is at least as large as this stream's buffer, however, then this method will flush the buffer and write the bytes directly to the underlying output stream. Thus redundant BufferedOutputStreams will not copy data unnecessarily.

      Overrides:
      write in class WrappedOutputStream
      Parameters:
      aBuf - the data.
      nOfs - the start offset in the data.
      nLen - the number of bytes to write.
      Throws:
      IOException - if an I/O error occurs.

    • flush

      public void flush() throws IOException
      Flushes this buffered output stream. This forces any buffered output bytes to be written out to the underlying output stream.
      Specified by:
      flush in interface Flushable
      Overrides:
      flush in class FilterOutputStream
      Throws:
      IOException - if an I/O error occurs.