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.util;
  22
  23 import java.util.Collection;
  24 import java.util.Iterator;
  25 import java.util.Objects;
  26
  27 import org.oran.smo.yangtools.parser.model.statements.AbstractStatement;
  28
  29 /**
  30  * Some utility methods used in various places, mostly for info texts.
  31  *
  32  * @author Mark Hollmann
  33  */
  34 public abstract class StringHelper {
  35
  36     public static String getModuleNameAndRevision(final String moduleName, final String revision) {
  37
  38         final StringBuilder sb = new StringBuilder();
  39
  40         sb.append("'");
  41         sb.append(Objects.requireNonNull(moduleName));
  42
  43         if (revision != null && !revision.isEmpty()) {
  44             sb.append('/');
  45             sb.append(revision);
  46         }
  47         sb.append("'");
  48
  49         return sb.toString();
  50     }
  51
  52     public static String getModuleLineString(final AbstractStatement statement) {
  53
  54         final StringBuilder sb = new StringBuilder();
  55
  56         if (statement.getDomElement().getYangModel().getYangModelRoot().isModule()) {
  57             sb.append("module '");
  58         } else {
  59             sb.append("submodule '");
  60         }
  61
  62         sb.append(statement.getDomElement().getYangModel().getYangModelRoot().getModuleOrSubModuleName());
  63         sb.append("' (line ");
  64         sb.append(statement.getDomElement().getLineNumber());
  65         sb.append(')');
  66
  67         return sb.toString();
  68     }
  69
  70     /**
  71      * Utility to assemble from a collection a nicely formatted string based on some separation sequences.
  72      * The order of elements will be taken from the collection iterator.
  73      */
  74     public static <T extends Object> String toString(final Collection<T> list, final String start, final String end,
  75             final String elemSep, final String elemStart, final String elemEnd) {
  76
  77         final StringBuilder sb = new StringBuilder();
  78
  79         if (start != null) {
  80             sb.append(start);
  81         }
  82
  83         boolean first = true;
  84         final Iterator<T> iter = list.iterator();
  85
  86         while (iter.hasNext()) {
  87
  88             if (!first && elemSep != null) {
  89                 sb.append(elemSep);
  90             }
  91
  92             if (elemStart != null) {
  93                 sb.append(elemStart);
  94             }
  95
  96             sb.append(iter.next().toString());
  97
  98             if (elemEnd != null) {
  99                 sb.append(elemEnd);
 100             }
 101
 102             first = false;
 103         }
 104
 105         if (end != null) {
 106             sb.append(end);
 107         }
 108
 109         return sb.toString();
 110     }
 111 }