Package com.prineside.tdi2.utils

Class LimitedBAOS

java.lang.Object
java.io.OutputStream
java.io.ByteArrayOutputStream
com.prineside.tdi2.utils.LimitedBAOS
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable
public final class LimitedBAOS extends ByteArrayOutputStream
ByteArrayOutputStream with size limit May corrupt strings at the beginning

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closing a ByteArrayOutputStream has no effect.
    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.
    String
    toString()
    Converts the buffer's contents into a string decoding bytes using the platform's default character set.
    String
    toString(int hibyte)
    Deprecated.
    This method does not properly convert bytes into characters.
    String
    toString(String charsetName)
    Converts the buffer's contents into a string by decoding the bytes using the named charset.
    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(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

    toString, writeBytes

    Methods inherited from class java.io.OutputStream

    flush, nullOutputStream, write

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LimitedBAOS

      public LimitedBAOS(int size, int maxSize, float cleanupMultiplier)
      Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
      Parameters:
      size - the initial size.
      maxSize - maximum size of BAOS. If buffer exceeds this size, cleanupMultiplier% of the oldest bytes will be removed from it
      cleanupMultiplier - (0..1) how many bytes to free when the buffer exceeds its max size
      Throws:
      IllegalArgumentException - if size is negative.

  • Method Details

    • write

      public void write(int b)
      Writes the specified byte to this byte array output stream.
      Overrides:
      write in class 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 ByteArrayOutputStream
      Parameters:
      b - the data.
      off - the start offset in the data.
      len - the number of bytes to write.

    • writeTo

      public void writeTo(OutputStream out) throws 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 ByteArrayOutputStream
      Parameters:
      out - the output stream to which to write the data.
      Throws:
      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. java.io.ByteArrayInputStream#count
      Overrides:
      reset in class ByteArrayOutputStream

    • 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 ByteArrayOutputStream
      Returns:
      the current contents of this output stream, as a byte array.
      See Also:

    • size

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

    • toString

      public String toString()
      Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new String is a function of the character set, and hence may not be equal to the size of the buffer.

      This method always replaces malformed-input and unmappable-character sequences with the default replacement string for the platform's default character set. The CharsetDecoder class should be used when more control over the decoding process is required.

      Overrides:
      toString in class ByteArrayOutputStream
      Returns:
      String decoded from the buffer's contents.
      Since:
      JDK1.1

    • toString

      public String toString(String charsetName) throws UnsupportedEncodingException
      Converts the buffer's contents into a string by decoding the bytes using the named charset. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.

      This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The CharsetDecoder class should be used when more control over the decoding process is required.

      Overrides:
      toString in class ByteArrayOutputStream
      Parameters:
      charsetName - the name of a supported charset
      Returns:
      String decoded from the buffer's contents.
      Throws:
      UnsupportedEncodingException - If the named charset is not supported
      Since:
      JDK1.1

    • toString

      @Deprecated public String toString(int hibyte)
      Deprecated.
      This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(String enc) method, which takes an encoding-name argument, or the toString() method, which uses the platform's default character encoding.
      Creates a newly allocated string. Its size is the current size of the output stream and the valid contents of the buffer have been copied into it. Each character c in the resulting string is constructed from the corresponding element b in the byte array such that: 
           c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))
      Overrides:
      toString in class ByteArrayOutputStream
      Parameters:
      hibyte - the high byte of each resulting Unicode character.
      Returns:
      the current contents of the output stream, as a string.
      See Also:

    • close

      public void close() throws 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 AutoCloseable
      Specified by:
      close in interface Closeable
      Overrides:
      close in class ByteArrayOutputStream
      Throws:
      IOException