Package org.apache.wicket.util.io

Class ByteArrayOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class ByteArrayOutputStream
extends java.io.OutputStream
    This class implements an output stream in which the data is written into a byte array. The buffer automatically grows as data is written to it.

    The data can be retrieved using toByteArray() and toString().

    Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

    This is an alternative implementation of the java.io.ByteArrayOutputStream class. The original implementation only allocates 32 bytes at the beginning. As this class is designed for heavy duty it starts at 1024 bytes. In contrast to the original it doesn't reallocate the whole memory block but allocates additional buffers. This way no buffers need to be garbage collected and the contents don't have to be copied to the new buffer. This class is designed to behave exactly like the original. The only exception is the deprecated toString(int) method that has been ignored.

    Version:
    $Id$
    Author:
    Jeremias Maerki

    • Constructor Summary

      Constructors 
      Constructor Description
      ByteArrayOutputStream()
      Creates a new byte array output stream.
      ByteArrayOutputStream​(int size)
      Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closing a ByteArrayOutputStream has no effect.
      void reset()  
      int size()
      Gets the size.
      byte[] toByteArray()
      Writes to a byte array.
      java.lang.String toString()  
      java.lang.String toString​(java.lang.String enc)
      This as a string using the provided encoding.
      void write​(byte[] b, int off, int len)  
      void write​(int b)
      Calls the write(byte[]) method.
      void writeTo​(java.io.OutputStream out)
      Write to the given output stream.

      • 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

      • ByteArrayOutputStream

        public ByteArrayOutputStream()
        Creates a new byte array output stream. The buffer capacity is initially 1024 bytes, though its size increases if necessary.

      • ByteArrayOutputStream

        public ByteArrayOutputStream​(int size)
        Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
        Parameters:
        size - the initial size.
        Throws:
        java.lang.IllegalArgumentException - if size is negative.

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.OutputStream
        Throws:
        java.io.IOException - in case an I/O error occurs

      • reset

        public void reset()
        See Also:
        ByteArrayOutputStream.reset()

      • size

        public int size()
        Gets the size.
        Returns:
        the size

      • toByteArray

        public byte[] toByteArray()
        Writes to a byte array.
        Returns:
        this is a byte array

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()

      • toString

        public java.lang.String toString​(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException
        This as a string using the provided encoding.
        Parameters:
        enc - the encoding to use
        Returns:
        This as a string using the provided encoding
        Throws:
        java.io.UnsupportedEncodingException

      • write

        public void write​(byte[] b,
                  int off,
                  int len)
        Overrides:
        write in class java.io.OutputStream
        See Also:
        OutputStream.write(byte[], int, int)

      • write

        public void write​(int b)
        Calls the write(byte[]) method.
        Specified by:
        write in class java.io.OutputStream
        See Also:
        OutputStream.write(int)

      • writeTo

        public void writeTo​(java.io.OutputStream out)
             throws java.io.IOException
        Write to the given output stream.
        Parameters:
        out - the output stream to write to
        Throws:
        java.io.IOException
        See Also:
        ByteArrayOutputStream.writeTo(OutputStream)