org.dmfs.httpclientinterfaces.requestutils

Class ByteArrayOutputStream

java.lang.Object

java.io.OutputStream

org.dmfs.httpclientinterfaces.requestutils.ByteArrayOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public final class ByteArrayOutputStream
extends java.io.OutputStream

An OutputStream that buffers all written content in byte arrays. In contrast to ByteArrayOutputStream, it allows to set a maximum buffer size, switching to a count-only mode when the maximum buffer size will be exceeded.

Author:

Marten Gajda

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_CHUNK_SIZE The default minimum chunk size.

Constructor Summary

Constructors

Constructor and Description
ByteArrayOutputStream() Creates an unlimited ByteArrayOutputStream using #MIN_CHUNK_SIZE as minimal chunk size.
ByteArrayOutputStream(int minChunkSize) Creates an unlimited ByteArrayOutputStream using the given minimal chunk size.
ByteArrayOutputStream(int minChunkSize, int bufferSizeLimit) Creates a ByteArrayOutputStream that's limited in size using the given minimal chunk size.

Method Summary

Modifier and Type	Method and Description
boolean	bufferOverflow() Returns whether there was a buffer overflow, i.e. the content written was larger than the maximum buffer size.
int	length() Get the overall length of the written content.
void	reset() Clear all buffers.
void	trim() Reduce the memory allocated by this object by freeing all unused chunks.
void	write(byte[] b, int off, int len)
void	write(int b)
void	writeTo(java.io.OutputStream out) Write the buffered content to the given OutputStream.

Methods inherited from class java.io.OutputStream

close, flush, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_CHUNK_SIZE

public static final int MIN_CHUNK_SIZE

The default minimum chunk size.

See Also:

Constant Field Values

Constructor Detail

ByteArrayOutputStream

public ByteArrayOutputStream()

Creates an unlimited ByteArrayOutputStream using #MIN_CHUNK_SIZE as minimal chunk size.

ByteArrayOutputStream

public ByteArrayOutputStream(int minChunkSize)

Creates an unlimited ByteArrayOutputStream using the given minimal chunk size.

Parameters:

minChunkSize - The minimal chunk size.

ByteArrayOutputStream

public ByteArrayOutputStream(int minChunkSize,
                             int bufferSizeLimit)

Creates a ByteArrayOutputStream that's limited in size using the given minimal chunk size. If the buffer size is exceeded this instance will stop buffering and only cound the number of bytes written.

Note that the actually used memory might be larger by the chunk size than the given buffer size.

Parameters:

minChunkSize - The minimal chunk size.

bufferSizeLimit - The maximum buffer size used by this ByteArrayOutputStream.

Method Detail

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Write the buffered content to the given OutputStream. Call bufferOverflow() before calling this to check if all written content was buffered or not.

Parameters:

out - The OutputStream to write to.

Throws:

java.io.IOException

{@link - IllegalStateException} if there was a buffer overflow and not all content was buffered.

reset

public void reset()

Clear all buffers.

trim

public void trim()

Reduce the memory allocated by this object by freeing all unused chunks.

length

public int length()

Get the overall length of the written content.

Returns:

The number of bytes written to this ByteArrayOutputStream.

bufferOverflow

public boolean bufferOverflow()

Returns whether there was a buffer overflow, i.e. the content written was larger than the maximum buffer size.

Returns:

true if there was a buffer overflow and not all content was buffered, false otherwise.