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

   1 /*\r
   2  * Copyright (c) 2014 Pantheon Technologies s.r.o. and others. All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 \r
   9 package org.opendaylight.openflowjava.protocol.api.extensibility;\r
  10 \r
  11 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;\r
  12 import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterActionSerializerKey;\r
  13 import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterInstructionSerializerKey;\r
  14 import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterSerializerKey;\r
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MatchField;\r
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OxmClassBase;\r
  17 \r
  18 \r
  19 /**\r
  20  * Provides methods for serialization part of extensibility\r
  21  * @author michal.polkorab\r
  22  */\r
  23 public interface SerializerExtensionProvider {\r
  24 \r
  25     /**\r
  26      * Unregisters custom serializer\r
  27      * @param key used for serializer lookup\r
  28      * @return true if serializer was removed,\r
  29      *  false if no serializer was found under specified key\r
  30      */\r
  31     public boolean unregisterSerializer(ExperimenterSerializerKey key);\r
  32 \r
  33     /**\r
  34      * Registers action serializer\r
  35      * @param key used for serializer lookup\r
  36      * @param serializer serializer implementation\r
  37      */\r
  38     public void registerActionSerializer(ExperimenterActionSerializerKey key,\r
  39             OFGeneralSerializer serializer);\r
  40 \r
  41     /**\r
  42      * Registers instruction serializer\r
  43      * @param key used for serializer lookup\r
  44      * @param serializer serializer implementation\r
  45      */\r
  46     public void registerInstructionSerializer(ExperimenterInstructionSerializerKey key,\r
  47             OFGeneralSerializer serializer);\r
  48 \r
  49     /**\r
  50      * Registers match entry serializer\r
  51      * @param key used for serializer lookup\r
  52      * @param serializer serializer implementation\r
  53      */\r
  54     public <OXM_CLASS extends OxmClassBase, OXM_TYPE extends MatchField> void registerMatchEntrySerializer(\r
  55             MatchEntrySerializerKey<OXM_CLASS, OXM_TYPE> key,OFGeneralSerializer serializer);\r
  56 }