code-generator/binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/java/api/generator/ClassTemplate.xtend

   1 package org.opendaylight.yangtools.sal.java.api.generator\r
   2 \r
   3 import java.util.List\r
   4 import java.util.Map\r
   5 import org.opendaylight.yangtools.binding.generator.util.TypeConstants\r
   6 import org.opendaylight.yangtools.sal.binding.model.api.Constant\r
   7 import org.opendaylight.yangtools.sal.binding.model.api.Enumeration\r
   8 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedProperty\r
   9 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject\r
  10 import org.opendaylight.yangtools.sal.binding.model.api.Type\r
  11 import org.opendaylight.yangtools.binding.generator.util.Types\r
  12 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType\r
  13 \r
  14 \r
  15 /**\r
  16  * Template for generating JAVA class. \r
  17  */\r
  18 class ClassTemplate extends BaseTemplate {\r
  19 \r
  20     protected val List<GeneratedProperty> properties\r
  21     protected val List<GeneratedProperty> finalProperties\r
  22     protected val List<GeneratedProperty> parentProperties\r
  23     protected val Iterable<GeneratedProperty> allProperties;\r
  24     \r
  25     /**\r
  26      * List of enumeration which are generated as JAVA enum type.\r
  27      */\r
  28     protected val List<Enumeration> enums\r
  29     \r
  30     /**\r
  31      * List of constant instances which are generated as JAVA public static final attributes.\r
  32      */\r
  33     protected val List<Constant> consts\r
  34     \r
  35     /**\r
  36      * List of generated types which are enclosed inside <code>genType</code>\r
  37      */\r
  38     protected val List<GeneratedType> enclosedGeneratedTypes;\r
  39     \r
  40     \r
  41     protected val GeneratedTransferObject genTO;\r
  42     \r
  43     /**\r
  44      * Creates instance of this class with concrete <code>genType</code>.\r
  45      * \r
  46      * @param genType generated transfer object which will be transformed to JAVA class source code\r
  47      */\r
  48     new(GeneratedTransferObject genType) {\r
  49         super(genType)\r
  50         this.genTO = genType\r
  51         this.properties = genType.properties\r
  52         this.finalProperties = GeneratorUtil.resolveReadOnlyPropertiesFromTO(genTO.properties)\r
  53         this.parentProperties = GeneratorUtil.getPropertiesOfAllParents(genTO)\r
  54         this.allProperties = properties + parentProperties\r
  55         this.enums = genType.enumerations\r
  56         this.consts = genType.constantDefinitions\r
  57         this.enclosedGeneratedTypes = genType.enclosedTypes\r
  58     }\r
  59     \r
  60 \r
  61     \r
  62     \r
  63     \r
  64     /**\r
  65      * Generates JAVA class source code (class body only).\r
  66      * \r
  67      * @return string with JAVA class body source code\r
  68      */\r
  69     def generateAsInnerClass() {\r
  70         return generateBody(true)\r
  71     }\r
  72     \r
  73 \r
  74     \r
  75     override protected body() {\r
  76         generateBody(false);\r
  77     }\r
  78 \r
  79     /**\r
  80      * Template method which generates class body.\r
  81      * \r
  82      * @param isInnerClass boolean value which specify if generated class is|isn't inner\r
  83      * @return string with class source code in JAVA format\r
  84      */\r
  85     def protected generateBody(boolean isInnerClass) '''\r
  86         «type.comment.asJavadoc»\r
  87         «generateClassDeclaration(isInnerClass)» {\r
  88                 «innerClassesDeclarations»\r
  89             «enumDeclarations»\r
  90             «constantsDeclarations»\r
  91             «generateFields»\r
  92             «constructors»\r
  93             «FOR field : properties SEPARATOR "\n"»\r
  94                 «field.getterMethod»\r
  95                 «IF !field.readOnly»\r
  96                     «field.setterMethod»\r
  97                 «ENDIF»\r
  98             «ENDFOR»\r
  99             «generateHashCode»\r
 100             «generateEquals»\r
 101             «generateToString»\r
 102         \r
 103         }\r
 104     '''\r
 105     \r
 106     \r
 107     /**\r
 108      * Template method which generates inner classes inside this interface.\r
 109      * \r
 110      * @return string with the source code for inner classes in JAVA format\r
 111      */\r
 112     def protected innerClassesDeclarations() '''\r
 113         «IF !enclosedGeneratedTypes.empty»\r
 114             «FOR innerClass : enclosedGeneratedTypes SEPARATOR "\n"»\r
 115                 «IF (innerClass instanceof GeneratedTransferObject)»\r
 116                     «val classTemplate = new ClassTemplate(innerClass as GeneratedTransferObject)»\r
 117                     «classTemplate.generateAsInnerClass»\r
 118                     \r
 119                 «ENDIF»\r
 120             «ENDFOR»\r
 121         «ENDIF»\r
 122     '''\r
 123     \r
 124     \r
 125     def protected constructors() '''\r
 126     «allValuesConstructor»\r
 127     «IF !allProperties.empty»\r
 128     «copyConstructor»\r
 129     «ENDIF»\r
 130     «IF properties.empty && !parentProperties.empty »\r
 131         «parentConstructor»\r
 132     «ENDIF»\r
 133     '''\r
 134     \r
 135     def protected allValuesConstructor() '''\r
 136     public «type.name»(«allProperties.asArgumentsDeclaration») {\r
 137         «IF false == parentProperties.empty»\r
 138             super(«parentProperties.asArguments»);\r
 139         «ENDIF»\r
 140         «FOR p : properties» \r
 141             this.«p.fieldName» = «p.fieldName»;\r
 142         «ENDFOR»\r
 143     }\r
 144     '''\r
 145     \r
 146     \r
 147     def protected copyConstructor() '''\r
 148     /**\r
 149      * Creates a copy from Source Object.\r
 150      *\r
 151      * @param source Source object\r
 152      */\r
 153     public «type.name»(«type.name» source) {\r
 154         «IF false == parentProperties.empty»\r
 155             super(source);\r
 156         «ENDIF»\r
 157         «FOR p : properties» \r
 158             this.«p.fieldName» = source.«p.fieldName»;\r
 159         «ENDFOR»\r
 160     }\r
 161     '''\r
 162     \r
 163     def protected parentConstructor() '''\r
 164     /**\r
 165      * Creates a new instance from «genTO.superType.importedName»\r
 166      *\r
 167      * @param source Source object\r
 168      */\r
 169     public «type.name»(«genTO.superType.importedName» source) {\r
 170             super(source);\r
 171     }\r
 172     '''\r
 173     \r
 174 \r
 175     \r
 176     /**\r
 177      * Template method which generates JAVA class declaration.\r
 178      * \r
 179      * @param isInnerClass boolean value which specify if generated class is|isn't inner\r
 180      * @return string with class declaration in JAVA format\r
 181      */\r
 182     def protected generateClassDeclaration(boolean isInnerClass) '''\r
 183         public«\r
 184         IF (isInnerClass)»«\r
 185             " static final "»«\r
 186         ELSEIF (type.abstract)»«\r
 187             " abstract "»«\r
 188         ELSE»«\r
 189             " "»«\r
 190         ENDIF»class «type.name»«\r
 191         IF (genTO.superType != null)»«\r
 192             " extends "»«genTO.superType.importedName»«\r
 193         ENDIF»\r
 194         «IF (!type.implements.empty)»«\r
 195             " implements "»«\r
 196             FOR type : type.implements SEPARATOR ", "»«\r
 197                 type.importedName»«\r
 198             ENDFOR»«\r
 199         ENDIF\r
 200     »'''\r
 201     \r
 202     /**\r
 203      * Template method which generates JAVA enum type.\r
 204      * \r
 205      * @return string with inner enum source code in JAVA format\r
 206      */\r
 207     def protected enumDeclarations() '''\r
 208         «IF !enums.empty»\r
 209             «FOR e : enums SEPARATOR "\n"»\r
 210                 «val enumTemplate = new EnumTemplate(e)»\r
 211                 «enumTemplate.generateAsInnerClass»\r
 212             «ENDFOR»\r
 213         «ENDIF»\r
 214     '''\r
 215     \r
 216     /**\r
 217      * Template method wich generates JAVA constants.\r
 218      * \r
 219      * @return string with constants in JAVA format \r
 220      */\r
 221     def protected constantsDeclarations() '''\r
 222         «IF !consts.empty»\r
 223             «FOR c : consts»\r
 224                 «IF c.name == TypeConstants.PATTERN_CONSTANT_NAME»\r
 225                     «val cValue = c.value»\r
 226                     «IF cValue instanceof List<?>»\r
 227                         «val cValues = cValue as List<?>»\r
 228                         private static final List<Pattern> «Constants.MEMBER_PATTERN_LIST» = new ArrayList<Pattern>();\r
 229                         public static final List<String> «TypeConstants.PATTERN_CONSTANT_NAME» = Arrays.asList(«\r
 230                         FOR v : cValues SEPARATOR ", "»«\r
 231                             IF v instanceof String»"«\r
 232                                 v as String»"«\r
 233                             ENDIF»«\r
 234                         ENDFOR»);\r
 235                         \r
 236                         «generateStaticInicializationBlock»\r
 237                     «ENDIF»\r
 238                 «ELSE»\r
 239                     public static final «c.type.importedName» «c.name» = «c.value»;\r
 240                 «ENDIF»\r
 241             «ENDFOR»\r
 242         «ENDIF»\r
 243     '''\r
 244     \r
 245     /**\r
 246      * Template method which generates JAVA static initialization block.\r
 247      * \r
 248      * @return string with static initialization block in JAVA format\r
 249      */\r
 250     def protected generateStaticInicializationBlock() '''\r
 251         static {\r
 252             for (String regEx : «TypeConstants.PATTERN_CONSTANT_NAME») {\r
 253                 «Constants.MEMBER_PATTERN_LIST».add(Pattern.compile(regEx));\r
 254             }\r
 255         }\r
 256     '''\r
 257     \r
 258     /**\r
 259      * Template method which generates JAVA class attributes.\r
 260      * \r
 261      * @return string with the class attributes in JAVA format\r
 262      */\r
 263     def protected generateFields() '''\r
 264         «IF !properties.empty»\r
 265             «FOR f : properties»\r
 266                 «IF f.readOnly»final«ENDIF» private «f.returnType.importedName» «f.fieldName»;\r
 267             «ENDFOR»\r
 268         «ENDIF»\r
 269     '''\r
 270     \r
 271 \r
 272     /**\r
 273      * Template method which generates the method <code>hashCode()</code>.\r
 274      * \r
 275      * @return string with the <code>hashCode()</code> method definition in JAVA format\r
 276      */\r
 277     def protected generateHashCode() '''\r
 278         «IF !genTO.hashCodeIdentifiers.empty»\r
 279             @Override\r
 280             public int hashCode() {\r
 281                 final int prime = 31;\r
 282                 int result = 1;\r
 283                 «FOR property : genTO.hashCodeIdentifiers»\r
 284                     result = prime * result + ((«property.fieldName» == null) ? 0 : «property.fieldName».hashCode());\r
 285                 «ENDFOR»\r
 286                 return result;\r
 287             }\r
 288         «ENDIF»\r
 289     '''\r
 290     \r
 291     /**\r
 292      * Template method which generates the method <code>equals()</code>.\r
 293      * \r
 294      * @return string with the <code>equals()</code> method definition in JAVA format     \r
 295      */\r
 296     def protected generateEquals() '''\r
 297         «IF !genTO.equalsIdentifiers.empty»\r
 298             @Override\r
 299             public boolean equals(java.lang.Object obj) {\r
 300                 if (this == obj) {\r
 301                     return true;\r
 302                 }\r
 303                 if (obj == null) {\r
 304                     return false;\r
 305                 }\r
 306                 if (getClass() != obj.getClass()) {\r
 307                     return false;\r
 308                 }\r
 309                 «type.name» other = («type.name») obj;\r
 310                 «FOR property : genTO.equalsIdentifiers»\r
 311                     «val fieldName = property.fieldName»\r
 312                     if («fieldName» == null) {\r
 313                         if (other.«fieldName» != null) {\r
 314                             return false;\r
 315                         }\r
 316                     } else if(!«fieldName».equals(other.«fieldName»)) {\r
 317                         return false;\r
 318                     }\r
 319                 «ENDFOR»\r
 320                 return true;\r
 321             }\r
 322         «ENDIF»\r
 323     '''\r
 324     \r
 325     /**\r
 326      * Template method which generates the method <code>toString()</code>.\r
 327      * \r
 328      * @return string with the <code>toString()</code> method definition in JAVA format     \r
 329      */\r
 330     def protected generateToString() '''\r
 331         «IF !genTO.toStringIdentifiers.empty»\r
 332             @Override\r
 333             public String toString() {\r
 334                 StringBuilder builder = new StringBuilder();\r
 335                 «val properties = genTO.toStringIdentifiers»\r
 336                 builder.append("«type.name» [«properties.get(0).fieldName»=");\r
 337                 builder.append(«properties.get(0).fieldName»);\r
 338                 «FOR i : 1..<genTO.toStringIdentifiers.size»\r
 339                     builder.append(", «properties.get(i).fieldName»=");\r
 340                     builder.append(«properties.get(i).fieldName»);\r
 341                 «ENDFOR»\r
 342                 builder.append("]");\r
 343                 return builder.toString();\r
 344             }\r
 345         «ENDIF»\r
 346     '''\r
 347     \r
 348 }\r