Map identities to proper objects
[mdsal.git] / binding / mdsal-binding-java-api-generator / src / main / java / org / opendaylight / mdsal / binding / java / api / generator / UnionTemplate.xtend
index da8e337cd01881f0c6cfa6ecb12c3e18bea5f085..600bb69cd2910f40d25d63795e668c580ea7eb60 100644 (file)
@@ -7,23 +7,28 @@
  */
 package org.opendaylight.mdsal.binding.java.api.generator
 
-import static org.opendaylight.mdsal.binding.model.util.Types.BOOLEAN;
-import static org.opendaylight.mdsal.binding.model.util.Types.getOuterClassName;
-
-import com.google.common.base.Preconditions;
-import com.google.common.io.BaseEncoding
-import java.beans.ConstructorProperties
-import java.util.Arrays
-import org.opendaylight.mdsal.binding.model.api.GeneratedProperty
-import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
+import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.BINARY_TYPE
+import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.BOOLEAN_TYPE
+import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.EMPTY_TYPE
+import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.STRING_TYPE
+import static org.opendaylight.mdsal.binding.model.ri.Types.STRING
+import static org.opendaylight.mdsal.binding.model.ri.Types.getOuterClassName
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_CONTRACT_IMPLEMENTED_INTERFACE_NAME
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BUILDER_SUFFIX
+import static extension org.opendaylight.mdsal.binding.model.ri.BindingTypes.isBitsType
+import static extension org.opendaylight.mdsal.binding.model.ri.BindingTypes.isIdentityType
+
+import java.util.Base64;
+import org.gaul.modernizer_maven_annotations.SuppressModernizer
 import org.opendaylight.mdsal.binding.model.api.Enumeration
-import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
+import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
+import org.opendaylight.mdsal.binding.model.api.Type
 
 /**
  * Template for generating JAVA class.
  */
