org.lsst.ccs.bus.messages

Class StatusCodec

java.lang.Object

org.lsst.ccs.bus.messages.StatusCodec

public class StatusCodec
extends Object

utilities to code/decode DataStatus_Deprecated.

TODO: this code is in a circular dependency with the KeyData class.

TODO! make this class package friendly It has to be public because there is a test in apptests that needs this. We need to move this test to java in this package.

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
static org.lsst.ccs.bus.messages.StatusCodec.ClassDescriptor	ENUM_DESCRIPTOR This decriptor is common to all enums.
static org.lsst.ccs.bus.messages.StatusCodec.ClassDescriptor	NULL_DESCRIPTOR This descriptor is used to describe data that will not be encoded (either with a key-value list or with a crystallized byte array).
static Class[]	WELL_KNOWN_TYPES predefined list of types where values won't be encoded either by "crystalizing" or with a list of key-value.

Constructor Summary

Constructors

Constructor and Description
StatusCodec()

Method Summary

Modifier and Type	Method and Description
static List<KeyData>	asSimpleKeyValueList(String keyName, Object data)
static Object	decode(Object value) Decodes an object.
static Object	encode(Object value) Encodes an object.

Methods inherited from class java.lang.Object

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

Field Detail

WELL_KNOWN_TYPES

public static final Class[] WELL_KNOWN_TYPES

predefined list of types where values won't be encoded either by "crystalizing" or with a list of key-value.

NULL_DESCRIPTOR

public static final org.lsst.ccs.bus.messages.StatusCodec.ClassDescriptor NULL_DESCRIPTOR

This descriptor is used to describe data that will not be encoded (either with a key-value list or with a crystallized byte array).

ENUM_DESCRIPTOR

public static final org.lsst.ccs.bus.messages.StatusCodec.ClassDescriptor ENUM_DESCRIPTOR

This decriptor is common to all enums. Enums will be encoded in a special way: the key-value list will have an empty key and a String value that represents the enums instance, the object will also be crystallized (this is necessary if the client side does not have the Enum class at hand).

Constructor Detail

StatusCodec

public StatusCodec()

Method Detail

encode

public static Object encode(Object value)
                     throws IOException

Encodes an object. May build a list of key-value pairs and/or a crystallized value of this object if it is not of a "well known type".

Parameters:

value -

Returns:

the argument if it is of a "well known type" or a CodedData object

Throws:

IOException

decode

public static Object decode(Object value)
                     throws Exception

Decodes an object. If the value is of a "well-known type" it is returned if it is CodedData it is either deserialized from a crystallized state or rebuilt from the list of key-value pairs

Parameters:

value -

Returns:

Throws:

Exception

asSimpleKeyValueList

public static List<KeyData> asSimpleKeyValueList(String keyName,
                                                 Object data)

Parameters:

keyName -

data -

Returns: