Merge "Spec: OFPGC_ADD_OR_MOD support in openflowplugin"

[openflowplugin.git] / openflowjava / openflow-protocol-api / src / main / java / org / opendaylight / openflowjava / protocol / api / extensibility / DeserializerRegistry.java

diff --git a/openflowjava/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java b/openflowjava/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java
index 27660398b42b0225ddd128601be5800f6b5c2b5b..15253f5bee99570c1cc2919906f7378f05b3de21 100644 (file)
--- a/openflowjava/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java
+++ b/openflowjava/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java
@@ -9,19 +9,21 @@ package org.opendaylight.openflowjava.protocol.api.extensibility;
 
 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
 
-
 /**
- * @author michal.polkorab
+ * Registry for deserializers.
  *
+ * @author michal.polkorab
  */
 public interface DeserializerRegistry {
 
     /**
-     * Initializes deserializers
+     * Initializes deserializers.
      */
     void init();
 
     /**
+     * Gets the deserializer for the given key.
+     *
      * @param <T> type of particular deserializer
      * @param key used for deserializer lookup
      * @return deserializer found
@@ -30,10 +32,11 @@ public interface DeserializerRegistry {
             T getDeserializer(MessageCodeKey key);
 
     /**
-     * Registers deserializer.
+     * Registers a deserializer.
      * Throws IllegalStateException when there is
      * a deserializer already registered under given key.
      *
+     * <p>
      * If the deserializer implements {@link DeserializerRegistryInjector} interface,
      * the deserializer is injected with DeserializerRegistry instance.
      *
@@ -44,10 +47,11 @@ public interface DeserializerRegistry {
             OFGeneralDeserializer deserializer);
 
     /**
-     * Unregisters deserializer
+     * Unregisters a deserializer.
+     *
      * @param key used for deserializer lookup
      * @return true if deserializer was removed,
-     *  false if no deserializer was found under specified key
+     *     false if no deserializer was found under specified key
      */
     boolean unregisterDeserializer(MessageCodeKey key);
 }