BUG-1092: rename data.api.InstanceIdentifier to YangInstanceIdentifier

[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / NormalizedNodeContainer.java

diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizedNodeContainer.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizedNodeContainer.java
index 841f5b5c006470927f2b6a1810f5f5904bfe7869..b416f78fa1e6f88d24144168f287f0eeba6a6d5d 100644 (file)
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizedNodeContainer.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizedNodeContainer.java
@@ -1,36 +1,53 @@
 /*
- * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
- *
+ * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
 package org.opendaylight.yangtools.yang.data.api.schema;
 
-import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 
 import com.google.common.base.Optional;
 
 /**
- *
- * @param <I> Node Identifier type
- * @param <K> Child Node Identifier type
- * @param <V> Child Node type
+ * Node which is not leaf, but has child {@link NormalizedNode}s as its valzue.
+ * 
+ * 
+ * NormalizedNodeContainer does not have a value, but it has a child
+ * nodes. Definition of possible and valid child nodes is introduced
+ * in subclasses of this interface.
+ * 
+ * This interface should not be used directly, but rather use of of derived subinterfaces
+ * such as {@link DataContainerNode}, {@link MapNode}, {@link LeafSetNode}.
+ * 
+ * @param <I>
+ *            Node Identifier type
+ * @param <K>
+ *            Child Node Identifier type
+ * @param <V>
+ *            Child Node type
  */
 public interface NormalizedNodeContainer<I extends PathArgument, K extends PathArgument, V extends NormalizedNode<? extends K, ?>>
         extends NormalizedNode<I, Iterable<V>> {
 
     @Override
-    public I getIdentifier();
+    I getIdentifier();
 
+    /**
+     * Returns immutable iteration of child nodes of this node.
+     * 
+     */
     @Override
-    public Iterable<V> getValue();
+    Iterable<V> getValue();
 
     /**
-     *
-     *
+     * Returns child node identified by provided key.
+     * 
      * @param child
-     * @return
+     *            Path argument identifying child node
+     * @return Optional with child node if child exists.
+     *         {@link Optional#absent()} if child does not exists.
      */
     Optional<V> getChild(K child);
 }