org.msgpack.core

Class MessagePack.UnpackerConfig

java.lang.Object

org.msgpack.core.MessagePack.UnpackerConfig

All Implemented Interfaces:

java.lang.Cloneable

Enclosing class:

MessagePack

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

MessageUnpacker configuration.

Constructor Summary

Constructors

Constructor and Description
UnpackerConfig()

Method Summary

Modifier and Type	Method and Description
MessagePack.UnpackerConfig	clone()
boolean	equals(java.lang.Object obj)
java.nio.charset.CodingErrorAction	getActionOnMalformedString()
java.nio.charset.CodingErrorAction	getActionOnUnmappableString()
boolean	getAllowReadingBinaryAsString()
boolean	getAllowReadingStringAsBinary()
int	getBufferSize()
int	getStringDecoderBufferSize()
int	getStringSizeLimit()
MessageUnpacker	newUnpacker(byte[] contents) Create an unpacker that reads the data from a given byte array
MessageUnpacker	newUnpacker(byte[] contents, int offset, int length) Create an unpacker that reads the data from a given byte array [offset, offset+size)
MessageUnpacker	newUnpacker(java.io.InputStream in) Create an unpacker that reads the data from a given input stream
MessageUnpacker	newUnpacker(MessageBufferInput in) Create an unpacker that reads the data from a given input
MessageUnpacker	newUnpacker(java.nio.channels.ReadableByteChannel channel) Create an unpacker that reads the data from a given channel
MessagePack.UnpackerConfig	withActionOnMalformedString(java.nio.charset.CodingErrorAction action) Action when encountered a malformed input (default: REPLACE)
MessagePack.UnpackerConfig	withActionOnUnmappableString(java.nio.charset.CodingErrorAction action) Action when an unmappable character is found (default: REPLACE)
MessagePack.UnpackerConfig	withAllowReadingBinaryAsString(boolean enable) Allow unpackString and unpackRawStringHeader and unpackString to read bin format family (default: true)
MessagePack.UnpackerConfig	withAllowReadingStringAsBinary(boolean enable) Allow unpackBinaryHeader to read str format family (default: true)
MessagePack.UnpackerConfig	withBufferSize(int bytes) When a packer is created with newUnpacker(OutputStream) or newUnpacker(WritableByteChannel), the stream will be buffered with this size of buffer (default: 8192).
MessagePack.UnpackerConfig	withStringDecoderBufferSize(int bytes)
MessagePack.UnpackerConfig	withStringSizeLimit(int bytes) unpackString size limit (default: Integer.MAX_VALUE).

Methods inherited from class java.lang.Object

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

Constructor Detail

UnpackerConfig

public UnpackerConfig()

Method Detail

clone

public MessagePack.UnpackerConfig clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

newUnpacker

public MessageUnpacker newUnpacker(MessageBufferInput in)

Create an unpacker that reads the data from a given input

Parameters:

in -

Returns:

newUnpacker

public MessageUnpacker newUnpacker(java.io.InputStream in)

Create an unpacker that reads the data from a given input stream

Parameters:

in -

Returns:

newUnpacker

public MessageUnpacker newUnpacker(java.nio.channels.ReadableByteChannel channel)

Create an unpacker that reads the data from a given channel

Parameters:

channel -

Returns:

newUnpacker

public MessageUnpacker newUnpacker(byte[] contents)

Create an unpacker that reads the data from a given byte array

Parameters:

contents -

Returns:

newUnpacker

public MessageUnpacker newUnpacker(byte[] contents,
                                   int offset,
                                   int length)

Create an unpacker that reads the data from a given byte array [offset, offset+size)

Parameters:

contents -

Returns:

withAllowReadingStringAsBinary

public MessagePack.UnpackerConfig withAllowReadingStringAsBinary(boolean enable)

Allow unpackBinaryHeader to read str format family (default: true)

getAllowReadingStringAsBinary

public boolean getAllowReadingStringAsBinary()

withAllowReadingBinaryAsString

public MessagePack.UnpackerConfig withAllowReadingBinaryAsString(boolean enable)

Allow unpackString and unpackRawStringHeader and unpackString to read bin format family (default: true)

getAllowReadingBinaryAsString

public boolean getAllowReadingBinaryAsString()

withActionOnMalformedString

public MessagePack.UnpackerConfig withActionOnMalformedString(java.nio.charset.CodingErrorAction action)

Action when encountered a malformed input (default: REPLACE)

getActionOnMalformedString

public java.nio.charset.CodingErrorAction getActionOnMalformedString()

withActionOnUnmappableString

public MessagePack.UnpackerConfig withActionOnUnmappableString(java.nio.charset.CodingErrorAction action)

Action when an unmappable character is found (default: REPLACE)

getActionOnUnmappableString

public java.nio.charset.CodingErrorAction getActionOnUnmappableString()

withStringSizeLimit

public MessagePack.UnpackerConfig withStringSizeLimit(int bytes)

unpackString size limit (default: Integer.MAX_VALUE).

getStringSizeLimit

public int getStringSizeLimit()

withStringDecoderBufferSize

public MessagePack.UnpackerConfig withStringDecoderBufferSize(int bytes)

getStringDecoderBufferSize

public int getStringDecoderBufferSize()

withBufferSize

public MessagePack.UnpackerConfig withBufferSize(int bytes)

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

getBufferSize

public int getBufferSize()