org.jredis.ri.alphazero.support

Class DefaultCodec

java.lang.Object

org.jredis.ri.alphazero.support.DefaultCodec

public class DefaultCodec
extends java.lang.Object

Note that this is the one element of this package that is most likely to change drastically. It is provided, for now, as a helper for using JRedis. [TODO: document me!]

Since:

alpha.0

Version:

alpha.0, 04/02/09

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultCodec.Keys<K>

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	SUPPORTED_CHARSET
static java.lang.String	SUPPORTED_CHARSET_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultCodec()

Method Summary

Modifier and Type	Method and Description
static <T extends java.io.Serializable> T	decode(byte[] bytes) This helper method will assume that the byte[] provided are the serialized bytes obtainable for an instance of type T obtained from ObjectOutputStream and subsequently stored as a value for a Redis key (regardless of key type).
static <T extends java.io.Serializable> java.util.List<T>	decode(java.util.List<byte[]> byteList) This helper method will assume the List being presented is the list returned from a JRedis method such as JRedis#smembers(String), and that this list contains the encode(Serializable)ed bytes of the parametric type T.
static byte[]	encode(java.lang.String value)
static <T extends java.io.Serializable> byte[]	encode(T obj) This helper method will serialize the given serializable object of type T to a byte[], suitable for use as a value for a redis key, regardless of the key type.
static java.util.Map<java.lang.String,byte[]>	toDataDictionary(java.util.Map<byte[],byte[]> binaryMap)
static double	toDouble(byte[] bs)
static java.util.List<java.lang.Double>	toDouble(java.util.List<byte[]> bytearray)
static java.lang.Long	toLong(byte[] bytes) NOTE: Isn't this already in Convert.toLong(byte[])? TODO: get rid of this method This helper method will convert the byte[] to a Long.
static java.util.List<java.lang.Long>	toLong(java.util.List<byte[]> bytearray)
static java.lang.String	toStr(byte[] bytes)
static java.util.List<java.lang.String>	toStr(java.util.List<byte[]> bytearray) This helper method is mainly intended for use with a list of keys returned from Redis, given that it will use the UTF-8 Charset in decoding the byte array.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_CHARSET_NAME

public static final java.lang.String SUPPORTED_CHARSET_NAME

See Also:

Constant Field Values

SUPPORTED_CHARSET

public static final java.nio.charset.Charset SUPPORTED_CHARSET

Constructor Detail

DefaultCodec

public DefaultCodec()

Method Detail

toStr

public static final java.util.List<java.lang.String> toStr(java.util.List<byte[]> bytearray)

This helper method is mainly intended for use with a list of keys returned from Redis, given that it will use the UTF-8 Charset in decoding the byte array. Typical use would be to convert from the List output of JRedis.keys()

Parameters:

bytearray -

Returns:

toDataDictionary

public static final java.util.Map<java.lang.String,byte[]> toDataDictionary(java.util.Map<byte[],byte[]> binaryMap)

toStr

public static final java.lang.String toStr(byte[] bytes)

Parameters:

bytes -

Returns:

new String(byte[]) or null if bytes is null.

encode

public static final byte[] encode(java.lang.String value)

toLong

public static final java.lang.Long toLong(byte[] bytes)

NOTE: Isn't this already in Convert.toLong(byte[])? TODO: get rid of this method This helper method will convert the byte[] to a Long.

Parameters:

bytes -

Returns:

toLong

public static final java.util.List<java.lang.Long> toLong(java.util.List<byte[]> bytearray)

toDouble

public static double toDouble(byte[] bs)

Parameters:

bs - bytes of the ascii string representation of a double number. E.g. "2.002".getBytes()

Returns:

toDouble

public static final java.util.List<java.lang.Double> toDouble(java.util.List<byte[]> bytearray)

decode

public static final <T extends java.io.Serializable> java.util.List<T> decode(java.util.List<byte[]> byteList)

This helper method will assume the List being presented is the list returned from a JRedis method such as JRedis#smembers(String), and that this list contains the encode(Serializable)ed bytes of the parametric type T.

Specifically, this method will instantiate an ArrayList for type T, of equal size to the size of bytelist List. Then it will iterate over the byte list and for each byte[] list item call decode(byte[]).

Usage example:

 List  memberBytes = redis.smembers("my-object-set");
 List  members = decode (memberBytes);
 

Type Parameters:

T -

Parameters:

byteList -

Returns:

decode

public static final <T extends java.io.Serializable> T decode(byte[] bytes)

This helper method will assume that the byte[] provided are the serialized bytes obtainable for an instance of type T obtained from ObjectOutputStream and subsequently stored as a value for a Redis key (regardless of key type).

Specifically, this method will simply do:

 ObjectInputStream oin = new ObjectInputStream(new ByteArrayInputStream(bytes));
 t = (T) oin.readObject();
 

and returning the reference t, and throwing any exceptions encountered along the way.

This method is the decoding peer of encode(Serializable), and it is assumed (and certainly recommended) that you use these two methods in tandem.

Naturally, all caveats, rules, and considerations that generally apply to Serializable and the Object Serialization specification apply.

Type Parameters:

T -

Parameters:

bytes -

Returns:

the instance for T

encode

public static final <T extends java.io.Serializable> byte[] encode(T obj)

This helper method will serialize the given serializable object of type T to a byte[], suitable for use as a value for a redis key, regardless of the key type.

Type Parameters:

T -

Parameters:

obj -

Returns: