gerrit.o-ran-sc Code Review - smo/teiv.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 Ericsson
   4  *  Modifications Copyright (C) 2024 OpenInfra Foundation Europe
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21 package org.oran.smo.yangtools.parser.model.statements.yang;
  22
  23 import java.util.List;
  24
  25 import org.oran.smo.yangtools.parser.ParserExecutionContext;
  26 import org.oran.smo.yangtools.parser.model.statements.AbstractStatement;
  27 import org.oran.smo.yangtools.parser.model.statements.StatementModuleAndName;
  28 import org.oran.smo.yangtools.parser.model.yangdom.YangDomElement;
  29
  30 /**
  31  * Type-safe Yang core statement.
  32  *
  33  * @author Mark Hollmann
  34  */
  35 public class YChoice extends AbstractStatement {
  36
  37     public YChoice(final AbstractStatement parentStatement, final YangDomElement domNode) {
  38         super(parentStatement, domNode);
  39     }
  40
  41     @Override
  42     public String getStatementIdentifier() {
  43         return getChoiceName();
  44     }
  45
  46     @Override
  47     public boolean definesSchemaNode() {
  48         return true;
  49     }
  50
  51     @Override
  52     public StatementArgumentType getArgumentType() {
  53         return StatementArgumentType.NAME;
  54     }
  55
  56     @Override
  57     public StatementModuleAndName getStatementModuleAndName() {
  58         return CY.STMT_CHOICE;
  59     }
  60
  61     public String getChoiceName() {
  62         return domElement.getValue();
  63     }
  64
  65     /**
  66      * This method will always return an empty list after parsing has completed, as any
  67      * shorthand case-notation will cause a case statement to be injected between the
  68      * choice and the shorthand statement.
  69      */
  70     public List<YAnydata> getAnydata() {
  71         return getChildren(CY.STMT_ANYDATA);
  72     }
  73
  74     /**
  75      * This method will always return an empty list after parsing has completed, as any
  76      * shorthand case-notation will cause a case statement to be injected between the
  77      * choice and the shorthand statement.
  78      */
  79     public List<YAnyxml> getAnyxmls() {
  80         return getChildren(CY.STMT_ANYXML);
  81     }
  82
  83     public List<YCase> getCases() {
  84         return getChildren(CY.STMT_CASE);
  85     }
  86
  87     public List<YChoice> getChoices() {
  88         return getChildren(CY.STMT_CHOICE);
  89     }
  90
  91     public YConfig getConfig() {
  92         return getChild(CY.STMT_CONFIG);
  93     }
  94
  95     /**
  96      * This method will always return an empty list after parsing has completed, as any
  97      * shorthand case-notation will cause a case statement to be injected between the
  98      * choice and the shorthand statement.
  99      */
 100     public List<YContainer> getContainers() {
 101         return getChildren(CY.STMT_CONTAINER);
 102     }
 103
 104     public YDefault getDefault() {
 105         return getChild(CY.STMT_DEFAULT);
 106     }
 107
 108     public List<YIfFeature> getIfFeatures() {
 109         return getChildren(CY.STMT_IF_FEATURE);
 110     }
 111
 112     /**
 113      * This method will always return an empty list after parsing has completed, as any
 114      * shorthand case-notation will cause a case statement to be injected between the
 115      * choice and the shorthand statement.
 116      */
 117     public List<YLeaf> getLeafs() {
 118         return getChildren(CY.STMT_LEAF);
 119     }
 120
 121     /**
 122      * This method will always return an empty list after parsing has completed, as any
 123      * shorthand case-notation will cause a case statement to be injected between the
 124      * choice and the shorthand statement.
 125      */
 126     public List<YLeafList> getLeafLists() {
 127         return getChildren(CY.STMT_LEAF_LIST);
 128     }
 129
 130     /**
 131      * This method will always return an empty list after parsing has completed, as any
 132      * shorthand case-notation will cause a case statement to be injected between the
 133      * choice and the shorthand statement.
 134      */
 135     public List<YList> getLists() {
 136         return getChildren(CY.STMT_LIST);
 137     }
 138
 139     public YMandatory getMandatory() {
 140         return getChild(CY.STMT_MANDATORY);
 141     }
 142
 143     public YStatus getStatus() {
 144         return getChild(CY.STMT_STATUS);
 145     }
 146
 147     public List<YWhen> getWhens() {
 148         return getChildren(CY.STMT_WHEN);
 149     }
 150
 151     protected void validate(final ParserExecutionContext context) {
 152         validateArgumentNotNullNotEmpty(context);
 153         validateIsYangIdentifier(context, getChoiceName());
 154     }
 155 }