org.msgpack.core.buffer

Class OutputStreamBufferOutput

java.lang.Object

org.msgpack.core.buffer.OutputStreamBufferOutput

All Implemented Interfaces:

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

public class OutputStreamBufferOutput
extends java.lang.Object
implements MessageBufferOutput

MessageBufferOutput adapter for OutputStream.

Constructor Summary

Constructors

Constructor and Description
OutputStreamBufferOutput(java.io.OutputStream out)
OutputStreamBufferOutput(java.io.OutputStream out, int bufferSize)

Method Summary

Modifier and Type	Method and Description
void	add(byte[] buffer, int offset, int length) Writes an external payload data.
void	close()
void	flush()
MessageBuffer	next(int mimimumSize) Allocates the next buffer for writing message packed data.
java.io.OutputStream	reset(java.io.OutputStream out) Reset Stream.
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

OutputStreamBufferOutput

public OutputStreamBufferOutput(java.io.OutputStream out)

OutputStreamBufferOutput

public OutputStreamBufferOutput(java.io.OutputStream out,
                                int bufferSize)

Method Detail

reset

public java.io.OutputStream reset(java.io.OutputStream out)
                           throws java.io.IOException

Reset Stream. This method doesn't close the old stream.

Parameters:

out - new stream

Returns:

the old stream

Throws:

java.io.IOException

next

public MessageBuffer next(int mimimumSize)
                   throws java.io.IOException

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:

Throws:

java.io.IOException

writeBuffer

public void writeBuffer(int length)
                 throws java.io.IOException

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

Throws:

java.io.IOException

write

public void write(byte[] buffer,
                  int offset,
                  int length)
           throws java.io.IOException

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

Throws:

java.io.IOException

add

public void add(byte[] buffer,
                int offset,
                int length)
         throws java.io.IOException

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

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException