org.opendaylight.ocpjava.protocol.api.extensibility

Interface SerializerRegistry

public interface SerializerRegistry

Stores and handles serializers
K - MessageTypeKey parameter type,
S - returned serializer type

Author:

Marko Lai

Method Summary

Modifier and Type	Method and Description
<K,S extends OCPGeneralSerializer> S	getSerializer(MessageTypeKey<K> msgTypeKey)
void	init() Serializer registry provisioning
<K> void	registerSerializer(MessageTypeKey<K> key, OCPGeneralSerializer serializer) Registers serializer Throws IllegalStateException when there is a serializer already registered under given key.
<K> boolean	unregisterSerializer(MessageTypeKey<K> key) Unregisters serializer

Method Detail

init

void init()

Serializer registry provisioning

getSerializer

<K,S extends OCPGeneralSerializer> S getSerializer(MessageTypeKey<K> msgTypeKey)

Parameters:

msgTypeKey - lookup key

Returns:

serializer or NullPointerException if no serializer was found

registerSerializer

<K> void registerSerializer(MessageTypeKey<K> key,
                            OCPGeneralSerializer serializer)

Registers serializer Throws IllegalStateException when there is a serializer already registered under given key. If the serializer implements SerializerRegistryInjector interface, the serializer is injected with SerializerRegistry instance.

Parameters:

key - used for serializer lookup

serializer - serializer implementation

unregisterSerializer

<K> boolean unregisterSerializer(MessageTypeKey<K> key)

Unregisters serializer

Parameters:

key - used for serializer lookup

Returns:

true if serializer was removed, false if no serializer was found under specified key