org.msgpack.core.buffer

Class ArrayBufferOutput

java.lang.Object

org.msgpack.core.buffer.ArrayBufferOutput

All Implemented Interfaces:

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

public class ArrayBufferOutput
extends java.lang.Object
implements MessageBufferOutput

MessageBufferOutput adapter that packs data into list of byte arrays.

Constructor Summary

Constructors

Constructor and Description
ArrayBufferOutput()
ArrayBufferOutput(int bufferSize)

Method Summary

Modifier and Type	Method and Description
void	add(byte[] buffer, int offset, int length) Writes an external payload data.
void	clear() Clears the internal buffers
void	close()
void	flush()
int	getSize()
MessageBuffer	next(int mimimumSize) Allocates the next buffer for writing message packed data.
java.util.List<MessageBuffer>	toBufferList()
byte[]	toByteArray()
MessageBuffer	toMessageBuffer()
void	write(byte[] buffer, int offset, int length) Writes an external payload data.
void	writeBuffer(int length) Flushes the previously allocated buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayBufferOutput

public ArrayBufferOutput()

ArrayBufferOutput

public ArrayBufferOutput(int bufferSize)

Method Detail

getSize

public int getSize()

toByteArray

public byte[] toByteArray()

toMessageBuffer

public MessageBuffer toMessageBuffer()

toBufferList

public java.util.List<MessageBuffer> toBufferList()

clear

public void clear()

Clears the internal buffers

next

public MessageBuffer next(int mimimumSize)

Description copied from interface: MessageBufferOutput

Allocates the next buffer for writing message packed data. If the previously allocated buffer is not flushed yet, this next method should discard it without writing it.

Specified by:

next in interface MessageBufferOutput

Parameters:

mimimumSize - the mimium required buffer size to allocate

Returns:

writeBuffer

public void writeBuffer(int length)

Description copied from interface: MessageBufferOutput

Flushes the previously allocated buffer. This method is not always called because next method also flushes previously allocated buffer. This method is called when write method is called or application wants to control the timing of flush.

Specified by:

writeBuffer in interface MessageBufferOutput

Parameters:

length - the size of buffer to flush

write

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

Description copied from interface: MessageBufferOutput

Writes an external payload data. This method should follow semantics of OutputStream.

Specified by:

write in interface MessageBufferOutput

Parameters:

buffer - the data to write

offset - the start offset in the data

length - the number of bytes to write

add

public void add(byte[] buffer,
                int offset,
                int length)

Description copied from interface: MessageBufferOutput

Writes an external payload data. This buffer is given - this MessageBufferOutput owns the buffer and may modify contents of the buffer. Contents of this buffer won't be modified by the caller.

Specified by:

add in interface MessageBufferOutput

Parameters:

buffer - the data to add

offset - the start offset in the data

length - the number of bytes to add

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

flush

public void flush()

Specified by:

flush in interface java.io.Flushable