Remove trailing whitespace
[openflowjava.git] / openflow-protocol-api / src / main / java / org / opendaylight / openflowjava / protocol / api / extensibility / SerializerExtensionProvider.java
index f658f5f109d4197fe05136cac172e635d6fd7ee1..f4325cff1af92b7d84f099d7e9a2f82e43aee0ce 100644 (file)
-/*\r
- * Copyright (c) 2014 Pantheon Technologies s.r.o. and others. All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-\r
-package org.opendaylight.openflowjava.protocol.api.extensibility;\r
-\r
-import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterActionSerializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterIdSerializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterInstructionSerializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterSerializerKey;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MatchField;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OxmClassBase;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterInput;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;\r
-\r
-\r
-/**\r
- * Provides methods for serialization part of extensibility.\r
- * In case of handling multiple structures of same type (actions,\r
- * instructions, match entries, ... ) which are differentiated by\r
- * vendor / experimenter subtype, vendor has to switch / choose between\r
- * these subtypes. <br />\r
- * \r
- * This has to be done in this way because of unknown augmentations\r
- * - that's why vendor has to handle it in his own implementations.\r
- * @author michal.polkorab\r
- */\r
-public interface SerializerExtensionProvider {\r
-\r
-    /**\r
-     * Unregisters custom serializer\r
-     * @param key used for serializer lookup\r
-     * @return true if serializer was removed,\r
-     *  false if no serializer was found under specified key\r
-     */\r
-    boolean unregisterSerializer(ExperimenterSerializerKey key);\r
-\r
-    /**\r
-     * Registers action serializer\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    void registerActionSerializer(ExperimenterActionSerializerKey key,\r
-            OFGeneralSerializer serializer);\r
-\r
-    /**\r
-     * Registers instruction serializer\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    void registerInstructionSerializer(ExperimenterInstructionSerializerKey key,\r
-            OFGeneralSerializer serializer);\r
-\r
-    /**\r
-     * Registers match entry serializer\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    <OXMCLASS extends OxmClassBase, OXMTYPE extends MatchField> void registerMatchEntrySerializer(\r
-            MatchEntrySerializerKey<OXMCLASS, OXMTYPE> key,OFGeneralSerializer serializer);\r
-\r
-    /**\r
-     * Registers experimenter (vendor) message serializer\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    void registerExperimenterMessageSerializer(ExperimenterIdSerializerKey<ExperimenterInput> key,\r
-            OFSerializer<ExperimenterInput> serializer);\r
-\r
-    /**\r
-     * Registers multipart-request (stats-request) serializer\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    void registerMultipartRequestSerializer(ExperimenterIdSerializerKey<MultipartRequestExperimenterCase> key,\r
-            OFSerializer<MultipartRequestExperimenterCase> serializer);\r
-\r
-    /**\r
-     * Registers multipart-request table-features serializer\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    void registerMultipartRequestTFSerializer(ExperimenterIdSerializerKey<TableFeatureProperties> key,\r
-            OFGeneralSerializer serializer);\r
-\r
-    /**\r
-     * Registers meter band serializer (used in meter-mod messages)\r
-     * @param key used for serializer lookup\r
-     * @param serializer serializer implementation\r
-     */\r
-    void registerMeterBandSerializer(ExperimenterIdSerializerKey<MeterBandExperimenterCase> key,\r
-            OFSerializer<MeterBandExperimenterCase> serializer);\r
+/*
+ * Copyright (c) 2014 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.openflowjava.protocol.api.extensibility;
+
+import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterActionSerializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterIdSerializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterInstructionSerializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterSerializerKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.MatchField;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OxmClassBase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;
+
+
+/**
+ * Provides methods for serialization part of extensibility.
+ * In case of handling multiple structures of same type (actions,
+ * instructions, match entries, ... ) which are differentiated by
+ * vendor / experimenter subtype, vendor has to switch / choose between
+ * these subtypes. <br />
+ *
+ * This has to be done in this way because of unknown augmentations
+ * - that's why vendor has to handle it in his own implementations.
+ * @author michal.polkorab
+ */
+public interface SerializerExtensionProvider {
+
+    /**
+     * Unregisters custom serializer
+     * @param key used for serializer lookup
+     * @return true if serializer was removed,
+     *  false if no serializer was found under specified key
+     */
+    boolean unregisterSerializer(ExperimenterSerializerKey key);
+
+    /**
+     * Registers action serializer
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    void registerActionSerializer(ExperimenterActionSerializerKey key,
+            OFGeneralSerializer serializer);
+
+    /**
+     * Registers instruction serializer
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    void registerInstructionSerializer(ExperimenterInstructionSerializerKey key,
+            OFGeneralSerializer serializer);
+
+    /**
+     * Registers match entry serializer
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    <OXMCLASS extends OxmClassBase, OXMTYPE extends MatchField> void registerMatchEntrySerializer(
+            MatchEntrySerializerKey<OXMCLASS, OXMTYPE> key,OFGeneralSerializer serializer);
+
+    /**
+     * Registers experimenter (vendor) message serializer
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    void registerExperimenterMessageSerializer(ExperimenterIdSerializerKey<ExperimenterInput> key,
+            OFSerializer<ExperimenterInput> serializer);
+
+    /**
+     * Registers multipart-request (stats-request) serializer
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    void registerMultipartRequestSerializer(ExperimenterIdSerializerKey<MultipartRequestExperimenterCase> key,
+            OFSerializer<MultipartRequestExperimenterCase> serializer);
+
+    /**
+     * Registers multipart-request table-features serializer
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    void registerMultipartRequestTFSerializer(ExperimenterIdSerializerKey<TableFeatureProperties> key,
+            OFGeneralSerializer serializer);
+
+    /**
+     * Registers meter band serializer (used in meter-mod messages)
+     * @param key used for serializer lookup
+     * @param serializer serializer implementation
+     */
+    void registerMeterBandSerializer(ExperimenterIdSerializerKey<MeterBandExperimenterCase> key,
+            OFSerializer<MeterBandExperimenterCase> serializer);
 }
\ No newline at end of file