Update the API generation code and code generation sample
[controller.git] / opendaylight / sal / yang-prototype / code-generator / binding-java-api-generator / src / main / java / org / opendaylight / controller / sal / java / api / generator / GeneratorUtil.java
index 673d37e86b532cd6fa2fcf506d00e3b014bd384f..a4018a5d5cb8943226e88731d71261f4d9dcd4e5 100644 (file)
  */\r
 package org.opendaylight.controller.sal.java.api.generator;\r
 \r
-import static org.opendaylight.controller.sal.java.api.generator.Constants.*;\r
-\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.CLASS;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.COMMA;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.ENUM;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.FINAL;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.GAP;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.IFC;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.LB;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.LCB;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.NL;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.PKG;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.PRIVATE;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.PUBLIC;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.RB;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.RCB;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.SC;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.STATIC;\r
+import static org.opendaylight.controller.sal.java.api.generator.Constants.TAB;\r
+\r
+import java.util.Arrays;\r
+import java.util.HashSet;\r
 import java.util.List;\r
+import java.util.Set;\r
 \r
 import org.opendaylight.controller.sal.binding.model.api.Constant;\r
 import org.opendaylight.controller.sal.binding.model.api.Enumeration;\r
+import org.opendaylight.controller.sal.binding.model.api.Enumeration.Pair;\r
+import org.opendaylight.controller.sal.binding.model.api.GeneratedProperty;\r
+import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject;\r
 import org.opendaylight.controller.sal.binding.model.api.MethodSignature;\r
+import org.opendaylight.controller.sal.binding.model.api.MethodSignature.Parameter;\r
 import org.opendaylight.controller.sal.binding.model.api.ParameterizedType;\r
 import org.opendaylight.controller.sal.binding.model.api.Type;\r
