binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/UnionTemplate.xtend

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.java.api.generator
   9
  10 import static org.opendaylight.mdsal.binding.model.util.Types.BOOLEAN;
  11 import static org.opendaylight.mdsal.binding.model.util.Types.getOuterClassName;
  12
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.io.BaseEncoding
  15 import java.beans.ConstructorProperties
  16 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty
  17 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
  18 import org.opendaylight.mdsal.binding.model.api.Enumeration
  19 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
  20
  21 /**
  22  * Template for generating JAVA class.
  23  */
  24 class UnionTemplate extends ClassTemplate {
  25
  26     /**
  27      * Creates instance of this class with concrete <code>genType</code>.
  28      *
  29      * @param genType generated transfer object which will be transformed to JAVA class source code
  30      */
  31     new(GeneratedTransferObject genType) {
  32         super(genType)
  33         if (isBaseEncodingImportRequired) {
  34             addImport(BaseEncoding)
  35         }
  36     }
  37
  38     final private def boolean isBaseEncodingImportRequired() {
  39         for (property : finalProperties) {
  40             val propRet = property.returnType
  41             if (propRet instanceof GeneratedTransferObject && (propRet as GeneratedTransferObject).typedef &&
  42                 (propRet as GeneratedTransferObject).properties !== null &&
  43                 !(propRet as GeneratedTransferObject).properties.empty &&
  44                 ((propRet as GeneratedTransferObject).properties.size == 1) &&
  45                 (propRet as GeneratedTransferObject).properties.get(0).name.equals("value") &&
  46                 "byte[]".equals((propRet as GeneratedTransferObject).properties.get(0).returnType.name)) {
  47                 return true;
  48             }
  49         }
  50     }
  51
  52     override constructors() '''
  53         «unionConstructorsParentProperties»
  54         «unionConstructors»
  55         «IF !allProperties.empty»
  56             «copyConstructor»
  57         «ENDIF»
  58         «IF properties.empty && !parentProperties.empty»
  59             «parentConstructor»
  60         «ENDIF»
  61     '''
  62
  63     private def unionConstructors() '''
  64         «FOR property : finalProperties SEPARATOR "\n"»
  65             «val propRet = property.returnType»
  66             «IF "char[]".equals(propRet.name)»
  67                 /**
  68                  * Constructor provided only for using in JMX. Don't use it for
  69                  * construction new object of this union type.
  70                  */
  71                 @«ConstructorProperties.importedName»("«property.name»")
  72                 public «type.name»(«propRet.importedName» «property.fieldName») {
  73                     «String.importedName» defVal = new «String.importedName»(«property.fieldName»);
  74                     «type.name» defInst = «typeBuilder()».getDefaultInstance(defVal);
  75                     «FOR other : finalProperties»
  76                         «IF other.name.equals("value")»
  77                             «IF other.returnType.importedName.contains("[]")»
  78                             this.«other.fieldName» = «other.fieldName» == null ? null : «other.fieldName».clone();
  79                             «ELSE»
  80                             this.«other.fieldName» = «other.fieldName»;
  81                             «ENDIF»
  82                         «ELSE»
  83                             this.«other.fieldName» = defInst.«other.fieldName»;
  84                         «ENDIF»
  85                     «ENDFOR»
  86                 }
  87             «ELSE»
  88                 «val propertyAndTopParentProperties = parentProperties + #[property]»
  89                 public «type.name»(«propertyAndTopParentProperties.asArgumentsDeclaration») {
  90                     super(«parentProperties.asArguments»);
  91                     this.«property.fieldName» = «property.fieldName»;
  92                     «FOR other : finalProperties»
  93                         «IF property != other && !"value".equals(other.name)»
  94                              this.«other.fieldName» = null;
  95                         «ENDIF»
  96                     «ENDFOR»
  97                 }
  98             «ENDIF»
  99         «ENDFOR»
 100     '''
 101
 102     def typeBuilder() {
 103         val outerCls = getOuterClassName(type);
 104         if(outerCls !== null) {
 105             return outerCls + type.name + "Builder"
 106         }
 107         return type.name + "Builder"
 108     }
 109
 110     private def unionConstructorsParentProperties() '''
 111         «FOR property : parentProperties SEPARATOR "\n"»
 112             public «type.name»(«property.returnType.importedName» «property.fieldName») {
 113                 super(«property.fieldName»);
 114             }
 115         «ENDFOR»
 116     '''
 117
 118     override protected getterMethod(GeneratedProperty field) {
 119         if (!"value".equals(field.name)) {
 120             return super.getterMethod(field)
 121         }
 122
 123         Preconditions.checkArgument("char[]".equals(field.returnType.importedName))
 124
 125         '''
 126             public char[] «field.getterMethodName»() {
 127                 if («field.fieldName» == null) {
 128                     «FOR property : finalProperties.filter([ p | !"value".equals(p.name)]) SEPARATOR " else"»
 129                         if («property.fieldName» != null) {
 130                             «val propRet = property.returnType»
 131                             «IF "java.lang.String".equals(propRet.fullyQualifiedName)»
 132                                 ««« type string
 133                                 «field.fieldName» = «property.fieldName».toCharArray();
 134                             «ELSEIF "org.opendaylight.yangtools.yang.binding.InstanceIdentifier".equals(propRet.fullyQualifiedName)»
 135                                 ««« type instance-identifier
 136                                 «field.fieldName» = «property.fieldName».toString().toCharArray();
 137                             «ELSEIF "byte[]".equals(propRet.name)»
 138                                 ««« type binary
 139                                 «field.fieldName» = new «String.importedName»(«property.fieldName»).toCharArray();
 140                             «ELSEIF propRet.fullyQualifiedName.startsWith("java.lang")
 141                                 || propRet instanceof Enumeration
 142                                 || propRet.fullyQualifiedName.startsWith("java.math")»
 143                                 ««« type int*, uint, decimal64 or enumeration*
 144                                 «field.fieldName» = «property.fieldName».toString().toCharArray();
 145                             «ELSEIF propRet instanceof GeneratedTransferObject && (propRet as GeneratedTransferObject).unionType»
 146                                 ««« union type
 147                                 «field.fieldName» = «property.fieldName».getValue();
 148                             «ELSEIF propRet instanceof GeneratedTransferObject // Is it a GeneratedTransferObject
 149                                     && (propRet as GeneratedTransferObject).typedef  // Is it a typedef
 150                                     && (propRet as GeneratedTransferObject).properties !== null
 151                                     && !(propRet as GeneratedTransferObject).properties.empty
 152                                     && ((propRet as GeneratedTransferObject).properties.size == 1)
 153                                     && (propRet as GeneratedTransferObject).properties.get(0).name.equals("value")
 154                                     && BOOLEAN.equals((propRet as GeneratedTransferObject).properties.get(0).returnType)» // And the property value is of type boolean
 155                                 ««« generated boolean typedef
 156                                 «field.fieldName» = «property.fieldName».isValue().toString().toCharArray();
 157                             «ELSEIF propRet instanceof GeneratedTransferObject // Is it a GeneratedTransferObject
 158                                     && (propRet as GeneratedTransferObject).typedef  // Is it a typedef
 159                                     && (propRet as GeneratedTransferObject).properties !== null
 160                                     && !(propRet as GeneratedTransferObject).properties.empty
 161                                     && ((propRet as GeneratedTransferObject).properties.size == 1)
 162                                     && (propRet as GeneratedTransferObject).properties.get(0).name.equals("value")
 163                                     && "byte[]".equals((propRet as GeneratedTransferObject).properties.get(0).returnType.name)»
 164                                 ««« generated byte[] typedef
 165                                 «field.fieldName» = BaseEncoding.base64().encode(«property.fieldName».getValue()).toCharArray();
 166                             «ELSEIF propRet instanceof GeneratedTransferObject // Is it a GeneratedTransferObject
 167                                     && (propRet as GeneratedTransferObject).typedef  // Is it a typedef
 168                                     && (propRet as GeneratedTransferObject).baseType instanceof BitsTypeDefinition»
 169                                 ««« generated bits typedef
 170                                 «field.fieldName» = java.util.Arrays.toString(«property.fieldName».getValue()).toCharArray();
 171                             «ELSE»
 172                                 ««« generated type
 173                                 «field.fieldName» = «property.fieldName».getValue().toString().toCharArray();
 174                             «ENDIF»
 175                         }
 176                     «ENDFOR»
 177                 }
 178                 return «field.fieldName» == null ? null : «field.fieldName».clone();
 179             }
 180         '''
 181     }
 182
 183     override def isReadOnly(GeneratedProperty field) {
 184         return !"value".equals(field.name) && super.isReadOnly(field)
 185     }
 186
 187     override protected copyConstructor() '''
 188         /**
 189          * Creates a copy from Source Object.
 190          *
 191          * @param source Source object
 192          */
 193         public «type.name»(«type.name» source) {
 194             «IF !parentProperties.empty»
 195                 super(source);
 196             «ENDIF»
 197             «IF !properties.empty»
 198                 «FOR p : properties»
 199                     «IF !"value".equals(p.name) && p.returnType.importedName.contains("[]")»
 200                     this.«p.fieldName» = source.«p.fieldName» == null ? null : source.«p.fieldName».clone();
 201                     «ELSE»
 202                     this.«p.fieldName» = source.«p.fieldName»;
 203                     «ENDIF»
 204                 «ENDFOR»
 205             «ENDIF»
 206         }
 207     '''
 208
 209 }