Document BindingCodec/Serializer/Deserializer

[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / BindingDeserializer.java

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);
 }