+@SuppressModernizer
 class UnionTemplate extends ClassTemplate {
-
     /**
      * Creates instance of this class with concrete <code>genType</code>.
      *
@@ -57,58 +62,33 @@ class UnionTemplate extends ClassTemplate {
 
     private def unionConstructors() '''
         «FOR property : finalProperties SEPARATOR "\n"»
-            «val propRet = property.returnType»
-            «IF "char[]".equals(propRet.name)»
-                /**
-                 * Constructor provided only for using in JMX. Don't use it for
-                 * construction new object of this union type.
-                 */
-                @«ConstructorProperties.importedName»("«property.name»")
-                public «type.name»(«propRet.importedName» «property.fieldName») {
-                    «String.importedName» defVal = new «String.importedName»(«property.fieldName»);
-                    «type.name» defInst = «typeBuilder()».getDefaultInstance(defVal);
-                    «FOR other : finalProperties»
-                        «IF other.name.equals("value")»
-                            «IF other.returnType.importedName.contains("[]")»
-                            this.«other.fieldName» = «other.fieldName» == null ? null : «other.fieldName».clone();
-                            «ELSE»
-                            this.«other.fieldName» = «other.fieldName»;
-                            «ENDIF»
-                        «ELSE»
-                            this.«other.fieldName» = defInst.«other.fieldName»;
-                        «ENDIF»
-                    «ENDFOR»
-                }
-            «ELSE»
-                «val actualType = property.returnType»
-                «val restrictions = restrictionsForSetter(actualType)»
+            «val actualType = property.returnType»
+            «val restrictions = restrictionsForSetter(actualType)»
+            «IF restrictions !== null»
+                «generateCheckers(property, restrictions, actualType)»
+            «ENDIF»
+            «val propertyAndTopParentProperties = parentProperties + #[property]»
+            public «type.name»(«propertyAndTopParentProperties.asArgumentsDeclaration») {
+                super(«parentProperties.asArguments»);
                 «IF restrictions !== null»
-                    «generateCheckers(property, restrictions, actualType)»
-
+                    «checkArgument(property, restrictions, actualType, property.fieldName)»
                 «ENDIF»
-                «val propertyAndTopParentProperties = parentProperties + #[property]»
-                public «type.name»(«propertyAndTopParentProperties.asArgumentsDeclaration») {
-                    super(«parentProperties.asArguments»);
-                    «IF restrictions !== null»
-                        «checkArgument(property, restrictions, actualType, property.fieldName.toString)»
+                this.«property.fieldName» = «property.fieldName»;
+                «FOR other : finalProperties»
+                    «IF property != other»
+                         this.«other.fieldName» = null;
                     «ENDIF»
-                    this.«property.fieldName» = «property.fieldName»;
-                    «FOR other : finalProperties»
-                        «IF property != other && !"value".equals(other.name)»
-                             this.«other.fieldName» = null;
-                        «ENDIF»
-                    «ENDFOR»
-                }
-            «ENDIF»
+                «ENDFOR»
+            }
         «ENDFOR»
     '''
 
     def typeBuilder() {
         val outerCls = getOuterClassName(type);
-        if(outerCls !== null) {
-            return outerCls + type.name + "Builder"
+        if (outerCls !== null) {
+            return outerCls + type.name + BUILDER_SUFFIX
         }
-        return type.name + "Builder"
+        return type.name + BUILDER_SUFFIX
     }
 
     private def unionConstructorsParentProperties() '''
@@ -121,82 +101,73 @@ class UnionTemplate extends ClassTemplate {
 
     def generateStringValue()
     '''
-        public «String.importedName» stringValue() {
-            «FOR property : finalProperties.filter([ p | !"value".equals(p.name)])»
+        /**
+         * Return a String representing the value of this union.
+         *
+         * @return String representation of this union's value.
+         */
+        public «STRING.importedName» stringValue() {
+            «FOR property : finalProperties»
                 «val field = property.fieldName»
             if («field» != null) {
                 «val propRet = property.returnType»
-                «IF "java.lang.String".equals(propRet.fullyQualifiedName
+                «IF STRING_TYPE.equals(propRet
                     ««« type string
                 return «field»;
                 «ELSEIF "org.opendaylight.yangtools.yang.binding.InstanceIdentifier".equals(propRet.fullyQualifiedName)»
                     ««« type instance-identifier
                 return «field».toString();
-                «ELSEIF "byte[]".equals(propRet.name
+                «ELSEIF BINARY_TYPE.equals(propRet
                     ««« type binary
-                return new «String.importedName»(«field»);
-                «ELSEIF propRet.fullyQualifiedName.startsWith("java.lang") || propRet instanceof Enumeration
-                        || propRet.fullyQualifiedName.startsWith("java.math")»
-                   ««« type int*, uint, decimal64 or enumeration*
+                return new «STRING.importedName»(«field»);
+                «ELSEIF propRet.fullyQualifiedName.startsWith("java.lang") || propRet instanceof Enumeration»
+                    ««« type int* or enumeration*
                 return «field».toString();
-                «ELSEIF propRet instanceof GeneratedTransferObject
-                        && (propRet as GeneratedTransferObject).unionType»
+                «ELSEIF "org.opendaylight.yangtools.yang.common".equals(propRet.packageName)
+                        && (propRet.name.startsWith("Uint") || "Decimal64".equals(propRet.name))»
+                    ««« type uint*, decimal64
+                return «field».toCanonicalString();
+                «ELSEIF propRet instanceof GeneratedTransferObject && (propRet as GeneratedTransferObject).unionType»
                     ««« union type
                 return «field».stringValue();
-                «ELSEIF propRet instanceof GeneratedTransferObject // Is it a GeneratedTransferObject
-                        && (propRet as GeneratedTransferObject).typedef  // Is it a typedef
-                        && (propRet as GeneratedTransferObject).properties !== null
-                        && !(propRet as GeneratedTransferObject).properties.empty
-                        && ((propRet as GeneratedTransferObject).properties.size == 1)
-                        && (propRet as GeneratedTransferObject).properties.get(0).name.equals("value")
-                        && BOOLEAN.equals((propRet as GeneratedTransferObject).properties.get(0).returnType) // And the property value is of type boolean»
+                «ELSEIF BOOLEAN_TYPE.equals(propRet.typedefReturnType)»
                     ««« generated boolean typedef
                 return «field».isValue().toString();
-                «ELSEIF propRet instanceof GeneratedTransferObject // Is it a GeneratedTransferObject
-                        && (propRet as GeneratedTransferObject).typedef  // Is it a typedef
-                        && (propRet as GeneratedTransferObject).properties !== null
-                        && !(propRet as GeneratedTransferObject).properties.empty
-                        && ((propRet as GeneratedTransferObject).properties.size == 1)
-                        && (propRet as GeneratedTransferObject).properties.get(0).name.equals("value")
-                        && "byte[]".equals((propRet as GeneratedTransferObject).properties.get(0).returnType.name)»
+                «ELSEIF BINARY_TYPE.equals(propRet.typedefReturnType)»
                     ««« generated byte[] typedef
-                return «BaseEncoding.importedName».base64().encode(«field».getValue());
-                «ELSEIF propRet instanceof GeneratedTransferObject // Is it a GeneratedTransferObject
-                        && (propRet as GeneratedTransferObject).typedef  // Is it a typedef
-                        && (propRet as GeneratedTransferObject).baseType instanceof BitsTypeDefinition»
+                return «Base64.importedName».getEncoder().encodeToString(«field».getValue());
+                «ELSEIF EMPTY_TYPE.equals(propRet) || EMPTY_TYPE.equals(propRet.typedefReturnType)»
+                    ««« generated empty typedef
+                return "";
+                «ELSEIF propRet.isBitsType»
                     ««« generated bits typedef
-                return «Arrays.importedName».toString(«field».getValue());
+                return «JU_ARRAYS.importedName».toString(«field».getValue());
+                «ELSEIF propRet.isIdentityType»
+                    ««« generated identity
+                return «field».«BINDING_CONTRACT_IMPLEMENTED_INTERFACE_NAME»().toString();
                 «ELSE»
                     ««« generated type
                 return «field».getValue().toString();
                 «ENDIF»
             }
             «ENDFOR»
-
-            throw new IllegalStateException("No value assinged");
+            throw new IllegalStateException("No value assigned");
         }
     '''
 
-    override protected getterMethod(GeneratedProperty field) {
-        if (!"value".equals(field.name)) {
-            return super.getterMethod(field)
+    private static def Type typedefReturnType(Type type) {
+        if (!(type instanceof GeneratedTransferObject)) {
+            return null
         }
-
-        Preconditions.checkArgument("char[]".equals(field.returnType.importedName))
-
-        '''
-            @«Deprecated.importedName»
-            public char[] «field.getterMethodName»() {
-                if («field.fieldName» == null) {
-                    «field.fieldName» = stringValue().toCharArray();
-                }
-                return «field.fieldName».clone();
-            }
-        '''
-    }
-
-    override isReadOnly(GeneratedProperty field) {
-        return !"value".equals(field.name) && super.isReadOnly(field)
+        val gto = type as GeneratedTransferObject
+        if (!gto.typedef || gto.properties === null || gto.properties.size != 1) {
+            return null
+        }
+        val prop = gto.properties.get(0)
+        if (prop.name.equals("value")) {
+            return prop.returnType
+        }
+        return null
     }
 
     override protected copyConstructor() '''
@@ -209,16 +180,14 @@ class UnionTemplate extends ClassTemplate {
             «IF !parentProperties.empty»
                 super(source);
             «ENDIF»
-            «IF !properties.empty»
-                «FOR p : properties»
-                    «IF !"value".equals(p.name) && p.returnType.importedName.contains("[]")»
-                    this.«p.fieldName» = source.«p.fieldName» == null ? null : source.«p.fieldName».clone();
-                    «ELSE»
-                    this.«p.fieldName» = source.«p.fieldName»;
-                    «ENDIF»
-                «ENDFOR»
-            «ENDIF»
+            «FOR p : properties»
+                «val fieldName = p.fieldName»
+                «IF p.returnType.name.endsWith("[]")»
+                this.«fieldName» = source.«fieldName» == null ? null : source.«fieldName».clone();
+                «ELSE»
+                this.«fieldName» = source.«fieldName»;
+                «ENDIF»
+            «ENDFOR»
         }
     '''
-
 }