code-generator/binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/java/api/generator/UnionBuilderTemplate.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.yangtools.sal.java.api.generator
   9
  10 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject
  11 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier
  12
  13 /**
  14  * Template for generating JAVA class.
  15  */
  16 class UnionBuilderTemplate extends ClassTemplate {
  17
  18     /**
  19      * Creates instance of this class with concrete <code>genType</code>.
  20      *
  21      * @param genType generated transfer object which will be transformed to JAVA class source code
  22      */
  23     new(GeneratedTransferObject genType) {
  24         super(genType)
  25     }
  26
  27     def override body() '''
  28         «wrapToDocumentation(formatDataForJavaDoc(type, getClarification()))»
  29         public class «type.name» {
  30
  31             «generateMethods»
  32
  33         }
  34     '''
  35
  36     def private generateMethods() '''
  37         «FOR method : genTO.methodDefinitions»
  38             «method.accessModifier.accessModifier»«IF method.static»static«ENDIF»«IF method.final» final«ENDIF» «method.
  39             returnType.importedName» «method.name»(«method.parameters.generateParameters») {
  40                 throw new «UnsupportedOperationException.importedName»("Not yet implemented");
  41             }
  42         «ENDFOR»
  43     '''
  44
  45     def private String getAccessModifier(AccessModifier modifier) {
  46         switch (modifier) {
  47             case AccessModifier.PUBLIC: return "public "
  48             case AccessModifier.PROTECTED: return "protected "
  49             case AccessModifier.PRIVATE: return "private "
  50             default: return ""
  51         }
  52     }
  53
  54     def private String getClarification() {
  55         return
  56         '''
  57         The purpose of generated class in src/main/java for Union types is to create new instances of unions from a string representation.
  58         In some cases it is very difficult to automate it since there can be unions such as (uint32 - uint16), or (string - uint32).
  59
  60         The reason behind putting it under src/main/java is:
  61         This class is generated in form of a stub and needs to be finished by the user. This class is generated only once to prevent
  62         loss of user code.
  63         '''
  64     }
  65
  66 }