Update ChoiceSchemaNode design

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / ChoiceSchemaNode.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java
index 0da6676886132a9ba0bcc91a0b39b37fa8f16ab4..073b25c6c7d515efd5efcf2b29ea249cf56ff7e7 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ChoiceSchemaNode.java
@@ -7,50 +7,96 @@
  */
 package org.opendaylight.yangtools.yang.model.api;
 
-import java.util.Set;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+import com.google.common.collect.ImmutableList;
+import java.util.List;
+import java.util.Optional;
+import java.util.SortedMap;
 import org.opendaylight.yangtools.yang.common.QName;
 
 /**
- * A ChoiceSchemaNode defines a set of alternatives. It consists of a number of
- * branches defined as ChoiceCaseSchemaNode objects.
+ * A ChoiceSchemaNode defines a set of alternatives. It consists of a number of branches defined as
+ * ChoiceCaseSchemaNode objects.
  */
 public interface ChoiceSchemaNode extends DataSchemaNode, AugmentationTarget {
     /**
-     * Returns cases of choice.
+     * Returns cases of choice, keyed by their {@link SchemaNode#getQName()}. Returned map does not contain null keys
+     * nor values.
      *
-     * @return set of ChoiceCaseNode objects defined in this node which
-     *         represents set of arguments of the YANG <code>case</code>
-     *         substatement of the <code>choice</code> statement
+     * @return set of ChoiceCaseNode objects defined in this node which represents set of arguments of the YANG
+     *         <code>case</code> substatement of the <code>choice</code> statement.
      */
-    Set<ChoiceCaseNode> getCases();
+    SortedMap<QName, ChoiceCaseNode> getCases();
 
     /**
      * Returns the concrete case according to specified Q name.
      *
-     * @param name
-     *            QName of seeked Choice Case Node
-     * @return child case node of this Choice if child with given name is
-     *         present, <code>null</code> otherwise
+     * @param qname
+     *            QName of sought Choice Case Node
+     * @return child case node of this Choice if child with given name is present, empty otherwise.
+     * @throws NullPointerException if qname is null
      */
-    ChoiceCaseNode getCaseNodeByName(QName name);
+    default Optional<ChoiceCaseNode> findCase(final QName qname) {
+        return Optional.ofNullable(getCases().get(requireNonNull(qname)));
+    }
 
     /**
-     * Returns the concrete case according to specified name.
+     * Returns the concrete cases according to specified name, disregarding their namespace.
      *
-     * @param name
-     *            name of seeked child as String
-     * @return child case node (or local name of case node) of this Choice if
-     *         child with given name is present, <code>null</code> otherwise
+     * @param localname
+     *            local name of sought child as String
+     * @return child case nodes matching specified local name, empty list if no match is found.
+     * @throws NullPointerException if localname is null
      */
-    ChoiceCaseNode getCaseNodeByName(String name);
+    @Beta
+    default List<ChoiceCaseNode> findCaseNodes(final String localname) {
+        return getCases().values().stream().filter(node -> localname.equals(node.getQName().getLocalName()))
+                .collect(ImmutableList.toImmutableList());
+    }
 
     /**
-     * Returns name of case which is in the choice specified as default.
+     * Find a specific data schema child, if present. This method searches among its {@link ChoiceCaseNode}s,
+     * potentially recursing to nested choices.
+     *
+     * @param qname
+     *            QName of sought data schema node
+     * @return Matching node, or empty if no match is found
+     * @throws NullPointerException if qname is null
+     */
+    @Beta
+    default Optional<DataSchemaNode> findDataSchemaChild(final QName qname) {
+        requireNonNull(qname);
+        for (ChoiceCaseNode caseNode : getCases().values()) {
+            final Optional<DataSchemaNode> child = caseNode.findDataChildByName(qname);
+            if (child.isPresent()) {
+                return child;
+            }
+        }
+
+        return Optional.empty();
+    }
+
+    /**
+     * Returns the concrete case according to specified QName.
+     *
+     * @param qname
+     *            QName of sought Choice Case Node
+     * @return child case node of this Choice if child with given name is present, <code>null</code> otherwise.
      *
-     * @return string with the name of case which is specified in the argument
-     *         of the YANG <code>default</code> substatement of
-     *         <code>choice</code> statement.
+     * @deprecated Use either {@code getCases().get(name)} or #findCase(QName)
      */
-    String getDefaultCase();
+    @Deprecated
+    default ChoiceCaseNode getCaseNodeByName(final QName qname) {
+        return getCases().get(qname);
+    }
 
+    /**
+     * Returns name of case which is in the choice specified as default.
+     *
+     * @return string with the name of case which is specified in the argument of the YANG <code>default</code>
+     *         substatement of <code>choice</code> statement.
+     */
+    Optional<ChoiceCaseNode> getDefaultCase();
 }