Update BindingInstanceIdentifierCodec documentation

Document IllegalArgumentException being thrown and add FIXMEs.

Change-Id: I44e8a8c86b2dd180dc09f23a8a930b23f01b3c75
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/mdsal-binding-dom-codec-api/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingInstanceIdentifierCodec.java b/binding/mdsal-binding-dom-codec-api/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingInstanceIdentifierCodec.java
index 4337f34b7f2a02dac2addea23077b56c932e9578..4bd74387c58cb81e0f6653921eb4d16aa0af01e7 100644 (file)
--- a/binding/mdsal-binding-dom-codec-api/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingInstanceIdentifierCodec.java
+++ b/binding/mdsal-binding-dom-codec-api/src/main/java/org/opendaylight/mdsal/binding/dom/codec/api/BindingInstanceIdentifierCodec.java
@@ -23,7 +23,10 @@ public interface BindingInstanceIdentifierCodec extends Immutable {
      * @param domPath YANG Instance Identifier
      * @return Binding Instance Identifier, or null if the instance identifier is not representable.
      * @throws NullPointerException if domPath is null
+     * @throws IllegalArgumentException if domPath is not valid.
      */
+    // FIXME: Document MissingSchemaException being thrown?
+    // FIXME: Document MissingSchemaForClassException being thrown?
     <T extends DataObject> @Nullable InstanceIdentifier<T> toBinding(@NonNull YangInstanceIdentifier domPath);
 
     /**
@@ -34,5 +37,7 @@ public interface BindingInstanceIdentifierCodec extends Immutable {
      * @throws NullPointerException if bindingPath is null
      * @throws IllegalArgumentException if bindingPath is not valid.
      */
+    // FIXME: Document MissingSchemaException being thrown
+    // FIXME: Document MissingSchemaForClassException being thrown
     @NonNull YangInstanceIdentifier fromBinding(@NonNull InstanceIdentifier<?> bindingPath);
 }