Add @NonNull annotation to $YangModuleInfoImpl.qnameOf()
[mdsal.git] / binding / mdsal-binding-java-api-generator / src / main / java / org / opendaylight / mdsal / binding / java / api / generator / ClassTemplate.xtend
index dec2c5761e7ea197d7a930cafce00aa239021e59..c34953fd052f2fdab71844a159e2d4d5b3edc701 100644 (file)
@@ -8,40 +8,43 @@
 package org.opendaylight.mdsal.binding.java.api.generator
 
 import static java.util.Objects.requireNonNull
-import static extension org.apache.commons.text.StringEscapeUtils.escapeJava;
+import static org.opendaylight.mdsal.binding.model.util.Types.BOOLEAN;
+import static org.opendaylight.mdsal.binding.model.util.Types.BYTE_ARRAY;
+import static org.opendaylight.mdsal.binding.model.util.Types.STRING;
+import static extension org.apache.commons.text.StringEscapeUtils.escapeJava
 
+import com.google.common.base.Preconditions
 import com.google.common.collect.ImmutableList
 import com.google.common.collect.Lists
-import com.google.common.io.BaseEncoding
 import java.beans.ConstructorProperties
 import java.util.ArrayList
-import java.util.Arrays
-import java.util.Collections
+import java.util.Base64;
+import java.util.Comparator
 import java.util.List
 import java.util.Map
-import java.util.Objects
 import java.util.regex.Pattern
 import org.opendaylight.mdsal.binding.model.api.ConcreteType
 import org.opendaylight.mdsal.binding.model.api.Constant
 import org.opendaylight.mdsal.binding.model.api.Enumeration
 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty
 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
-import org.opendaylight.mdsal.binding.model.api.GeneratedType
 import org.opendaylight.mdsal.binding.model.api.Restrictions
 import org.opendaylight.mdsal.binding.model.api.Type
 import org.opendaylight.mdsal.binding.model.util.TypeConstants
 import org.opendaylight.yangtools.yang.binding.CodeHelpers
