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.findings.Finding;
  27 import org.oran.smo.yangtools.parser.findings.ParserFindingType;
  28 import org.oran.smo.yangtools.parser.model.statements.AbstractStatement;
  29 import org.oran.smo.yangtools.parser.model.statements.StatementModuleAndName;
  30 import org.oran.smo.yangtools.parser.model.yangdom.YangDomElement;
  31
  32 /**
  33  * Type-safe Yang core statement.
  34  *
  35  * @author Mark Hollmann
  36  */
  37 public class YAugment extends AbstractStatement {
  38
  39     public YAugment(final AbstractStatement parentStatement, final YangDomElement domNode) {
  40         super(parentStatement, domNode);
  41     }
  42
  43     public String getAugmentTargetNode() {
  44         return domElement.getTrimmedValueOrEmpty();
  45     }
  46
  47     @Override
  48     public StatementArgumentType getArgumentType() {
  49         return StatementArgumentType.TARGET_NODE;
  50     }
  51
  52     @Override
  53     public StatementModuleAndName getStatementModuleAndName() {
  54         return CY.STMT_AUGMENT;
  55     }
  56
  57     public List<YAction> getActions() {
  58         return getChildren(CY.STMT_ACTION);
  59     }
  60
  61     public List<YAnydata> getAnydata() {
  62         return getChildren(CY.STMT_ANYDATA);
  63     }
  64
  65     public List<YAnyxml> getAnyxmls() {
  66         return getChildren(CY.STMT_ANYXML);
  67     }
  68
  69     public List<YCase> getCases() {
  70         return getChildren(CY.STMT_CASE);
  71     }
  72
  73     public List<YChoice> getChoices() {
  74         return getChildren(CY.STMT_CHOICE);
  75     }
  76
  77     public List<YContainer> getContainers() {
  78         return getChildren(CY.STMT_CONTAINER);
  79     }
  80
  81     public List<YIfFeature> getIfFeatures() {
  82         return getChildren(CY.STMT_IF_FEATURE);
  83     }
  84
  85     public List<YLeaf> getLeafs() {
  86         return getChildren(CY.STMT_LEAF);
  87     }
  88
  89     public List<YLeafList> getLeafLists() {
  90         return getChildren(CY.STMT_LEAF_LIST);
  91     }
  92
  93     public List<YList> getLists() {
  94         return getChildren(CY.STMT_LIST);
  95     }
  96
  97     public List<YNotification> getNotifications() {
  98         return getChildren(CY.STMT_NOTIFICATION);
  99     }
 100
 101     public YStatus getStatus() {
 102         return getChild(CY.STMT_STATUS);
 103     }
 104
 105     public List<YUses> getUses() {
 106         return getChildren(CY.STMT_USES);
 107     }
 108
 109     public YWhen getWhen() {
 110         return getChild(CY.STMT_WHEN);
 111     }
 112
 113     protected void validate(final ParserExecutionContext context) {
 114         if (!validateArgumentNotNullNotEmpty(context)) {
 115             /* no point trying to perform more validation */
 116             return;
 117         }
 118
 119         /*
 120          * Depending on where the 'augment' sits, the path has to be either absolute or relative.
 121          */
 122         if ((getParentStatement().is(CY.STMT_MODULE) || getParentStatement().is(
 123                 CY.STMT_SUBMODULE)) && !getAugmentTargetNode().startsWith("/")) {
 124             context.addFinding(new Finding(this, ParserFindingType.P015_INVALID_SYNTAX_IN_DOCUMENT,
 125                     "The augment's schema node identifier '" + getAugmentTargetNode() + "' is relative (it must be absolute, i.e. start with '/')"));
 126         } else if (getParentStatement().is(CY.STMT_USES) && getAugmentTargetNode().startsWith("/")) {
 127             context.addFinding(new Finding(this, ParserFindingType.P015_INVALID_SYNTAX_IN_DOCUMENT,
 128                     "The augment's schema node identifier '" + getAugmentTargetNode() + "' is absolute (it must be relative, i.e. not start with '/')"));
 129         }
 130     }
 131 }