-import org.opendaylight.controller.sal.binding.model.api.Enumeration.Pair;\r
-import org.opendaylight.controller.sal.binding.model.api.MethodSignature.Parameter;\r
 \r
 public class GeneratorUtil {\r
 \r
+    private static final String[] SET_VALUES = new String[] { "abstract",\r
+            "assert", "boolean", "break", "byte", "case", "catch", "char",\r
+            "class", "const", "continue", "default", "double", "do", "else",\r
+            "enum", "extends", "false", "final", "finally", "float", "for",\r
+            "goto", "if", "implements", "import", "instanceof", "int",\r
+            "interface", "long", "native", "new", "null", "package", "private",\r
+            "protected", "public", "return", "short", "static", "strictfp",\r
+            "super", "switch", "synchronized", "this", "throw", "throws",\r
+            "transient", "true", "try", "void", "volatile", "while" };\r
+\r
+    public static final Set<String> JAVA_RESERVED_WORDS = new HashSet<String>(\r
+            Arrays.asList(SET_VALUES));\r
+\r
     private GeneratorUtil() {\r
     }\r
 \r
-    public static String createIfcDeclarationWithPkgName(String packageName,\r
-            String name, String indent) {\r
-        return createFileDeclarationWithPkgName(IFC, packageName, name, indent);\r
+    private static String validateParamName(final String paramName) {\r
+        if (paramName != null) {\r
+            if (JAVA_RESERVED_WORDS.contains(paramName)) {\r
+                return "_" + paramName;\r
+            }\r
+        }\r
+        return paramName;\r
+    }\r
+\r
+    public static String createIfcDeclarationWithPkgName(\r
+            final String packageName, final String name, final String indent) {\r
+        return createFileDeclarationWithPkgName(IFC,\r
+                packageName, validateParamName(name), indent);\r
     }\r
 \r
-    public static String createClassDeclarationWithPkgName(String packageName,\r
-            String name, String indent) {\r
-        return createFileDeclarationWithPkgName(CLASS, packageName, name,\r
-                indent);\r
+    public static String createClassDeclarationWithPkgName(\r
+            final String packageName, final String name, final String indent) {\r
+        return createFileDeclarationWithPkgName(CLASS,\r
+                packageName, validateParamName(name), indent);\r
     }\r
 \r
-    private static String createFileDeclarationWithPkgName(String type,\r
-            String packageName, String name, String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
-        sb.append(PKG + GAP + packageName + SC);\r
-        sb.append(NL);\r
-        sb.append(NL);\r
-        sb.append(PUBLIC + GAP + type + GAP + name + GAP + LCB);\r
-        return sb.toString();\r
+    private static String createFileDeclarationWithPkgName(final String type,\r
+            final String packageName, final String name, final String indent) {\r
+        final StringBuilder builder = new StringBuilder();\r
+        builder.append(PKG + GAP + packageName + SC);\r
+        builder.append(NL);\r
+        builder.append(NL);\r
+        builder.append(PUBLIC + GAP + type + GAP + validateParamName(name) + GAP + LCB);\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createConstant(Constant constant, String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
-        sb.append(indent + PUBLIC + GAP + STATIC + GAP + FINAL + GAP);\r
-        sb.append(getExplicitType(constant.getType()) + GAP\r
+    public static String createConstant(final Constant constant,\r
+            final String indent) {\r
+        final StringBuilder builder = new StringBuilder();\r
+        builder.append(indent + PUBLIC + GAP + STATIC + GAP + FINAL + GAP);\r
+        builder.append(getExplicitType(constant.getType()) + GAP\r
                 + constant.getName());\r
-        sb.append(GAP + "=" + GAP);\r
-        sb.append(constant.getValue() + SC);\r
-        return sb.toString();\r
+        builder.append(GAP + "=" + GAP);\r
+        builder.append(constant.getValue() + SC);\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createField(Constant field, String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
-        sb.append(indent + PRIVATE + GAP);\r
-        sb.append(getExplicitType(field.getType()) + GAP + field.getName());\r
-        sb.append(GAP + "=" + GAP);\r
-        sb.append(field.getValue() + SC);\r
-        return sb.toString();\r
+    public static String createField(final GeneratedProperty property,\r
+            final String indent) {\r
+        final StringBuilder builder = new StringBuilder();\r
+        builder.append(indent + PRIVATE + GAP);\r
+        builder.append(getExplicitType(property.getReturnType()) + GAP\r
+                + property.getName());\r
+        builder.append(SC);\r
+        return builder.toString();\r
     }\r
 \r
     /**\r
@@ -71,197 +117,271 @@ public class GeneratorUtil {
      * @param indent\r
      * @return\r
      */\r
-    public static String createMethodDeclaration(MethodSignature method,\r
-            String indent) {\r
-        String comment = method.getComment();\r
-        Type type = method.getReturnType();\r
-        String name = method.getName();\r
-        List<Parameter> parameters = method.getParameters();\r
-\r
-        StringBuilder sb = new StringBuilder();\r
-        createComment(sb, comment, indent);\r
-\r
-        sb.append(indent + getExplicitType(type) + GAP + name);\r
-        sb.append(LB);\r
+    public static String createMethodDeclaration(final MethodSignature method,\r
+            final String indent) {\r
+        final String comment = method.getComment();\r
+        final Type type = method.getReturnType();\r
+        final String name = method.getName();\r
+        final List<Parameter> parameters = method.getParameters();\r
+\r
+        final StringBuilder builder = new StringBuilder();\r
+        createComment(builder, comment, indent);\r
+\r
+        builder.append(indent + getExplicitType(type) + GAP + name);\r
+        builder.append(LB);\r
         for (int i = 0; i < parameters.size(); i++) {\r
             Parameter p = parameters.get(i);\r
             String separator = COMMA;\r
             if (i + 1 == parameters.size()) {\r
                 separator = "";\r
             }\r
-            sb.append(getExplicitType(p.getType()) + GAP + p.getName()\r
+            builder.append(getExplicitType(p.getType()) + GAP + validateParamName(p.getName())\r
                     + separator);\r
         }\r
-        sb.append(RB);\r
-        sb.append(SC);\r
+        builder.append(RB);\r
+        builder.append(SC);\r
+\r
+        return builder.toString();\r
+    }\r
+\r
+    public static String createConstructor(\r
+            GeneratedTransferObject genTransferObject, final String indent) {\r
+        final StringBuilder builder = new StringBuilder();\r
+\r
+        final List<GeneratedProperty> properties = genTransferObject\r
+                .getProperties();\r
+        builder.append(indent);\r
+        builder.append(PUBLIC);\r
+        builder.append(GAP);\r
+        builder.append(genTransferObject.getName());\r
+        builder.append(LB);\r
+\r
+        boolean first = true;\r
+        if (properties != null) {\r
+            for (final GeneratedProperty property : properties) {\r
+                if (first) {\r
+                    builder.append(getExplicitType(property.getReturnType()));\r
+                    builder.append(" ");\r
+                    builder.append(property.getName());\r
+                    first = false;\r
+                } else {\r
+                    builder.append(", ");\r
+                    builder.append(getExplicitType(property.getReturnType()));\r
+                    builder.append(builder.append(" "));\r
+                    builder.append(property.getName());\r
+                }\r
+            }\r
+        }\r
+\r
+        builder.append(RB);\r
+        builder.append(GAP);\r
+        builder.append(LCB);\r
+        builder.append(NL);\r
+        builder.append(indent);\r
+        builder.append(TAB);\r
+        builder.append("super();");\r
+        builder.append(NL);\r
+\r
+        if (properties != null) {\r
+            for (final GeneratedProperty property : properties) {\r
+                builder.append(indent);\r
+                builder.append(TAB);\r
+                builder.append("this.");\r
+                builder.append(property.getName());\r
+                builder.append(" = ");\r
+                builder.append(property.getName());\r
+                builder.append(SC);\r
+                builder.append(NL);\r
+            }\r
+        }\r
+\r
+        builder.append(indent);\r
+        builder.append(RCB);\r
 \r
-        return sb.toString();\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createGetter(Constant field, String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
+    public static String createGetter(final GeneratedProperty property,\r
+            final String indent) {\r
+        final StringBuilder builder = new StringBuilder();\r
 \r
-        Type type = field.getType();\r
-        String varName = field.getName();\r
-        char first = Character.toUpperCase(varName.charAt(0));\r
-        String methodName = "get" + first + varName.substring(1);\r
+        final Type type = property.getReturnType();\r
+        final String varName = property.getName();\r
+        final char first = Character.toUpperCase(varName.charAt(0));\r
+        final String methodName = "get" + first + varName.substring(1);\r
 \r
-        sb.append(indent + PUBLIC + GAP + getExplicitType(type) + GAP\r
+        builder.append(indent + PUBLIC + GAP + getExplicitType(type) + GAP\r
                 + methodName);\r
-        sb.append(LB + RB + LCB + NL);\r
+        builder.append(LB + RB + LCB + NL);\r
 \r
         String currentIndent = indent + TAB;\r
 \r
-        sb.append(currentIndent + "return " + varName + SC + NL);\r
+        builder.append(currentIndent + "return " + varName + SC + NL);\r
 \r
-        sb.append(indent + RCB);\r
-        return sb.toString();\r
+        builder.append(indent + RCB);\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createHashCode(List<Constant> fields, String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
-        sb.append(indent + "public int hashCode() {" + NL);\r
-        sb.append(indent + TAB + "final int prime = 31;" + NL);\r
-        sb.append(indent + TAB + "int result = 1;" + NL);\r
-\r
-        for (Constant field : fields) {\r
-            String fieldName = field.getName();\r
-            sb.append(indent + TAB + "result = prime * result + ((" + fieldName\r
-                    + " == null) ? 0 : " + fieldName + ".hashCode());" + NL);\r
+    public static String createHashCode(\r
+            final List<GeneratedProperty> properties, final String indent) {\r
+        StringBuilder builder = new StringBuilder();\r
+        builder.append(indent + "public int hashCode() {" + NL);\r
+        builder.append(indent + TAB + "final int prime = 31;" + NL);\r
+        builder.append(indent + TAB + "int result = 1;" + NL);\r
+\r
+        for (GeneratedProperty property : properties) {\r
+            String fieldName = property.getName();\r
+            builder.append(indent + TAB + "result = prime * result + (("\r
+                    + fieldName + " == null) ? 0 : " + fieldName\r
+                    + ".hashCode());" + NL);\r
         }\r
 \r
-        sb.append(indent + TAB + "return result;" + NL);\r
-        sb.append(indent + RCB + NL);\r
-        return sb.toString();\r
+        builder.append(indent + TAB + "return result;" + NL);\r
+        builder.append(indent + RCB + NL);\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createEquals(Type type, List<Constant> fields,\r
-            String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
+    public static String createEquals(final GeneratedTransferObject type,\r
+            final List<GeneratedProperty> properties, final String indent) {\r
+        StringBuilder builder = new StringBuilder();\r
         final String indent1 = indent + TAB;\r
         final String indent2 = indent + TAB + TAB;\r
         final String indent3 = indent + TAB + TAB + TAB;\r
 \r
-        sb.append(indent + "public boolean equals(Object obj) {" + NL);\r
-        sb.append(indent1 + "if (this == obj) {" + NL);\r
-        sb.append(indent2 + "return true;" + NL);\r
-        sb.append(indent1 + "}" + NL);\r
-        sb.append(indent1 + "if (obj == null) {" + NL);\r
-        sb.append(indent2 + "return false;" + NL);\r
-        sb.append(indent1 + "}" + NL);\r
-        sb.append(indent1 + "if (getClass() != obj.getClass()) {" + NL);\r
-        sb.append(indent2 + "return false;" + NL);\r
-        sb.append(indent1 + "}" + NL);\r
+        builder.append(indent + "public boolean equals(Object obj) {" + NL);\r
+        builder.append(indent1 + "if (this == obj) {" + NL);\r
+        builder.append(indent2 + "return true;" + NL);\r
+        builder.append(indent1 + "}" + NL);\r
+        builder.append(indent1 + "if (obj == null) {" + NL);\r
+        builder.append(indent2 + "return false;" + NL);\r
+        builder.append(indent1 + "}" + NL);\r
+        builder.append(indent1 + "if (getClass() != obj.getClass()) {" + NL);\r
+        builder.append(indent2 + "return false;" + NL);\r
+        builder.append(indent1 + "}" + NL);\r
 \r
         String typeStr = type.getPackageName() + "." + type.getName();\r
-        sb.append(indent1 + typeStr + " other = (" + typeStr + ") obj;" + NL);\r
-\r
-        for (Constant field : fields) {\r
-            String fieldName = field.getName();\r
-            sb.append(indent1 + "if (" + fieldName + " == null) {" + NL);\r
-            sb.append(indent2 + "if (other." + fieldName + " != null) {" + NL);\r
-            sb.append(indent3 + "return false;" + NL);\r
-            sb.append(indent2 + "}" + NL);\r
-            sb.append(indent1 + "} else if (!" + fieldName + ".equals(other."\r
-                    + fieldName + ")) {" + NL);\r
-            sb.append(indent2 + "return false;" + NL);\r
-            sb.append(indent1 + "}" + NL);\r
+        builder.append(indent1 + typeStr + " other = (" + typeStr + ") obj;"\r
+                + NL);\r
+\r
+        for (GeneratedProperty property : properties) {\r
+            String fieldName = property.getName();\r
+            builder.append(indent1 + "if (" + fieldName + " == null) {" + NL);\r
+            builder.append(indent2 + "if (other." + fieldName + " != null) {"\r
+                    + NL);\r
+            builder.append(indent3 + "return false;" + NL);\r
+            builder.append(indent2 + "}" + NL);\r
+            builder.append(indent1 + "} else if (!" + fieldName\r
+                    + ".equals(other." + fieldName + ")) {" + NL);\r
+            builder.append(indent2 + "return false;" + NL);\r
+            builder.append(indent1 + "}" + NL);\r
         }\r
 \r
-        sb.append(indent1 + "return true;" + NL);\r
+        builder.append(indent1 + "return true;" + NL);\r
 \r
-        sb.append(indent + RCB + NL);\r
-        return sb.toString();\r
+        builder.append(indent + RCB + NL);\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createToString(Type type, List<Constant> fields,\r
-            String indent) {\r
-        StringBuilder sb = new StringBuilder();\r
-        String typeStr = type.getPackageName() + "." + type.getName();\r
-\r
-        sb.append(indent + "public String toString() {" + NL);\r
-        sb.append(indent + TAB + "return \"" + typeStr + "[");\r
+    public static String createToString(final GeneratedTransferObject type,\r
+            final List<GeneratedProperty> properties, final String indent) {\r
+        StringBuilder builder = new StringBuilder();\r
+        builder.append(indent);\r
+        builder.append("public String toString() {");\r
+        builder.append(NL);\r
+        builder.append(indent);\r
+        builder.append(TAB);\r
+        builder.append("StringBuilder builder = new StringBuilder();");\r
+        builder.append(NL);\r
+        builder.append(indent);\r
+        builder.append(TAB);\r
+        builder.append("builder.append(\"");\r
+        builder.append(type.getName());\r
+        builder.append(" [");\r
 \r
         boolean first = true;\r
-        for (Constant field : fields) {\r
-            String fieldName = field.getName();\r
-            String fieldType = field.getType().getPackageName() + "."\r
-                    + field.getType().getName();\r
+        for (GeneratedProperty property : properties) {\r
             if (first) {\r
-                if (fieldType.equals("java.lang.String")) {\r
-                    sb.append(fieldName + "=\\\""\r
-                            + parseStringValue((String) field.getValue())\r
-                            + "\\\"");\r
-                } else {\r
-                    sb.append(fieldName + "=" + field.getValue() + "");\r
-                }\r
+                builder.append(property.getName());\r
+                builder.append("=\");");\r
+                builder.append(NL);\r
+                builder.append(indent);\r
+                builder.append(TAB);\r
+                builder.append("builder.append(");\r
+                builder.append(property.getName());\r
+                builder.append(");");\r
+                first = false;\r
             } else {\r
-                if (fieldType.equals("java.lang.String")) {\r
-                    sb.append(", " + fieldName + "=\\\""\r
-                            + parseStringValue((String) field.getValue())\r
-                            + "\\\"");\r
-                } else {\r
-                    sb.append(", " + fieldName + "=" + field.getValue() + "");\r
-                }\r
-\r
+                builder.append(NL);\r
+                builder.append(indent);\r
+                builder.append(TAB);\r
+                builder.append("builder.append(\", ");\r
+                builder.append(property.getName());\r
+                builder.append("=\");");\r
+                builder.append(NL);\r
+                builder.append(indent);\r
+                builder.append(TAB);\r
+                builder.append("builder.append(\", ");\r
+                builder.append(property.getName());\r
+                builder.append(");");\r
             }\r
-            first = false;\r
         }\r
-        sb.append("]\"" + SC + NL);\r
-\r
-        sb.append(indent + RCB + NL);\r
-        return sb.toString();\r
-    }\r
-\r
-    /**\r
-     * Remove starting and ending quote sign\r
-     * \r
-     * @param o\r
-     * @return\r
-     */\r
-    private static String parseStringValue(String str) {\r
-        return str.substring(1, str.length() - 1);\r
+        builder.append(NL);\r
+        builder.append(indent);\r
+        builder.append(TAB);\r
+        builder.append("builder.append(\"]\");");\r
+        builder.append(NL);\r
+        builder.append(indent);\r
+        builder.append(TAB);\r
+        builder.append("return builder.toString();");\r
+\r
+        builder.append(NL);\r
+        builder.append(indent);\r
+        builder.append(RCB);\r
+        builder.append(NL);\r
+        return builder.toString();\r
     }\r
 \r
-    public static String createEnum(Enumeration e, String indent) {\r
-        StringBuilder sb = new StringBuilder(indent + ENUM + GAP + e.getName()\r
-                + GAP + LCB + NL);\r
+    public static String createEnum(final Enumeration enumeration,\r
+            final String indent) {\r
+        final StringBuilder builder = new StringBuilder(indent + ENUM + GAP\r
+                + enumeration.getName() + GAP + LCB + NL);\r
 \r
         String separator = COMMA;\r
-        List<Pair> values = e.getValues();\r
-        sb.append(indent + TAB);\r
+        final List<Pair> values = enumeration.getValues();\r
+        builder.append(indent + TAB);\r
         for (int i = 0; i < values.size(); i++) {\r
             if (i + 1 == values.size()) {\r
                 separator = SC;\r
             }\r
-            sb.append(values.get(i).getName() + separator);\r
+            builder.append(values.get(i).getName() + separator);\r
         }\r
-        sb.append(NL);\r
-        sb.append(indent + RCB);\r
-        return sb.toString();\r
+        builder.append(NL);\r
+        builder.append(indent + RCB);\r
+        return builder.toString();\r
     }\r
 \r
-    private static String getExplicitType(Type type) {\r
+    private static String getExplicitType(final Type type) {\r
         String packageName = type.getPackageName();\r
         if (packageName.endsWith(".")) {\r
             packageName = packageName.substring(0, packageName.length() - 1);\r
         }\r
-        StringBuilder sb = new StringBuilder(packageName + "." + type.getName());\r
+        final StringBuilder builder = new StringBuilder(packageName + "."\r
+                + type.getName());\r
         if (type instanceof ParameterizedType) {\r
             ParameterizedType pType = (ParameterizedType) type;\r
             Type[] pTypes = pType.getActualTypeArguments();\r
-            sb.append("<");\r
-            sb.append(getParameters(pTypes));\r
-            sb.append(">");\r
+            builder.append("<");\r
+            builder.append(getParameters(pTypes));\r
+            builder.append(">");\r
         }\r
-        if (sb.toString().equals("java.lang.Void")) {\r
+        if (builder.toString().equals("java.lang.Void")) {\r
             return "void";\r
         }\r
-        return sb.toString();\r
+        return builder.toString();\r
     }\r
 \r
-    private static String getParameters(Type[] pTypes) {\r
-        StringBuilder sb = new StringBuilder();\r
+    private static String getParameters(final Type[] pTypes) {\r
+        final StringBuilder builder = new StringBuilder();\r
         for (int i = 0; i < pTypes.length; i++) {\r
             Type t = pTypes[i];\r
 \r
@@ -269,17 +389,17 @@ public class GeneratorUtil {
             if (i + 1 == pTypes.length) {\r
                 separator = "";\r
             }\r
-            sb.append(getExplicitType(t) + separator);\r
+            builder.append(getExplicitType(t) + separator);\r
         }\r
-        return sb.toString();\r
+        return builder.toString();\r
     }\r
 \r
-    private static void createComment(StringBuilder sb, String comment,\r
-            String indent) {\r
+    private static void createComment(final StringBuilder builder,\r
+            final String comment, final String indent) {\r
         if (comment != null && comment.length() > 0) {\r
-            sb.append(indent + "/*" + NL);\r
-            sb.append(indent + comment + NL);\r
-            sb.append(indent + "*/" + NL);\r
+            builder.append(indent + "/*" + NL);\r
+            builder.append(indent + comment + NL);\r
+            builder.append(indent + "*/" + NL);\r
         }\r
     }\r
 \r