Expand BindingObject documentation

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

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingObject.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingObject.java
index a44dccbc37bf12d3473bc97394be5f81594d9bc7..3a46e0390a505065a60c33a7cab53d312b0ed66a 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingObject.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingObject.java
@@ -8,7 +8,17 @@
 package org.opendaylight.yangtools.yang.binding;
 
 /**
- * BindingObject is a base interface for all bindings.
+ * Base interface for all interfaces and classes which can be encountered in the context of a particular data exchange.
+ * These map to YANG data definition constructs:
+ * <ul>
+ *   <li>{@code identity} as referenced via a {@code type identityref} statement, represented by
+ *       {@link BaseIdentity}</li>
+ *   <li>{@code anydata} and {@code anyxml}, represented by {@link OpaqueObject}</li>
+ *   <li>{@code typedef} and {@code type}, represented by {@link TypeObject}</li>
+ *   <li>{@code md:annotation}, represented by {@link Annotation}</li>
+ *   <li>{@code rc:yang-data}, represented by {@link YangData}</li>
+ *   <li>all others, represented by {@link DataObject} and its further specializations</li>
+ * </ul>
  *
  * @author Jie Han
  */