openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.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.MessageCodeKey;
  11
  12
  13 /**
  14  * @author michal.polkorab
  15  *
  16  */
  17 public interface DeserializerRegistry {
  18
  19     /**
  20      * Initializes deserializers
  21      */
  22     void init();
  23
  24     /**
  25      * @param key used for deserializer lookup
  26      * @return deserializer found
  27      */
  28     <T extends OFGeneralDeserializer>
  29             T getDeserializer(MessageCodeKey key);
  30
  31     /**
  32      * Registers deserializer.
  33      * Throws IllegalStateException when there is
  34      * a deserializer already registered under given key.
  35      *
  36      * If the deserializer implements {@link DeserializerRegistryInjector} interface,
  37      * the deserializer is injected with DeserializerRegistry instance.
  38      *
  39      * @param key used for deserializer lookup
  40      * @param deserializer deserializer instance
  41      */
  42     void registerDeserializer(MessageCodeKey key,
  43             OFGeneralDeserializer deserializer);
  44
  45     /**
  46      * Unregisters deserializer
  47      * @param key used for deserializer lookup
  48      * @return true if deserializer was removed,
  49      *  false if no deserializer was found under specified key
  50      */
  51     boolean unregisterDeserializer(MessageCodeKey key);
  52 }