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 org.oran.smo.yangtools.parser.ParserExecutionContext;
  24 import org.oran.smo.yangtools.parser.findings.Finding;
  25 import org.oran.smo.yangtools.parser.findings.ParserFindingType;
  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.util.DataTypeHelper;
  29 import org.oran.smo.yangtools.parser.model.yangdom.YangDomElement;
  30
  31 /**
  32  * Type-safe Yang core statement.
  33  *
  34  * @author Mark Hollmann
  35  */
  36 public class YTypedef extends AbstractStatement {
  37
  38     public YTypedef(final AbstractStatement parentStatement, final YangDomElement domNode) {
  39         super(parentStatement, domNode);
  40     }
  41
  42     @Override
  43     public String getStatementIdentifier() {
  44         return getTypedefName();
  45     }
  46
  47     @Override
  48     public StatementArgumentType getArgumentType() {
  49         return StatementArgumentType.NAME;
  50     }
  51
  52     @Override
  53     public StatementModuleAndName getStatementModuleAndName() {
  54         return CY.STMT_TYPEDEF;
  55     }
  56
  57     public String getTypedefName() {
  58         return domElement.getValue();
  59     }
  60
  61     public YDefault getDefault() {
  62         return getChild(CY.STMT_DEFAULT);
  63     }
  64
  65     public YStatus getStatus() {
  66         return getChild(CY.STMT_STATUS);
  67     }
  68
  69     public YType getType() {
  70         return getChild(CY.STMT_TYPE);
  71     }
  72
  73     public YUnits getUnits() {
  74         return getChild(CY.STMT_UNITS);
  75     }
  76
  77     protected void validate(final ParserExecutionContext context) {
  78         if (!validateArgumentNotNullNotEmpty(context)) {
  79             /* no point trying to perform more validation */
  80             return;
  81         }
  82
  83         validateIsYangIdentifier(context, getTypedefName());
  84
  85         /*
  86          * The name of the typedef cannot be one of the built-in types, so check for that as well.
  87          */
  88         if (DataTypeHelper.isBuiltInType(getTypedefName())) {
  89             context.addFinding(new Finding(this, ParserFindingType.P015_INVALID_SYNTAX_IN_DOCUMENT,
  90                     "The name of the typedef cannot be one of the built-in YANG data type names."));
  91         }
  92     }
  93 }