appc-common/src/main/java/org/openecomp/appc/util/MessageFormatter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.openecomp.appc.util;
  26
  27 import org.apache.commons.lang3.StringUtils;
  28
  29 import java.util.*;
  30 import java.util.regex.Matcher;
  31 import java.util.regex.Pattern;
  32
  33
  34 public class MessageFormatter {
  35     private final static String paramNameRegexGroupName = "paramName";
  36     private final static String paramRegex = "\\$\\{(?<paramName>[^}$]+)\\}"; //start with ${ and after there is one or more characters that are not $ and not } and ended with }
  37
  38
  39     public static  String format(String messageTemplate, Map<String,Object> params) {
  40         if (StringUtils.isEmpty(messageTemplate))
  41             return "";
  42         if (params == null || params.isEmpty())
  43             return messageTemplate;
  44
  45         String formattedMessage = messageTemplate;
  46         if (formattedMessage.contains("$")) {
  47             for (Map.Entry<String, Object> entry : params.entrySet()) {
  48                 formattedMessage = formattedMessage.replaceAll("\\$\\{" + entry.getKey() + "\\}", String.valueOf(entry.getValue()));
  49             }
  50         }
  51
  52         return formattedMessage;
  53     }
  54
  55     public static List<String> getParamsNamesList(String messageTemplate) {
  56         List<String> paramsNames = null;
  57         if(!StringUtils.isEmpty(messageTemplate)){
  58             paramsNames = new ArrayList<String>();
  59             Matcher m = Pattern.compile(paramRegex).matcher(messageTemplate);
  60             while (m.find()) {
  61                 String paramName = m.group(paramNameRegexGroupName);
  62                 paramsNames.add(paramName);
  63             }
  64         }
  65         return paramsNames;
  66     }
  67     public static Set<String> getParamsNamesSet(String messageTemplate) {
  68         List<String> paramsNamesList = getParamsNamesList(messageTemplate);
  69         Set<String> paramsNamesSet = null;
  70         if(paramsNamesList != null && !paramsNamesList.isEmpty()){
  71             paramsNamesSet = new HashSet<String>();
  72             for(String paramName : paramsNamesList){
  73                 paramsNamesSet.add(paramName);
  74             }
  75         }
  76         return paramsNamesSet;
  77     }
  78 }