org.msgpack.core

Class MessagePack.PackerConfig

java.lang.Object

org.msgpack.core.MessagePack.PackerConfig

All Implemented Interfaces:

java.lang.Cloneable

Enclosing class:

MessagePack

public static class MessagePack.PackerConfig
extends java.lang.Object
implements java.lang.Cloneable

MessagePacker configuration.

Constructor Summary

Constructors

Constructor and Description
PackerConfig()

Method Summary

Modifier and Type	Method and Description
MessagePack.PackerConfig	clone()
boolean	equals(java.lang.Object obj)
int	getBufferFlushThreshold()
int	getBufferSize()
int	getSmallStringOptimizationThreshold()
int	hashCode()
boolean	isStr8FormatSupport()
MessageBufferPacker	newBufferPacker() Create a packer for storing packed data into a byte array
MessagePacker	newPacker(MessageBufferOutput out) Create a packer that outputs the packed data to a given output
MessagePacker	newPacker(java.io.OutputStream out) Create a packer that outputs the packed data to a given output stream
MessagePacker	newPacker(java.nio.channels.WritableByteChannel channel) Create a packer that outputs the packed data to a given output channel
MessagePack.PackerConfig	withBufferFlushThreshold(int bytes) When the next payload size exceeds this threshold, MessagePacker will call MessageBufferOutput.flush() before packing the data (default: 8192).
MessagePack.PackerConfig	withBufferSize(int bytes) When a packer is created with newPacker(OutputStream) or newPacker(WritableByteChannel), the stream will be buffered with this size of buffer (default: 8192).
MessagePack.PackerConfig	withSmallStringOptimizationThreshold(int bytes) Use String.getBytes() for converting Java Strings that are smaller than this threshold into UTF8.
MessagePack.PackerConfig	withStr8FormatSupport(boolean str8FormatSupport) Disable str8 format when needed backward compatibility between different msgpack serializer versions.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PackerConfig

public PackerConfig()

Method Detail

clone

public MessagePack.PackerConfig clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

newPacker

public MessagePacker newPacker(MessageBufferOutput out)

Create a packer that outputs the packed data to a given output

Parameters:

out -

Returns:

newPacker

public MessagePacker newPacker(java.io.OutputStream out)

Create a packer that outputs the packed data to a given output stream

Parameters:

out -

Returns:

newPacker

public MessagePacker newPacker(java.nio.channels.WritableByteChannel channel)

Create a packer that outputs the packed data to a given output channel

Parameters:

channel -

Returns:

newBufferPacker

public MessageBufferPacker newBufferPacker()

Create a packer for storing packed data into a byte array

Returns:

withSmallStringOptimizationThreshold

public MessagePack.PackerConfig withSmallStringOptimizationThreshold(int bytes)

Use String.getBytes() for converting Java Strings that are smaller than this threshold into UTF8. Note that this parameter is subject to change.

getSmallStringOptimizationThreshold

public int getSmallStringOptimizationThreshold()

withBufferFlushThreshold

public MessagePack.PackerConfig withBufferFlushThreshold(int bytes)

When the next payload size exceeds this threshold, MessagePacker will call MessageBufferOutput.flush() before packing the data (default: 8192).

getBufferFlushThreshold

public int getBufferFlushThreshold()

withBufferSize

public MessagePack.PackerConfig withBufferSize(int bytes)

When a packer is created with newPacker(OutputStream) or newPacker(WritableByteChannel), the stream will be buffered with this size of buffer (default: 8192).

getBufferSize

public int getBufferSize()

withStr8FormatSupport

public MessagePack.PackerConfig withStr8FormatSupport(boolean str8FormatSupport)

Disable str8 format when needed backward compatibility between different msgpack serializer versions. default true (str8 supported enabled)

isStr8FormatSupport

public boolean isStr8FormatSupport()