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.SimpleStatement;
  28 import org.oran.smo.yangtools.parser.model.statements.StatementModuleAndName;
  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 YStatus extends SimpleStatement {
  37
  38     public static final String CURRENT = "current";
  39     public static final String DEPRECATED = "deprecated";
  40     public static final String OBSOLETE = "obsolete";
  41
  42     public YStatus(final AbstractStatement parentStatement, final YangDomElement domNode) {
  43         super(parentStatement, domNode);
  44     }
  45
  46     @Override
  47     public StatementArgumentType getArgumentType() {
  48         return StatementArgumentType.VALUE;
  49     }
  50
  51     @Override
  52     public StatementModuleAndName getStatementModuleAndName() {
  53         return CY.STMT_STATUS;
  54     }
  55
  56     public boolean isCurrent() {
  57         return CURRENT.equals(getValue());
  58     }
  59
  60     public boolean isDeprecated() {
  61         return DEPRECATED.equals(getValue());
  62     }
  63
  64     public boolean isObsolete() {
  65         return OBSOLETE.equals(getValue());
  66     }
  67
  68     /**
  69      * Returns an integer that may be used to compare the status value for two data nodes.
  70      * The general rules are: CURRENT &lt; DEPRECATED &lt; OBSOLETE. The value returned
  71      * has no meaning in itself and especially should not be used to identity a certain
  72      * status value; it is only meaningful when compared to another value returned from
  73      * this method.
  74      */
  75     public int getStatusOrder() {
  76         return getStatusOrder(getValue());
  77     }
  78
  79     /**
  80      * Returns an integer that may be used to compare the status value for two data nodes.
  81      * The general rules are: CURRENT &lt; DEPRECATED &lt; OBSOLETE. The value returned
  82      * has no meaning in itself and especially should not be used to identity a certain
  83      * status value; it is only meaningful when compared to another value returned from
  84      * this method.
  85      */
  86     public static int getStatusOrder(final String status) {
  87         switch (status) {
  88             case CURRENT:
  89                 return 20;
  90             case DEPRECATED:
  91                 return 30;
  92             case OBSOLETE:
  93                 return 40;
  94         }
  95
  96         return 0;
  97     }
  98
  99     protected void validate(final ParserExecutionContext context) {
 100         if (!validateArgumentNotNullNotEmpty(context)) {
 101             /* no point trying to perform more validation */
 102             return;
 103         }
 104
 105         if (!isCurrent() && !isDeprecated() && !isObsolete()) {
 106             context.addFinding(new Finding(this, ParserFindingType.P015_INVALID_SYNTAX_IN_DOCUMENT,
 107                     "'" + getValue() + "' is not a valid status. Use one of: current, deprecated, obsolete."));
 108         }
 109     }
 110 }