openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerRegistry.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.openflowjava.protocol.api.extensibility;
   9
  10 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  11
  12
  13
  14
  15 /**
  16  * Stores and handles serializers <br/>
  17  * K - {@link MessageTypeKey} parameter type,<br/>
  18  * S - returned serializer type
  19  * @author michal.polkorab
  20  *
  21  */
  22 public interface SerializerRegistry {
  23
  24     /**
  25      * Serializer registry provisioning
  26      */
  27     public void init();
  28
  29     /**
  30      * @param msgTypeKey lookup key
  31      * @return serializer or NullPointerException if no serializer was found
  32      */
  33     <K, S extends OFGeneralSerializer> S getSerializer(MessageTypeKey<K> msgTypeKey);
  34
  35     /**
  36      * Registers serializer
  37      * Throws IllegalStateException when there is
  38      * a serializer already registered under given key.
  39      *
  40      * If the serializer implements {@link SerializerRegistryInjector} interface,
  41      * the serializer is injected with SerializerRegistry instance.
  42      *
  43      * @param key used for serializer lookup
  44      * @param serializer serializer implementation
  45      */
  46     <K> void registerSerializer(MessageTypeKey<K> key,
  47             OFGeneralSerializer serializer);
  48
  49     /**
  50      * Unregisters serializer
  51      * @param key used for serializer lookup
  52      * @param serializer serializer implementation
  53      * @return true if serializer was removed,
  54      *  false if no serializer was found under specified key
  55      */
  56     <K> boolean unregisterSerializer(MessageTypeKey<K> key);
  57 }