org.spf4j.io

Class ByteArrayBuilder

java.lang.Object

java.io.OutputStream

org.spf4j.io.ByteArrayBuilder

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@CleanupObligation
public final class ByteArrayBuilder
extends OutputStream

Utility class to avoid replicating byte arrays for no good reason.

Author:

zoly

Constructor Summary

Constructors

Constructor and Description
ByteArrayBuilder()
ByteArrayBuilder(int size)
ByteArrayBuilder(int size, SizedRecyclingSupplier<byte[]> arraySupplier) Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Summary

Modifier and Type	Method and Description
void	close() Closing a ByteArrayOutputStream will likely recycle the underlying buffer.
byte[]	getBuffer()
void	readFrom(InputStream in)
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.
void	resetCountTo(int pos)
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(Charset charset)
void	write(byte[] b)
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.OutputStream

flush

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayBuilder

public ByteArrayBuilder()

ByteArrayBuilder

public ByteArrayBuilder(int size)

ByteArrayBuilder

public ByteArrayBuilder(int size,
                        @Nullable
                        SizedRecyclingSupplier<byte[]> arraySupplier)

Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Parameters:

size - the initial size.

Throws:

IllegalArgumentException - if size is negative.

Method Detail

getBuffer

public byte[] getBuffer()

write

public void write(byte[] b)

Overrides:

write in class OutputStream

write

public void write(int b)

Writes the specified byte to this byte array output stream.

Specified by:

write in class OutputStream

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 OutputStream

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).

Parameters:

out - the output stream to which to write the data.

Throws:

IOException - if an I/O error occurs.

readFrom

public void readFrom(InputStream in)
              throws IOException

Throws:

IOException

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.

See Also:

ByteArrayInputStream.count

resetCountTo

public void resetCountTo(int pos)

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.

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.

Returns:

the value of the count field, which is the number of valid bytes in this output stream.

See Also:

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 Object

Returns:

String decoded from the buffer's contents.

toString

public String toString(Charset charset)

close

@DischargesObligation
public void close()

Closing a ByteArrayOutputStream will likely recycle the underlying buffer. use of the builder after close is not advised

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream