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 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  19
  20 /**
  21  * A ChoiceSchemaNode defines a set of alternatives. It consists of a number of branches defined as
  22  * ChoiceCaseSchemaNode objects.
  23  */
  24 public interface ChoiceSchemaNode extends DataSchemaNode, AugmentationTarget, MandatoryAware,
  25         EffectiveStatementEquivalent<ChoiceEffectiveStatement> {
  26     /**
  27      * Returns cases of choice, keyed by their {@link SchemaNode#getQName()}. Returned map does not contain null keys
  28      * nor values.
  29      *
  30      * @return set of ChoiceCaseNode objects defined in this node which represents set of arguments of the YANG
  31      *         <code>case</code> substatement of the <code>choice</code> statement.
  32      */
  33     Collection<? extends CaseSchemaNode> getCases();
  34
  35     /**
  36      * Returns the concrete case according to specified Q name.
  37      *
  38      * @param qname
  39      *            QName of sought Choice Case Node
  40      * @return child case node of this Choice if child with given name is present, empty otherwise.
  41      * @throws NullPointerException if qname is null
  42      */
  43     default Optional<? extends CaseSchemaNode> findCase(final QName qname) {
  44         requireNonNull(qname);
  45         return getCases().stream().filter(node -> qname.equals(node.getQName())).findFirst();
  46     }
  47
  48     /**
  49      * Returns the concrete cases according to specified name, disregarding their namespace.
  50      *
  51      * @param localname
  52      *            local name of sought child as String
  53      * @return child case nodes matching specified local name, empty list if no match is found.
  54      * @throws NullPointerException if localname is null
  55      */
  56     @Beta
  57     default List<? extends CaseSchemaNode> findCaseNodes(final String localname) {
  58         return getCases().stream().filter(node -> localname.equals(node.getQName().getLocalName()))
  59                 .collect(ImmutableList.toImmutableList());
  60     }
  61
  62     /**
  63      * Find a specific data schema child, if present. This method searches among its {@link CaseSchemaNode}s,
  64      * potentially recursing to nested choices.
  65      *
  66      * @param qname
  67      *            QName of sought data schema node
  68      * @return Matching node, or empty if no match is found
  69      * @throws NullPointerException if qname is null
  70      */
  71     @Beta
  72     default Optional<DataSchemaNode> findDataSchemaChild(final QName qname) {
  73         requireNonNull(qname);
  74         for (CaseSchemaNode caseNode : getCases()) {
  75             final Optional<DataSchemaNode> child = caseNode.findDataChildByName(qname);
  76             if (child.isPresent()) {
  77                 return child;
  78             }
  79         }
  80
  81         return Optional.empty();
  82     }
  83
  84     /**
  85      * Returns name of case which is in the choice specified as default.
  86      *
  87      * @return string with the name of case which is specified in the argument of the YANG <code>default</code>
  88      *         substatement of <code>choice</code> statement.
  89      */
  90     Optional<CaseSchemaNode> getDefaultCase();
  91 }