Update ObjectParser API

[bgpcep.git] / pcep / spi / src / main / java / org / opendaylight / protocol / pcep / spi / EROSubobjectRegistry.java

diff --git a/pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/EROSubobjectRegistry.java b/pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/EROSubobjectRegistry.java
index a295ed341da81fa1baa7575922c99549b0a2a5db..e331fec80109937a3612f1740fbaeb83009006f9 100644 (file)
--- a/pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/EROSubobjectRegistry.java
+++ b/pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/EROSubobjectRegistry.java
@@ -8,24 +8,29 @@
 package org.opendaylight.protocol.pcep.spi;
 
 import io.netty.buffer.ByteBuf;
-
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.ero.Subobject;
 
+/**
+ * Explicit Route Object Registry.
+ */
 public interface EROSubobjectRegistry {
-       /**
-        * Finds parser for given subobject type in the registry. Delegates parsing to found parser.
-        * @param type subobject type, key in parser registry
-        * @param buffer subobject wrapped in ByteBuf
-        * @param loose ERO specific common field
-        * @return null if the parser for this subobject could not be found
-        * @throws PCEPDeserializerException if the parsing did not succeed
-        */
-       Subobject parseSubobject(final int subobjectType, final ByteBuf buffer, final boolean loose) throws PCEPDeserializerException;
+    /**
+     * Finds parser for given subobject type in the registry. Delegates parsing to found parser.
+     *
+     * @param subobjectType subobject type, key in parser registry
+     * @param buffer        subobject wrapped in ByteBuf
+     * @param loose         ERO specific common field
+     * @return null if the parser for this subobject could not be found
+     * @throws PCEPDeserializerException if the parsing did not succeed
+     */
+    Subobject parseSubobject(final int subobjectType, final ByteBuf buffer, final boolean loose)
+        throws PCEPDeserializerException;
 
-       /**
-        * Find serializer for given subobject. Delegates parsing to found serializer.
-        * @param subobject to be parsed
-        * @return null if the serializer for this subobject could not be found
-        */
-       byte[] serializeSubobject(final Subobject subobject);
+    /**
+     * Find serializer for given subobject. Delegates parsing to found serializer.
+     *
+     * @param subobject to be parsed
+     * @param buffer    buffer where the serialized subobject will be parsed
+     */
+    void serializeSubobject(final Subobject subobject, final ByteBuf buffer);
 }