rsb.converter

Interface Converter<WireType>

Type Parameters:

WireType - the wire format to serialize on

All Known Implementing Classes:

BoolConverter, DoubleConverter, EventIdConverter, FloatConverter, IntegerConverter, LongConverter, NullConverter, ProtocolBufferConverter, ScopeConverter, StringConverter

public interface Converter<WireType>

This class represents a converter interface for a wire format T. Implementations may support one or more domain types for (de-)serialization to T and back to a specific object type referenced through the typeinfo parameter.

Author:

swrede

Method Summary

Methods

Modifier and Type	Method and Description
UserData	deserialize(String wireSchema, WireType buffer) Deserializes the data from the wire.
ConverterSignature	getSignature() Get signature for this converter.
WireContents<WireType>	serialize(Class<?> typeInfo, Object obj) Serializes user data to a wire representation.

Method Detail

serialize

WireContents<WireType> serialize(Class<?> typeInfo,
                               Object obj)
                                 throws ConversionException

Serializes user data to a wire representation.

Parameters:

typeInfo - Java class describing the type of the data to serialize

obj - data to serialize

Returns:

serialized data and generated wire schema

Throws:

ConversionException - error converting the data

deserialize

UserData deserialize(String wireSchema,
                   WireType buffer)
                     throws ConversionException

Deserializes the data from the wire.

Parameters:

wireSchema - wire schema of the serialized data

buffer - serialized data

Returns:

deserialized data

Throws:

ConversionException - error deserializing from the wire

getSignature

ConverterSignature getSignature()

Get signature for this converter.

Returns:

the @See ConverterSignature of this converter instance