+import org.opendaylight.yangtools.yang.common.Empty
 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
 
 /**
  * Template for generating JAVA class.
  */
 class ClassTemplate extends BaseTemplate {
+    static val Comparator<GeneratedProperty> PROP_COMPARATOR = Comparator.comparing([prop | prop.name])
 
     protected val List<GeneratedProperty> properties
     protected val List<GeneratedProperty> finalProperties
     protected val List<GeneratedProperty> parentProperties
-    protected val Iterable<GeneratedProperty> allProperties;
+    protected val List<GeneratedProperty> allProperties
     protected val Restrictions restrictions
 
     /**
@@ -54,14 +57,9 @@ class ClassTemplate extends BaseTemplate {
      */
     protected val List<Constant> consts
 
-    /**
-     * List of generated types which are enclosed inside <code>genType</code>
-     */
-    protected val List<GeneratedType> enclosedGeneratedTypes;
+    protected val GeneratedTransferObject genTO
 
-    protected val GeneratedTransferObject genTO;
-
-    private val AbstractRangeGenerator<?> rangeGenerator
+    val AbstractRangeGenerator<?> rangeGenerator
 
     /**
      * Creates instance of this class with concrete <code>genType</code>.
@@ -69,24 +67,30 @@ class ClassTemplate extends BaseTemplate {
      * @param genType generated transfer object which will be transformed to JAVA class source code
      */
     new(GeneratedTransferObject genType) {
-        super(genType)
+        this(new TopLevelJavaGeneratedType(genType), genType)
+    }
+
+    /**
+     * Creates instance of this class with concrete <code>genType</code>.
+     *
+     * @param genType generated transfer object which will be transformed to JAVA class source code
+     */
+    new(AbstractJavaGeneratedType javaType, GeneratedTransferObject genType) {
+        super(javaType, genType)
         this.genTO = genType
         this.properties = genType.properties
         this.finalProperties = GeneratorUtil.resolveReadOnlyPropertiesFromTO(genTO.properties)
         this.parentProperties = GeneratorUtil.getPropertiesOfAllParents(genTO)
         this.restrictions = genType.restrictions
 
-        var List<GeneratedProperty> sorted = new ArrayList<GeneratedProperty>();
+        val sorted = new ArrayList();
         sorted.addAll(properties);
         sorted.addAll(parentProperties);
-        Collections.sort(sorted, [p1, p2|
-            p1.name.compareTo(p2.name)
-        ]);
+        sorted.sort(PROP_COMPARATOR);
 
         this.allProperties = sorted
         this.enums = genType.enumerations
         this.consts = genType.constantDefinitions
-        this.enclosedGeneratedTypes = genType.enclosedTypes
 
         if (restrictions !== null && restrictions.rangeConstraint.present) {
             rangeGenerator = requireNonNull(AbstractRangeGenerator.forType(findProperty(genType, "value").returnType))
@@ -180,13 +184,9 @@ class ClassTemplate extends BaseTemplate {
      * @return string with the source code for inner classes in JAVA format
      */
     def protected innerClassesDeclarations() '''
-        «IF !enclosedGeneratedTypes.empty»
-            «FOR innerClass : enclosedGeneratedTypes SEPARATOR "\n"»
-                «IF (innerClass instanceof GeneratedTransferObject)»
-                    «val classTemplate = new ClassTemplate(innerClass)»
-                    «classTemplate.generateAsInnerClass»
-                    «addImports(classTemplate)»
-                «ENDIF»
+        «IF !type.enclosedTypes.empty»
+            «FOR innerClass : type.enclosedTypes SEPARATOR "\n"»
+                «generateInnerClass(innerClass)»
             «ENDFOR»
         «ENDIF»
     '''
@@ -206,7 +206,7 @@ class ClassTemplate extends BaseTemplate {
     '''
 
     def protected allValuesConstructor() '''
-    «IF genTO.typedef && !allProperties.empty && allProperties.size == 1 && allProperties.get(0).name.equals("value")»
+    «IF genTO.typedef && allProperties.size == 1 && allProperties.get(0).name.equals("value")»
         @«ConstructorProperties.importedName»("value")
     «ENDIF»
     public «type.name»(«allProperties.asArgumentsDeclaration») {
@@ -221,25 +221,21 @@ class ClassTemplate extends BaseTemplate {
          * If we have patterns, we need to apply them to the value field. This is a sad
          * consequence of how this code is structured.
          */
-        IF genTO.typedef && !allProperties.empty && allProperties.size == 1 && allProperties.get(0).name.equals("value")»
-            «Objects.importedName».requireNonNull(_value, "Supplied value may not be null");
-            «FOR c : consts»
-                «IF c.name == TypeConstants.PATTERN_CONSTANT_NAME»
-                «CodeHelpers.importedName».checkPattern(_value, «Constants.MEMBER_PATTERN_LIST», «Constants.MEMBER_REGEX_LIST»);
-                «ENDIF»
-            «ENDFOR»
+        IF genTO.typedef && allProperties.size == 1 && allProperties.get(0).name.equals("value")»
+            «CodeHelpers.importedName».requireValue(_value);
+            «genPatternEnforcer("_value")»
         «ENDIF»
 
         «FOR p : properties»
-            «IF p.returnType.importedName.contains("[]")»
-                «IF genTO.typedef && !allProperties.empty && allProperties.size == 1 && allProperties.get(0).name
-                .equals("value")»
-                this.«p.fieldName» = «p.fieldName».clone();
+            «val fieldName = p.fieldName»
+            «IF p.returnType.name.endsWith("[]")»
+                «IF genTO.typedef && allProperties.size == 1 && allProperties.get(0).name.equals("value")»
+                this.«fieldName» = «fieldName».clone();
                 «ELSE»
-                this.«p.fieldName» = «p.fieldName» == null ? null : «p.fieldName».clone();
+                this.«fieldName» = «fieldName» == null ? null : «fieldName».clone();
                 «ENDIF»
             «ELSE»
-            this.«p.fieldName» = «p.fieldName»;
+            this.«fieldName» = «fieldName»;
             «ENDIF»
         «ENDFOR»
     }
@@ -256,21 +252,30 @@ class ClassTemplate extends BaseTemplate {
 
     '''
 
-    def protected genConstructor(GeneratedProperty property, GeneratedProperty... other) '''
+    def protected genConstructor(GeneratedProperty property, Iterable<GeneratedProperty> other) '''
     public «type.name»(«property.returnType.importedName + " " + property.name») {
         «IF false == parentProperties.empty»
             super(«parentProperties.asArguments»);
         «ENDIF»
 
-        «generateRestrictions(type, property.fieldName.toString, property.returnType)»
+        «val fieldName = property.fieldName»
+        «generateRestrictions(type, fieldName.toString, property.returnType)»
 
-        this.«property.fieldName» = «property.name»;
+        this.«fieldName» = «property.name»;
         «FOR p : other»
             this.«p.fieldName» = null;
         «ENDFOR»
     }
     '''
 
+    def private genPatternEnforcer(String ref) '''
+        «FOR c : consts»
+            «IF c.name == TypeConstants.PATTERN_CONSTANT_NAME»
+            «CodeHelpers.importedName».checkPattern(«ref», «Constants.MEMBER_PATTERN_LIST», «Constants.MEMBER_REGEX_LIST»);
+            «ENDIF»
+        «ENDFOR»
+    '''
+
     def private static paramValue(Type returnType, String paramName) {
         if (returnType instanceof ConcreteType) {
             return paramName
@@ -306,7 +311,8 @@ class ClassTemplate extends BaseTemplate {
             super(source);
         «ENDIF»
         «FOR p : properties»
-            this.«p.fieldName» = source.«p.fieldName»;
+            «val fieldName = p.fieldName»
+            this.«fieldName» = source.«fieldName»;
         «ENDFOR»
     }
     '''
@@ -318,7 +324,8 @@ class ClassTemplate extends BaseTemplate {
      * @param source Source object
      */
     public «type.name»(«genTO.superType.importedName» source) {
-            super(source);
+        super(source);
+        «genPatternEnforcer("getValue()")»
     }
     '''
 
@@ -327,14 +334,16 @@ class ClassTemplate extends BaseTemplate {
             «val prop = allProperties.get(0)»
             «IF !("org.opendaylight.yangtools.yang.binding.InstanceIdentifier".equals(prop.returnType.fullyQualifiedName))»
             public static «genTO.name» getDefaultInstance(String defaultValue) {
-                «IF "byte[]".equals(prop.returnType.name)»
-                    «BaseEncoding.importedName» baseEncoding = «BaseEncoding.importedName».base64();
-                    return new «genTO.name»(baseEncoding.decode(defaultValue));
-                «ELSEIF "java.lang.String".equals(prop.returnType.fullyQualifiedName)»
+                «IF BYTE_ARRAY.equals(prop.returnType)»
+                    return new «genTO.name»(«Base64.importedName».getDecoder().decode(defaultValue));
+                «ELSEIF STRING.equals(prop.returnType)»
                     return new «genTO.name»(defaultValue);
+                «ELSEIF Constants.EMPTY.equals(prop.returnType)»
+                    «Preconditions.importedName».checkArgument(defaultValue.isEmpty(), "Invalid value %s", defaultValue);
+                    return new «genTO.name»(«Empty.importedName».getInstance());
                 «ELSEIF allProperties.size > 1»
                     «bitsArgs»
-                «ELSEIF "java.lang.Boolean".equals(prop.returnType.fullyQualifiedName)»
+                «ELSEIF BOOLEAN.equals(prop.returnType)»
                     return new «genTO.name»(«Boolean.importedName».valueOf(defaultValue));
                 «ELSEIF "java.lang.Byte".equals(prop.returnType.fullyQualifiedName)»
                     return new «genTO.name»(«Byte.importedName».valueOf(defaultValue));
@@ -405,9 +414,7 @@ class ClassTemplate extends BaseTemplate {
     def protected enumDeclarations() '''
         «IF !enums.empty»
             «FOR e : enums SEPARATOR "\n"»
-                «val enumTemplate = new EnumTemplate(e)»
-                «enumTemplate.generateAsInnerClass»
-                «addImports(enumTemplate)»
+                «new EnumTemplate(javaType.getEnclosedType(e.identifier), e).generateAsInnerClass»
             «ENDFOR»
         «ENDIF»
     '''
@@ -440,7 +447,7 @@ class ClassTemplate extends BaseTemplate {
                     FOR v : cValue.keySet SEPARATOR ", "»"«v.escapeJava»"«ENDFOR»);
                     «IF cValue.size == 1»
                         private static final «Pattern.importedName» «Constants.MEMBER_PATTERN_LIST» = «Pattern.importedName».compile(«TypeConstants.PATTERN_CONSTANT_NAME».get(0));
-                        private static final String «Constants.MEMBER_REGEX_LIST» = "«cValue.values.get(0).escapeJava»";
+                        private static final String «Constants.MEMBER_REGEX_LIST» = "«cValue.values.iterator.next.escapeJava»";
                     «ELSE»
                         private static final «Pattern.importedName»[] «Constants.MEMBER_PATTERN_LIST» = «CodeHelpers.importedName».compilePatterns(«TypeConstants.PATTERN_CONSTANT_NAME»);
                         private static final String[] «Constants.MEMBER_REGEX_LIST» = { «
@@ -475,23 +482,23 @@ class ClassTemplate extends BaseTemplate {
      *
      * @return string with the <code>hashCode()</code> method definition in JAVA format
      */
-    def protected generateHashCode() '''
-        «IF !genTO.hashCodeIdentifiers.empty»
-            @Override
+    def protected generateHashCode() {
+        val size = genTO.hashCodeIdentifiers.size
+        if (size == 0) {
+            return ""
+        }
+        return '''
+            @«Override.importedName»
             public int hashCode() {
-                final int prime = 31;
-                int result = 1;
-                «FOR property : genTO.hashCodeIdentifiers»
-                    «IF property.returnType.name.contains("[")»
-                    result = prime * result + «Arrays.importedName».hashCode(«property.fieldName»);
-                    «ELSE»
-                    result = prime * result + «Objects.importedName».hashCode(«property.fieldName»);
-                    «ENDIF»
-                «ENDFOR»
-                return result;
+                «IF size != 1»
+                    «hashCodeResult(genTO.hashCodeIdentifiers)»
+                    return result;
+                «ELSE»
+                    return «CodeHelpers.importedName».wrapperHashCode(«genTO.hashCodeIdentifiers.get(0).fieldName»);
+                «ENDIF»
             }
-        «ENDIF»
-    '''
+        '''
+    }
 
     /**
      * Template method which generates the method <code>equals()</code>.
@@ -500,7 +507,7 @@ class ClassTemplate extends BaseTemplate {
      */
     def protected generateEquals() '''
         «IF !genTO.equalsIdentifiers.empty»
-            @Override
+            @«Override.importedName»
             public boolean equals(java.lang.Object obj) {
                 if (this == obj) {
                     return true;
@@ -514,11 +521,7 @@ class ClassTemplate extends BaseTemplate {
                 «type.name» other = («type.name») obj;
                 «FOR property : genTO.equalsIdentifiers»
                     «val fieldName = property.fieldName»
-                    «IF property.returnType.name.contains("[")»
-                    if (!«Arrays.importedName».equals(«fieldName», other.«fieldName»)) {
-                    «ELSE»
-                    if (!«Objects.importedName».equals(«fieldName», other.«fieldName»)) {
-                    «ENDIF»
+                    if (!«property.importedUtilClass».equals(«fieldName», other.«fieldName»)) {
                         return false;
                     }
                 «ENDFOR»