io.appulse.utils

Class BytesOutputStream

java.lang.Object

java.io.OutputStream

io.appulse.utils.BytesOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BytesOutputStream
extends OutputStream

This class implements an output stream in which the data is written into a Bytes. The buffer automatically grows as data is written to it. The data can be retrieved using toByteArray() and array().

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

Since:

1.17.0

Author:

Artem Labazin

Constructor Summary

Constructors

Constructor and Description
BytesOutputStream() Creates a new byte array output stream.
BytesOutputStream(Bytes bytes) The constructor wraps already existent Bytes.
BytesOutputStream(int size) 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
byte[]	array() Returns the byte array that backs this buffer.
void	close()
void	reset() Resets the 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[] bytes, int offset, int length)
void	write(int value)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesOutputStream

public BytesOutputStream()

Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.

BytesOutputStream

public BytesOutputStream(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:

IllegalArgumentException - if size is negative.

BytesOutputStream

public BytesOutputStream(Bytes bytes)

The constructor wraps already existent Bytes.

Parameters:

bytes - the bytes buffer to wraps.

Method Detail

write

public void write(int value)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes,
                  int offset,
                  int length)

Overrides:

write in class OutputStream

reset

public void reset()

Resets the 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.

size

public int size()

Returns the current size of the buffer.

Returns:

the number of valid bytes in this output stream.

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

array

public byte[] array()

Returns the byte array that backs this buffer.

Modifications to this buffer's content may cause the returned array's content to be modified, and vice versa.

Returns:

the array that backs this buffer

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream