Fix checkstyle in mdsal-binding2-java-api-generator
[mdsal.git] / binding2 / mdsal-binding2-java-api-generator / src / main / java / org / opendaylight / mdsal / binding / javav2 / java / api / generator / renderers / BaseRenderer.java
index a246fc67d3ec44ecda8989673c984955f737e59c..c7b66e927df363d5e4f624d7191ada94adffae3c 100644 (file)
@@ -9,23 +9,19 @@
 package org.opendaylight.mdsal.binding.javav2.java.api.generator.renderers;
 
 import static com.google.common.base.Preconditions.checkArgument;
-import static org.opendaylight.mdsal.binding.javav2.util.BindingMapping.PATTERN_CONSTANT_NAME;
 
 import com.google.common.base.Preconditions;
-import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
-import java.util.ArrayList;
+
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
-import org.apache.commons.text.StringEscapeUtils;
+
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
 import org.opendaylight.mdsal.binding.javav2.java.api.generator.util.TextTemplateUtil;
-import org.opendaylight.mdsal.binding.javav2.model.api.Constant;
 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedProperty;
 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
@@ -33,33 +29,33 @@ import org.opendaylight.mdsal.binding.javav2.model.api.MethodSignature;
 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
 import org.opendaylight.mdsal.binding.javav2.model.api.WildcardType;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.common.Revision;
+
+
 
 public abstract class BaseRenderer {
     private static final String COMMA = ",";
     private static final String DOT = ".";
 
-    private final GeneratedType type;
+    private final GeneratedType genType;
     private final Map<String, String> importMap;
     /**
-     * list of all imported names for template
+     * list of all imported names for template.
      */
     private final Map<String, String> importedNames = new HashMap<>();
 
     protected BaseRenderer(final GeneratedType type) {
-        this.type = Preconditions.checkNotNull(type);
+        this.genType = Preconditions.checkNotNull(type);
         this.importMap = new HashMap<>();
     }
 
     /**
-     * Implementation needs to call Scala template render() method to generate string body
+     * Implementation needs to call Scala template render() method to generate string body.
      * @return rendered body
      */
     protected abstract String body();
 
     protected GeneratedType getType() {
-        return type;
+        return genType;
     }
 
     protected Map<String, String> getImportedNames() {
@@ -83,12 +79,13 @@ public abstract class BaseRenderer {
     }
 
     /**
+     * Return string with type name for type in the full format or in the short format.
      * @param intype type to format and add to imports
      * @return formatted type
      */
     protected String importedName(final Type intype) {
-        putTypeIntoImports(type, intype);
-        return getExplicitType(type, intype);
+        putTypeIntoImports(genType, intype);
+        return getExplicitType(genType, intype);
     }
 
     protected String importedName(final Class<?> cls) {
@@ -96,18 +93,19 @@ public abstract class BaseRenderer {
     }
 
     /**
+     * Generate package definition for template.
      * @return package definition for template
      */
     protected String packageDefinition() {
         final StringBuilder sb = new StringBuilder();
         sb.append("package ")
-                .append(type.getPackageName())
+                .append(genType.getPackageName())
                 .append(";\n\n");
         return sb.toString();
     }
 
     /**
-     * walks through map of imports
+     * walks through map of imports.
      * @return string of imports for template
      */
     private String imports() {
@@ -148,12 +146,12 @@ public abstract class BaseRenderer {
     }
 
     /**
-     * Checks if package of generated type and imported type is the same
+     * Checks if package of generated type and imported type is the same.
      * @param importedTypePackageName imported types package name
      * @return equals packages
      */
     protected boolean hasSamePackage(final String importedTypePackageName) {
-        return type.getPackageName().equals(importedTypePackageName);
+        return genType.getPackageName().equals(importedTypePackageName);
     }
 
     /**
@@ -234,7 +232,8 @@ public abstract class BaseRenderer {
      * @param parentGenType generated type which contains type
      * @return adds actual type parameters to builder
      */
-    private StringBuilder addActualTypeParameters(final StringBuilder sb, final Type type, final GeneratedType parentGenType) {
+    private StringBuilder addActualTypeParameters(final StringBuilder sb, final Type type,
+            final GeneratedType parentGenType) {
         if (type instanceof ParameterizedType) {
             final ParameterizedType pType = (ParameterizedType) type;
             final Type[] pTypes = pType.getActualTypeArguments();
@@ -259,22 +258,22 @@ public abstract class BaseRenderer {
     }
 
     /**
-     * Generates the string with all actual type parameters from
+     * Generates the string with all actual type parameters from.
      *
      * @param parentGenType generated type for which is the JAVA code generated
-     * @param pTypes array of Type instances = actual type parameters
-     * @return string with all actual type parameters from pTypes
+     * @param types array of Type instances = actual type parameters
+     * @return string with all actual type parameters from types
      */
-    private String getParameters(final GeneratedType parentGenType, final Type[] pTypes) {
-        if (pTypes == null || pTypes.length == 0) {
+    private String getParameters(final GeneratedType parentGenType, final Type[] types) {
+        if (types == null || types.length == 0) {
             return "?";
         }
         final StringBuilder sb = new StringBuilder();
-        for (int i = 0; i < pTypes.length; i++) {
-            final Type t = pTypes[i];
+        for (int i = 0; i < types.length; i++) {
+            final Type t = types[i];
 
             String separator = COMMA;
-            if (i == pTypes.length - 1) {
+            if (i == types.length - 1) {
                 separator = "";
             }
 
@@ -318,7 +317,7 @@ public abstract class BaseRenderer {
     }
 
     /**
-     * Template method which generates the getter method for field
+     * Template method which generates the getter method for field.
      *
      * @param field generated property with data about field which is generated as the getter method
      * @return string with the getter method source code in JAVA format
@@ -345,7 +344,7 @@ public abstract class BaseRenderer {
     }
 
     /**
-     * builds template
+     * builds template.
      * @return generated final template
      */
     public String generateTemplate() {