public class ArrayBufferOutput extends java.lang.Object implements MessageBufferOutput
This class allocates a new buffer instead of resizing the buffer when data doesn't fit in the initial capacity. This is faster than ByteArrayOutputStream especially when size of written bytes is large because resizing a buffer usually needs to copy contents of the buffer.
| Constructor and Description |
|---|
ArrayBufferOutput() |
ArrayBufferOutput(int bufferSize) |
| Modifier and Type | Method and Description |
|---|---|
void |
add(byte[] buffer,
int offset,
int length)
Writes an external payload data.
|
void |
clear()
Clears the written data.
|
void |
close() |
void |
flush() |
int |
getSize()
Gets the size of the written data.
|
MessageBuffer |
next(int minimumSize)
Allocates the next buffer to write.
|
java.util.List<MessageBuffer> |
toBufferList()
Returns the written data as a list of MessageBuffer.
|
byte[] |
toByteArray()
Gets a copy of the written data as a byte array.
|
MessageBuffer |
toMessageBuffer()
Gets the written data as a MessageBuffer.
|
void |
write(byte[] buffer,
int offset,
int length)
Writes an external payload data.
|
void |
writeBuffer(int length)
Writes the previously allocated buffer.
|
public ArrayBufferOutput()
public ArrayBufferOutput(int bufferSize)
public int getSize()
public byte[] toByteArray()
If your application needs better performance and smaller memory consumption, you may prefer
toMessageBuffer() or toBufferList() to avoid copying.
public MessageBuffer toMessageBuffer()
Unlike toByteArray(), this method omits copy of the contents if size of the written data is smaller
than a single buffer capacity.
public java.util.List<MessageBuffer> toBufferList()
Unlike toByteArray() or toMessageBuffer(), this is the fastest method that doesn't
copy contents in any cases.
public void clear()
public MessageBuffer next(int minimumSize)
MessageBufferOutputThis method should return a MessageBuffer instance that has specified size of capacity at least.
When this method is called twice, the previously returned buffer is no longer used. This method may be called
twice without call of MessageBufferOutput.writeBuffer(int) in between. In this case, the buffer should be
discarded without flushing it to the output.
next in interface MessageBufferOutputminimumSize - the mimium required buffer size to allocatepublic void writeBuffer(int length)
MessageBufferOutput
This method should write the buffer previously returned from MessageBufferOutput.next(int) method until specified number of
bytes. Once the buffer is written, the buffer is no longer used.
This method is not always called for each MessageBufferOutput.next(int) call. In this case, the buffer should be discarded
without flushing it to the output when the next MessageBufferOutput.next(int) is called.
writeBuffer in interface MessageBufferOutputlength - the number of bytes to writepublic void write(byte[] buffer,
int offset,
int length)
MessageBufferOutputwrite in interface MessageBufferOutputbuffer - the data to writeoffset - the start offset in the datalength - the number of bytes to writepublic void add(byte[] buffer,
int offset,
int length)
MessageBufferOutput
Unlike MessageBufferOutput.write(byte[], int, int) method, the buffer is given - this MessageBufferOutput implementation
gets ownership of the buffer and may modify contents of the buffer. Contents of this buffer won't be modified
by the caller.
add in interface MessageBufferOutputbuffer - the data to addoffset - the start offset in the datalength - the number of bytes to addpublic void close()
close in interface java.io.Closeableclose in interface java.lang.AutoCloseablepublic void flush()
flush in interface java.io.Flushable