BpGen refactor Code Quality Issue-ID: DCAEGEN2-2502

Issue-ID: DCAEGEN2-2502
Change-Id: If6e08f0bb88c9039fb27898d50d2645f79175ba4
Signed-off-by: Ravi Mantena <rx908f@att.com>

1 files changed, 173 insertions, 78 deletions

diff --git a/mod/bpgenerator/common/src/main/java/org/onap/blueprintgenerator/service/base/BlueprintHelperService.java b/mod/bpgenerator/common/src/main/java/org/onap/blueprintgenerator/service/base/BlueprintHelperService.java
index 1f6b4f8..db15360 100644
--- a/mod/bpgenerator/common/src/main/java/org/onap/blueprintgenerator/service/base/BlueprintHelperService.java
+++ b/mod/bpgenerator/common/src/main/java/org/onap/blueprintgenerator/service/base/BlueprintHelperService.java
@@ -23,7 +23,6 @@
 
 package org.onap.blueprintgenerator.service.base;
 
-
 import org.onap.blueprintgenerator.constants.Constants;
 import org.springframework.stereotype.Service;
 
@@ -31,88 +30,184 @@ import java.util.LinkedHashMap;
 
 /**
  * @author : Ravi Mantena
- * @date 10/16/2020
- * Application: DCAE/ONAP - Blueprint Generator
- * Common Module: Used by both ONAp and DCAE Blueprint Applications
- * Service: For Common Functions used across
+ * @date 10/16/2020 Application: DCAE/ONAP - Blueprint Generator Common Module: Used by both ONAp
+ * and DCAE Blueprint Applications Service: An interface for Common Functions used across Blueprint
  */
