Converter
=========

.. java:package:: rsb.converter
   :noindex:

.. java:type:: 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
   :param <WireType>: the wire format to serialize on

Methods
-------
deserialize
^^^^^^^^^^^

.. java:method:: @SuppressWarnings  UserData deserialize(String wireSchema, WireType buffer) throws ConversionException
   :outertype: Converter

   Deserializes the data from the wire.

   :param wireSchema: wire schema of the serialized data
   :param buffer: serialized data
   :throws ConversionException: error deserializing from the wire
   :return: deserialized data

getSignature
^^^^^^^^^^^^

.. java:method::  ConverterSignature getSignature()
   :outertype: Converter

   Get signature for this converter.

   :return: the @See ConverterSignature of this converter instance

serialize
^^^^^^^^^

.. java:method::  WireContents<WireType> serialize(Class<?> typeInfo, Object obj) throws ConversionException
   :outertype: Converter

   Serializes user data to a wire representation.

   :param typeInfo: Java class describing the type of the data to serialize
   :param obj: data to serialize
   :throws ConversionException: error converting the data
   :return: serialized data and generated wire schema