Package net.rubyeye.xmemcached.transcoders

Class BaseSerializingTranscoder

java.lang.Object

net.rubyeye.xmemcached.transcoders.BaseSerializingTranscoder

Direct Known Subclasses:

PrimitiveTypeTranscoder, SerializingTranscoder, WhalinTranscoder, WhalinV1Transcoder

public abstract class BaseSerializingTranscoder
extends Object

Base class for any transcoders that may want to work with serialized or compressed data.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	charset
protected int	compressionThreshold
protected CompressionMode	compressMode
static String	DEFAULT_CHARSET
static int	DEFAULT_COMPRESSION_THRESHOLD	Default compression threshold value.
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
BaseSerializingTranscoder()

Method Summary

Modifier and Type	Method	Description
byte[]	compress(byte[] in)	Compress the given array of bytes.
protected String	decodeString(byte[] data)	Decode the string with the current character set.
protected byte[]	decompress(byte[] in)	Decompress the given array of bytes.
protected Object	deserialize(byte[] in)	Get the object represented by the given serialized bytes.
protected byte[]	encodeString(String in)	Encode a string into the current character set.
CompressionMode	getCompressMode()
protected byte[]	serialize(Object o)	Get the bytes representing the given serialized object.
void	setCharset(String to)	Set the character set for string value transcoding (defaults to UTF-8).
void	setCompressionMode(CompressionMode compressMode)
void	setCompressionThreshold(int to)	Set the compression threshold to the given number of bytes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPRESSION_THRESHOLD

public static final int DEFAULT_COMPRESSION_THRESHOLD

Default compression threshold value.

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

compressionThreshold

protected int compressionThreshold

charset

protected String charset

compressMode

protected CompressionMode compressMode

log

protected static final org.slf4j.Logger log

Constructor Detail

BaseSerializingTranscoder

public BaseSerializingTranscoder()

Method Detail

setCompressionThreshold

public void setCompressionThreshold(int to)

Set the compression threshold to the given number of bytes. This transcoder will attempt to compress any data being stored that's larger than this.

Parameters:

to - the number of bytes

getCompressMode

public CompressionMode getCompressMode()

setCompressionMode

public void setCompressionMode(CompressionMode compressMode)

setCharset

public void setCharset(String to)

Set the character set for string value transcoding (defaults to UTF-8).

serialize

protected byte[] serialize(Object o)

Get the bytes representing the given serialized object.

deserialize

protected Object deserialize(byte[] in)

Get the object represented by the given serialized bytes.

compress

public final byte[] compress(byte[] in)

Compress the given array of bytes.

decompress

protected byte[] decompress(byte[] in)

Decompress the given array of bytes.

Returns:

null if the bytes cannot be decompressed

decodeString

protected String decodeString(byte[] data)

Decode the string with the current character set.

encodeString

protected byte[] encodeString(String in)

Encode a string into the current character set.