-
 @Service
 public class BlueprintHelperService {
 
-
-  public LinkedHashMap<String, Object> createInputValue(String type, String description, Object defaultValue) {
-    LinkedHashMap<String, Object> inputMap = new LinkedHashMap<>();
-    inputMap.put("type", type);
-    inputMap.put("description", description);
-    inputMap.put("default", defaultValue);
-    return inputMap;
-  }
-
-  public LinkedHashMap<String, Object> createInputValue(String type, String description) {
-    LinkedHashMap<String, Object> inputMap = new LinkedHashMap<>();
-    inputMap.put("type", type);
-    inputMap.put("description", description);
-    return inputMap;
-  }
-
-  public LinkedHashMap<String, Object> createInputValue(String type, Object defaultValue) {
-    LinkedHashMap<String, Object> inputMap = new LinkedHashMap<>();
-    inputMap.put("type", type);
-    inputMap.put("default", defaultValue);
-    return inputMap;
-  }
-
-  public LinkedHashMap<String, Object> createIntegerInput(String description, Object defaultValue){
-    return createInputValue(Constants.INTEGER_TYPE, description, defaultValue);
-  }
-
-  public LinkedHashMap<String, Object> createIntegerInput(String description){
-    return createInputValue(Constants.INTEGER_TYPE, description);
-  }
-
-  public LinkedHashMap<String, Object> createIntegerInput(Object defaultValue){
-    return createInputValue(Constants.INTEGER_TYPE, defaultValue);
-  }
-
-  public LinkedHashMap<String, Object> createBooleanInput(String description, Object defaultValue){
-    return createInputValue(Constants.BOOLEAN_TYPE, description, defaultValue);
-  }
-
-  public LinkedHashMap<String, Object> createBooleanInput(String description){
-    return createInputValue(Constants.BOOLEAN_TYPE, description);
-  }
-
-  public LinkedHashMap<String, Object> createBooleanInput(Object defaultValue){
-    return createInputValue(Constants.BOOLEAN_TYPE, defaultValue);
-  }
-
-  public LinkedHashMap<String, Object> createStringInput(String description, Object defaultValue){
-    return createInputValue(Constants.STRING_TYPE, description, defaultValue);
-  }
-
-/*  public LinkedHashMap<String, Object> createStringInput(String description){
+    /**
+     * creates Input value by contatinating Type, Description and Default value
+     *
+     * @param type Input Type
+     * @param description Description
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createInputValue(
+        String type, String description, Object defaultValue) {
+        LinkedHashMap<String, Object> inputMap = new LinkedHashMap<>();
+        inputMap.put("type", type);
+        inputMap.put("description", description);
+        inputMap.put("default", defaultValue);
+        return inputMap;
+    }
+
+    /**
+     * creates Input value by contatinating Type and Description
+     *
+     * @param type Input Type
+     * @param description Description
+     * @return
+     */
+    public LinkedHashMap<String, Object> createInputValue(String type, String description) {
+        LinkedHashMap<String, Object> inputMap = new LinkedHashMap<>();
+        inputMap.put("type", type);
+        inputMap.put("description", description);
+        return inputMap;
+    }
+
+    /**
+     * creates Input value by contatinating Type and Default value
+     *
+     * @param type Input Type
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createInputValue(String type, Object defaultValue) {
+        LinkedHashMap<String, Object> inputMap = new LinkedHashMap<>();
+        inputMap.put("type", type);
+        inputMap.put("default", defaultValue);
+        return inputMap;
+    }
+
+    /**
+     * creates Input value by contatinating Description and Default value
+     *
+     * @param description Description
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createIntegerInput(String description,
+        Object defaultValue) {
+        return createInputValue(Constants.INTEGER_TYPE, description, defaultValue);
+    }
+
+    /**
+     * creates Integer Input value for given Description
+     *
+     * @param description Description
+     * @return
+     */
+    public LinkedHashMap<String, Object> createIntegerInput(String description) {
+        return createInputValue(Constants.INTEGER_TYPE, description);
+    }
+
+    /**
+     * creates Integer Input value for given Default value
+     *
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createIntegerInput(Object defaultValue) {
+        return createInputValue(Constants.INTEGER_TYPE, defaultValue);
+    }
+
+    /**
+     * creates Integer Input value for given Description and Default value
+     *
+     * @param description Description
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createBooleanInput(String description,
+        Object defaultValue) {
+        return createInputValue(Constants.BOOLEAN_TYPE, description, defaultValue);
+    }
+
+    /**
+     * creates Boolean Input value for given Description
+     *
+     * @param description Description
+     * @return
+     */
+    public LinkedHashMap<String, Object> createBooleanInput(String description) {
+        return createInputValue(Constants.BOOLEAN_TYPE, description);
+    }
+
+    /**
+     * creates Boolean Input value for given Default value
+     *
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createBooleanInput(Object defaultValue) {
+        return createInputValue(Constants.BOOLEAN_TYPE, defaultValue);
+    }
+
+    /**
+     * creates String Input value for given Default value
+     * @param description Description
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createStringInput(String description,
+        Object defaultValue) {
+        return createInputValue(Constants.STRING_TYPE, description, defaultValue);
+    }
+
+  /*  public LinkedHashMap<String, Object> createStringInput(String description){
     return createInputValue(Constants.STRING_TYPE, description);
   }*/
 
-  public LinkedHashMap<String, Object> createStringInput(Object defaultValue){
-    return createInputValue(Constants.STRING_TYPE, defaultValue);
-  }
-
-  public String joinUnderscore(String firstValue, String secondValue){
-    return firstValue + "_" + secondValue;
-  }
-
-  public boolean isDataRouterType(String type) {
-    return type.equals(Constants.DATA_ROUTER) || type.equals(Constants.DATAROUTER_VALUE);
-  }
-
-  public boolean isMessageRouterType(String type) {
-    return type.equals(Constants.MESSAGE_ROUTER) || type.equals(Constants.MESSAGEROUTER_VALUE);
-  }
-
-  public String getNamePrefix(String name) {
-    return name.isEmpty() ? "" : name + "_";
-  }
-
+    /**
+     * creates String Input value for given Default value
+     *
+     * @param defaultValue Default value of Type
+     * @return
+     */
+    public LinkedHashMap<String, Object> createStringInput(Object defaultValue) {
+        return createInputValue(Constants.STRING_TYPE, defaultValue);
+    }
+
+    /**
+     * Concatenates String Input values with Underscore
+     *
+     * @param firstValue Value
+     * @param secondValue Value
+     * @return
+     */
+    public String joinUnderscore(String firstValue, String secondValue) {
+        return firstValue + "_" + secondValue;
+    }
+
+    /**
+     * Returns if the type is Data Router or not
+     *
+     * @param type Input Type
+     * @return
+     */
+    public boolean isDataRouterType(String type) {
+        return type.equals(Constants.DATA_ROUTER) || type.equals(Constants.DATAROUTER_VALUE);
+    }
+
+    /**
+     * Returns if the type is Message Router or not
+     *
+     * @param type Input Type
+     * @return
+     */
+    public boolean isMessageRouterType(String type) {
+        return type.equals(Constants.MESSAGE_ROUTER) || type.equals(Constants.MESSAGEROUTER_VALUE);
+    }
+
+    /**
+     * Returns name with underscore for empty input
+     *
+     * @param name Name
+     * @return
+     */
+    public String getNamePrefix(String name) {
+        return name.isEmpty() ? "" : name + "_";
+    }
 }