Document BindingCodec/Serializer/Deserializer

These interfaces are not documented at all, owing partly to the fact
they are are implementation of mdsal-binding-dom-codec, whose design
currently requires placing codecs into the same class loader as
generated code -- hence they leak to the common binding support
package.

Change-Id: Ib576b9aeddcc644d5b1f44a2047e775cc5266245
JIRA: MDSAL-401
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java
index a812126336d724542b0b2c47180de2849157a0fa..e8c9a107d1feac640707d89df6386bf2347a0d6a 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java
@@ -9,6 +9,11 @@ package org.opendaylight.yangtools.yang.binding;
 
 import org.opendaylight.yangtools.concepts.Codec;
 
+/**
+ * Combination of {@link BindingSerializer} and {@link BindingDeserializer}. This interface is present in this package
+ * only due to constraints imposed by current implementation.
+ */
+// FIXME: MDSAL-401: deprecate this interface once we no longer to have in a public place
 public interface BindingCodec<P, I> extends BindingSerializer<P, I>, BindingDeserializer<I, P>, Codec<P, I> {
 
     @Override

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingDeserializer.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingDeserializer.java
index dea3d992db99f03e07b70df229654dcd848554e9..aa4f05e25f4bf61b93ecf5733f327510e95e71cd 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingDeserializer.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingDeserializer.java
@@ -7,7 +7,12 @@
  */
 package org.opendaylight.yangtools.yang.binding;
 
-public interface BindingDeserializer<P,I> {
+/**
+ * A serializer capable of encoding an input into some other form (typically DataObject). This interface is present in
+ * this package only due to constraints imposed by current implementation.
+ */
+// FIXME: MDSAL-401: deprecate this interface once we no longer to have in a public place
+public interface BindingDeserializer<P, I> {
 
     P deserialize(I input);
 }

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingSerializer.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingSerializer.java
index fb85eae9f783f3f9ed19cb2c2120946792b4f5bb..bd472e9b2b95dcd6c8cd861af59d5540eb8e78a5 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingSerializer.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingSerializer.java
@@ -7,6 +7,11 @@
  */
 package org.opendaylight.yangtools.yang.binding;
 
-public interface BindingSerializer<P,I> {
+/**
+ * A serializer capable of encoding an input (typically DataObject) into some other form. This interface is present in
+ * this package only due to constraints imposed by current implementation.
+ */
+// FIXME: MDSAL-401: deprecate this interface once we no longer to have in a public place
+public interface BindingSerializer<P, I> {
     P serialize(I input);
 }