Class UnsafeByteArrayOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

    public class UnsafeByteArrayOutputStream
    extends java.io.ByteArrayOutputStream

    An unsynchronized implementation of ByteArrayOutputStream that will return the backing byte array if its length == size(). This avoids unneeded array copy where the BOS is simply being used to extract a byte array of known length from a 'serialized to stream' method.

    Unless the final length can be accurately predicted the only performance this will yield is due to unsynchronized methods.

    • Field Summary

      • Fields inherited from class java.io.ByteArrayOutputStream

        buf, count
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void reset()
      Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded.
      int size()
      Returns the current size of the buffer.
      byte[] toByteArray()
      Creates a newly allocated byte array.
      void write​(byte[] b, int off, int len)
      Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
      void write​(int b)
      Writes the specified byte to this byte array output stream.
      void writeTo​(java.io.OutputStream out)
      Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).
      • Methods inherited from class java.io.ByteArrayOutputStream

        close, toString, toString, toString, toString, writeBytes
      • Methods inherited from class java.io.OutputStream

        flush, nullOutputStream, write
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • UnsafeByteArrayOutputStream

        public UnsafeByteArrayOutputStream()
      • UnsafeByteArrayOutputStream

        public UnsafeByteArrayOutputStream​(int size)
    • Method Detail

      • write

        public void write​(int b)
        Writes the specified byte to this byte array output stream.
        Overrides:
        write in class java.io.ByteArrayOutputStream
        Parameters:
        b - the byte to be written.
      • write

        public void write​(byte[] b,
                          int off,
                          int len)
        Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
        Overrides:
        write in class java.io.ByteArrayOutputStream
        Parameters:
        b - the data.
        off - the start offset in the data.
        len - the number of bytes to write.
      • writeTo

        public void writeTo​(java.io.OutputStream out)
                     throws java.io.IOException
        Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).
        Overrides:
        writeTo in class java.io.ByteArrayOutputStream
        Parameters:
        out - the output stream to which to write the data.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • reset

        public void reset()
        Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.
        Overrides:
        reset in class java.io.ByteArrayOutputStream
        See Also:
        ByteArrayInputStream.count
      • toByteArray

        public byte[] toByteArray()
        Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
        Overrides:
        toByteArray in class java.io.ByteArrayOutputStream
        Returns:
        the current contents of this output stream, as a byte array.
        See Also:
        ByteArrayOutputStream.size()
      • size

        public int size()
        Returns the current size of the buffer.
        Overrides:
        size in class java.io.ByteArrayOutputStream
        Returns:
        the value of the count field, which is the number of valid bytes in this output stream.
        See Also:
        ByteArrayOutputStream.count