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

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.api;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18
  19 /**
  20  * A ChoiceSchemaNode defines a set of alternatives. It consists of a number of branches defined as
  21  * ChoiceCaseSchemaNode objects.
  22  */
  23 public interface ChoiceSchemaNode extends DataSchemaNode, AugmentationTarget, MandatoryAware {
  24     /**
  25      * Returns cases of choice, keyed by their {@link SchemaNode#getQName()}. Returned map does not contain null keys
  26      * nor values.
  27      *
  28      * @return set of ChoiceCaseNode objects defined in this node which represents set of arguments of the YANG
  29      *         <code>case</code> substatement of the <code>choice</code> statement.
  30      */
  31     Collection<? extends CaseSchemaNode> getCases();
  32
  33     /**
  34      * Returns the concrete case according to specified Q name.
  35      *
  36      * @param qname
  37      *            QName of sought Choice Case Node
  38      * @return child case node of this Choice if child with given name is present, empty otherwise.
  39      * @throws NullPointerException if qname is null
  40      */
  41     default Optional<? extends CaseSchemaNode> findCase(final QName qname) {
  42         requireNonNull(qname);
  43         return getCases().stream().filter(node -> qname.equals(node.getQName())).findFirst();
  44     }
  45
  46     /**
  47      * Returns the concrete cases according to specified name, disregarding their namespace.
  48      *
  49      * @param localname
  50      *            local name of sought child as String
  51      * @return child case nodes matching specified local name, empty list if no match is found.
  52      * @throws NullPointerException if localname is null
  53      */
  54     @Beta
  55     default List<? extends CaseSchemaNode> findCaseNodes(final String localname) {
  56         return getCases().stream().filter(node -> localname.equals(node.getQName().getLocalName()))
  57                 .collect(ImmutableList.toImmutableList());
  58     }
  59
  60     /**
  61      * Find a specific data schema child, if present. This method searches among its {@link CaseSchemaNode}s,
  62      * potentially recursing to nested choices.
  63      *
  64      * @param qname
  65      *            QName of sought data schema node
  66      * @return Matching node, or empty if no match is found
  67      * @throws NullPointerException if qname is null
  68      */
  69     @Beta
  70     default Optional<DataSchemaNode> findDataSchemaChild(final QName qname) {
  71         requireNonNull(qname);
  72         for (CaseSchemaNode caseNode : getCases()) {
  73             final Optional<DataSchemaNode> child = caseNode.findDataChildByName(qname);
  74             if (child.isPresent()) {
  75                 return child;
  76             }
  77         }
  78
  79         return Optional.empty();
  80     }
  81
  82     /**
  83      * Returns name of case which is in the choice specified as default.
  84      *
  85      * @return string with the name of case which is specified in the argument of the YANG <code>default</code>
  86      *         substatement of <code>choice</code> statement.
  87      */
  88     Optional<CaseSchemaNode> getDefaultCase();
  89 }