2 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.openflowjava.protocol.api.extensibility;
10 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
13 * Stores and handles serializers<br>
14 * K - {@link MessageTypeKey} parameter type,<br>
15 * S - returned serializer type
16 * @author michal.polkorab
18 public interface SerializerRegistry {
21 * Serializer registry provisioning
26 * @param <K> input key type
27 * @param <S> type of resulting serializer
28 * @param msgTypeKey lookup key
29 * @return serializer or NullPointerException if no serializer was found
31 <K, S extends OFGeneralSerializer> S getSerializer(MessageTypeKey<K> msgTypeKey);
34 * Registers serializer
35 * Throws IllegalStateException when there is
36 * a serializer already registered under given key.
38 * If the serializer implements {@link SerializerRegistryInjector} interface,
39 * the serializer is injected with SerializerRegistry instance.
41 * @param <K> serializer key type
42 * @param key used for serializer lookup
43 * @param serializer serializer implementation
45 <K> void registerSerializer(MessageTypeKey<K> key,
46 OFGeneralSerializer serializer);
49 * Unregisters serializer
50 * @param <K> serializer key type
51 * @param key used for serializer lookup
52 * @return true if serializer was removed,
53 * false if no serializer was found under specified key
55 <K> boolean unregisterSerializer(MessageTypeKey<K> key);