com.devexperts.io

Class ByteArrayOutput

java.lang.Object

java.io.OutputStream

com.devexperts.io.BufferedOutput

com.devexperts.io.ByteArrayOutput

All Implemented Interfaces:

Closeable, DataOutput, Flushable, ObjectOutput, AutoCloseable

public class ByteArrayOutput
extends BufferedOutput

An implementation of BufferedOutput using single byte array buffer. Note, that most of the time, you need to use ChunkedOutput for better efficiency.

Field Summary

Fields inherited from class com.devexperts.io.BufferedOutput

buffer, EMPTY_BYTE_ARRAY, limit, position, totalPositionBase

Constructor Summary

Constructors

Constructor and Description
ByteArrayOutput() Creates a new byte array output without pre-allocated buffer.
ByteArrayOutput(byte[] buffer) Creates a new byte array output with the specified buffer.
ByteArrayOutput(int size) Creates a new byte array output with the specified buffer capacity.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this buffer.
void	ensureCapacity(int requiredCapacity) Ensures that the byte array used for buffering has at least the specified capacity.
byte[]	getBuffer() Returns byte array used for buffering.
int	getLimit() Returns limit.
int	getPosition() Returns position.
protected void	needSpace() This method is invoked when output methods need more space to write data.
void	setBuffer(byte[] newBuffer) Sets specified byte array to be used for buffering.
void	setLimit(int newLimit) Sets limit as specified.
void	setPosition(int newPosition) Sets position as specified.
byte[]	toByteArray() Returns a full copy of byte array buffer from zero to the position.
String	toString() Converts the buffer's content from zero to the position into a string, translating bytes into characters according to the platform's default character encoding.
void	write(byte[] b, int off, int len)

Methods inherited from class com.devexperts.io.BufferedOutput

checkEOB, totalPosition, write, write, writeAllFromChunkList, writeBoolean, writeByte, writeByteArray, writeBytes, writeChar, writeChars, writeCompactInt, writeCompactLong, writeDouble, writeFloat, writeFromByteBuffer, writeFromChunk, writeFromDataInput, writeFromInputStream, writeInt, writeLong, writeMarshalled, writeObject, writeShort, writeUTF, writeUTFChar, writeUTFString

Methods inherited from class java.io.OutputStream

close, flush

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.ObjectOutput

close, flush

Constructor Detail

ByteArrayOutput

public ByteArrayOutput()

Creates a new byte array output without pre-allocated buffer.

ByteArrayOutput

public ByteArrayOutput(int size)

Creates a new byte array output with the specified buffer capacity.

Parameters:

size - the initial buffer size

Throws:

IllegalArgumentException - if size is negative

ByteArrayOutput

public ByteArrayOutput(byte[] buffer)

Creates a new byte array output with the specified buffer.

Parameters:

buffer - the buffer.

Throws:

NullPointerException - if the buffer is null.

Method Detail

needSpace

protected final void needSpace()
                        throws IOException

This method is invoked when output methods need more space to write data. This method must ensure that expression (position < limit) is true or throw an exception.

This implementation is final and invokes ensureCapacity(position + 1). Classes that extend ByteArrayOutput shall override ensureCapacity(int) to customize their buffer allocation strategy.

Specified by:

needSpace in class BufferedOutput

Throws:

IOException - if buffer is already too big

getBuffer

public byte[] getBuffer()

Returns byte array used for buffering. Never returns null.

setBuffer

public void setBuffer(byte[] newBuffer)

Sets specified byte array to be used for buffering. Null is treated as empty array. The position is set to zero, the limit is set to the capacity of new buffer.

getPosition

public int getPosition()

Returns position.

setPosition

public void setPosition(int newPosition)

Sets position as specified.

Throws:

IllegalArgumentException - if the new position is negative or is larger than the limit

getLimit

public int getLimit()

Returns limit.

setLimit

public void setLimit(int newLimit)

Sets limit as specified. If the position is larger than the new limit then it is set to the new limit.

Throws:

IllegalArgumentException - if the new limit is negative or is larger than the capacity

clear

public void clear()

Clears this buffer. The position is set to zero, the limit is set to the capacity. The totalPosition is reset to 0.

write

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

This implementation also ensures that buffer has an appropriate capacity with at most one reallocation of the underlying array.

This implementation allocates an internal buffer at the size that is equal to the number of written bytes at the first invocation of this method. This ensures that if all data that is written into this byte array output is a result of single invocation of this write method, then the underlying buffer has an appropriate size. This property is used by Marshalled.getBytes() method to avoid extra copying of bytes.

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class BufferedOutput

Throws:

IOException

ensureCapacity

public void ensureCapacity(int requiredCapacity)

Ensures that the byte array used for buffering has at least the specified capacity. This method reallocates buffer if needed and copies content of old buffer into new one. This method also sets the limit to the capacity.

toByteArray

public byte[] toByteArray()

Returns a full copy of byte array buffer from zero to the position.

toString

public String toString()

Converts the buffer's content from zero to the position into a string, translating bytes into characters according to the platform's default character encoding.

Overrides:

toString in class Object