code-generator/binding-generator-impl/src/main/java/org/opendaylight/yangtools/sal/binding/generator/impl/BindingGeneratorImpl.xtend

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.yangtools.sal.binding.generator.impl;\r
   9 \r
  10 import java.util.ArrayList;\r
  11 import java.util.Collections;\r
  12 import java.util.HashMap;\r
  13 import java.util.List;\r
  14 import java.util.Map;\r
  15 import java.util.Set;\r
  16 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;\r
  17 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;\r
  18 import org.opendaylight.yangtools.binding.generator.util.Types;\r
  19 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;\r
  20 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;\r
  21 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;\r
  22 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;\r
  23 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;\r
  24 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;\r
  25 import org.opendaylight.yangtools.sal.binding.model.api.Type;\r
  26 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;\r
  27 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;\r
  28 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;\r
  29 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;\r
  30 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;\r
  31 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;\r
  32 import org.opendaylight.yangtools.yang.binding.RpcService;\r
  33 import org.opendaylight.yangtools.yang.common.RpcResult;\r
  34 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;\r
  35 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;\r
  36 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;\r
  37 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;\r
  38 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;\r
  39 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;\r
  40 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;\r
  41 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;\r
  42 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;\r
  43 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;\r
  44 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;\r
  45 import org.opendaylight.yangtools.yang.model.api.Module;\r
  46 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;\r
  47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;\r
  48 import org.opendaylight.yangtools.yang.model.api.SchemaNode;\r
  49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;\r
  50 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;\r
  51 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;\r
  52 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;\r
  53 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;\r
  54 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;\r
  55 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;\r
  56 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;\r
  57 import org.opendaylight.yangtools.yang.model.util.UnionType;\r
  58 import static com.google.common.base.Preconditions.*;\r
  59 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;\r
  60 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;\r
  61 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;\r
  62 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;\r
  63 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort\r
  64 import org.opendaylight.yangtools.yang.model.util.ExtendedType;\r
  65 \r
  66 public class BindingGeneratorImpl implements BindingGenerator {\r
  67     /**\r
  68      * Outter key represents the package name. Outter value represents map of\r
  69      * all builders in the same package. Inner key represents the schema node\r
  70      * name (in JAVA class/interface name format). Inner value represents\r
  71      * instance of builder for schema node specified in key part.\r
  72      */\r
  73     private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;\r
  74 \r
  75     /**\r
  76      * Provide methods for converting YANG types to JAVA types.\r
  77      */\r
  78     private var TypeProvider typeProvider;\r
  79 \r
  80     /**\r
  81      * Holds reference to schema context to resolve data of augmented elemnt\r
  82      * when creating augmentation builder\r
  83      */\r
  84     private var SchemaContext schemaContext;\r
  85 \r
  86     /**\r
  87      * Each grouping which is converted from schema node to generated type is\r
  88      * added to this map with its Schema path as key to make it easier to get\r
  89      * reference to it. In schema nodes in <code>uses</code> attribute there is\r
  90      * only Schema Path but when building list of implemented interfaces for\r
  91      * Schema node the object of type <code>Type</code> is required. So in this\r
  92      * case is used this map.\r
  93      */\r
  94     private val allGroupings = new HashMap<SchemaPath, GeneratedType>();\r
  95 \r
  96     private val yangToJavaMapping = new HashMap<SchemaPath, Type>();\r
  97 \r
  98     /**\r
  99      * Constant with the concrete name of namespace.\r
 100      */\r
 101     private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";\r
 102 \r
 103     /**\r
 104      * Constant with the concrete name of identifier.\r
 105      */\r
 106     private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";\r
 107 \r
 108     /**\r
 109      * Resolves generated types from <code>context</code> schema nodes of all\r
 110      * modules.\r
 111      *\r
 112      * Generated types are created for modules, groupings, types, containers,\r
 113      * lists, choices, augments, rpcs, notification, identities.\r
 114      *\r
 115      * @param context\r
 116      *            schema context which contains data about all schema nodes\r
 117      *            saved in modules\r
 118      * @return list of types (usually <code>GeneratedType</code>\r
 119      *         <code>GeneratedTransferObject</code>which are generated from\r
 120      *         <code>context</code> data.\r
 121      * @throws IllegalArgumentException\r
 122      *             if param <code>context</code> is null\r
 123      * @throws IllegalStateException\r
 124      *             if <code>context</code> contain no modules\r
 125      */\r
 126     override generateTypes(SchemaContext context) {\r
 127         checkArgument(context !== null, "Schema Context reference cannot be NULL.");\r
 128         checkState(context.modules !== null, "Schema Context does not contain defined modules.");\r
 129         schemaContext = context;\r
 130         typeProvider = new TypeProviderImpl(context);\r
 131         val Set<Module> modules = context.modules;\r
 132         return generateTypes(context, modules);\r
 133     }\r
 134 \r
 135     /**\r
 136      * Resolves generated types from <code>context</code> schema nodes only for\r
 137      * modules specified in <code>modules</code>\r
 138      *\r
 139      * Generated types are created for modules, groupings, types, containers,\r
 140      * lists, choices, augments, rpcs, notification, identities.\r
 141      *\r
 142      * @param context\r
 143      *            schema context which contains data about all schema nodes\r
 144      *            saved in modules\r
 145      * @param modules\r
 146      *            set of modules for which schema nodes should be generated\r
 147      *            types\r
 148      * @return list of types (usually <code>GeneratedType</code> or\r
 149      *         <code>GeneratedTransferObject</code>) which:\r
 150      *         <ul>\r
 151      *         <li>are generated from <code>context</code> schema nodes and</li>\r
 152      *         <li>are also part of some of the module in <code>modules</code>\r
 153      *         set</li>.\r
 154      *         </ul>\r
 155      * @throws IllegalArgumentException\r
 156      *             <ul>\r
 157      *             <li>if param <code>context</code> is null or</li>\r
 158      *             <li>if param <code>modules</code> is null</li>\r
 159      *             </ul>\r
 160      * @throws IllegalStateException\r
 161      *             if <code>context</code> contain no modules\r
 162      */\r
 163     override generateTypes(SchemaContext context, Set<Module> modules) {\r
 164         checkArgument(context !== null, "Schema Context reference cannot be NULL.");\r
 165         checkState(context.modules !== null, "Schema Context does not contain defined modules.");\r
 166         checkArgument(modules !== null, "Set of Modules cannot be NULL.");\r
 167 \r
 168         val List<Type> filteredGenTypes = new ArrayList();\r
 169 \r
 170         schemaContext = context;\r
 171         typeProvider = new TypeProviderImpl(context);\r
 172         val contextModules = ModuleDependencySort.sort(context.modules);\r
 173         genTypeBuilders = new HashMap();\r
 174 \r
 175         for (contextModule : contextModules) {\r
 176             val List<Type> generatedTypes = new ArrayList();\r
 177             generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));\r
 178             generatedTypes.addAll(allGroupingsToGenTypes(contextModule));\r
 179             if(false == contextModule.childNodes.isEmpty()) {\r
 180                 generatedTypes.add(moduleToDataType(contextModule));\r
 181             }\r
 182             generatedTypes.addAll(allContainersToGenTypes(contextModule));\r
 183             generatedTypes.addAll(allListsToGenTypes(contextModule));\r
 184             generatedTypes.addAll(allChoicesToGenTypes(contextModule));\r
 185             generatedTypes.addAll(allRPCMethodsToGenType(contextModule));\r
 186             generatedTypes.addAll(allNotificationsToGenType(contextModule));\r
 187             generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));\r
 188 \r
 189             if(modules.contains(contextModule)) {\r
 190                 filteredGenTypes.addAll(generatedTypes);\r
 191             }\r
 192         }\r
 193         for (contextModule : contextModules) {\r
 194             val generatedTypes = (allAugmentsToGenTypes(contextModule));\r
 195             if(modules.contains(contextModule)) {\r
 196                 filteredGenTypes.addAll(generatedTypes);\r
 197             }\r
 198 \r
 199         }\r
 200         return filteredGenTypes;\r
 201     }\r
 202 \r
 203     /**\r
 204      * Converts all extended type definitions of module to the list of\r
 205      * <code>Type</code> objects.\r
 206      *\r
 207      * @param module\r
 208      *            module from which is obtained set of type definitions\r
 209      * @return list of <code>Type</code> which are generated from extended\r
 210      *         definition types (object of type <code>ExtendedType</code>)\r
 211      * @throws IllegalArgumentException\r
 212      *             <ul>\r
 213      *             <li>if module equals null</li>\r
 214      *             <li>if name of module equals null</li>\r
 215      *             <li>if type definitions of module equal null</li>\r
 216      *             </ul>\r
 217      *\r
 218      */\r
 219     private def List<Type> allTypeDefinitionsToGenTypes(Module module) {\r
 220         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 221         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 222         val Set<TypeDefinition<?>> typeDefinitions = module.typeDefinitions;\r
 223         checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');\r
 224 \r
 225         val List<Type> generatedTypes = new ArrayList();\r
 226         for (TypeDefinition<?> typedef : typeDefinitions) {\r
 227             if(typedef !== null) {\r
 228                 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);\r
 229                 if((type !== null) && !generatedTypes.contains(type)) {\r
 230                     generatedTypes.add(type);\r
 231                 }\r
 232             }\r
 233         }\r
 234         return generatedTypes;\r
 235     }\r
 236 \r
 237     /**\r
 238      * Converts all <b>containers</b> of the module to the list of\r
 239      * <code>Type</code> objects.\r
 240      *\r
 241      * @param module\r
 242      *            module from which is obtained DataNodeIterator to iterate over\r
 243      *            all containers\r
 244      * @return list of <code>Type</code> which are generated from containers\r
 245      *         (objects of type <code>ContainerSchemaNode</code>)\r
 246      * @throws IllegalArgumentException\r
 247      *             <ul>\r
 248      *             <li>if the module equals null</li>\r
 249      *             <li>if the name of module equals null</li>\r
 250      *             <li>if the set of child nodes equals null</li>\r
 251      *             </ul>\r
 252      *\r
 253      */\r
 254     private def List<Type> allContainersToGenTypes(Module module) {\r
 255         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 256 \r
 257         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 258 \r
 259         if(module.childNodes === null) {\r
 260             throw new IllegalArgumentException(\r
 261                 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");\r
 262         }\r
 263 \r
 264         val List<Type> generatedTypes = new ArrayList();\r
 265         val it = new DataNodeIterator(module);\r
 266         val List<ContainerSchemaNode> schemaContainers = it.allContainers();\r
 267         val basePackageName = moduleNamespaceToPackageName(module);\r
 268         for (container : schemaContainers) {\r
 269             if(!container.isAddedByUses()) {\r
 270                 generatedTypes.add(containerToGenType(basePackageName, container));\r
 271             }\r
 272         }\r
 273         return generatedTypes;\r
 274     }\r
 275 \r
 276     /**\r
 277      * Converts all <b>lists</b> of the module to the list of <code>Type</code>\r
 278      * objects.\r
 279      *\r
 280      * @param module\r
 281      *            module from which is obtained DataNodeIterator to iterate over\r
 282      *            all lists\r
 283      * @return list of <code>Type</code> which are generated from lists (objects\r
 284      *         of type <code>ListSchemaNode</code>)\r
 285      * @throws IllegalArgumentException\r
 286      *             <ul>\r
 287      *             <li>if the module equals null</li>\r
 288      *             <li>if the name of module equals null</li>\r
 289      *             <li>if the set of child nodes equals null</li>\r
 290      *             </ul>\r
 291      *\r
 292      */\r
 293     private def List<Type> allListsToGenTypes(Module module) {\r
 294         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 295         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 296 \r
 297         if(module.childNodes === null) {\r
 298             throw new IllegalArgumentException(\r
 299                 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");\r
 300         }\r
 301 \r
 302         val List<Type> generatedTypes = new ArrayList();\r
 303         val it = new DataNodeIterator(module);\r
 304         val List<ListSchemaNode> schemaLists = it.allLists();\r
 305         val basePackageName = moduleNamespaceToPackageName(module);\r
 306         if(schemaLists !== null) {\r
 307             for (list : schemaLists) {\r
 308                 if(!list.isAddedByUses()) {\r
 309                     generatedTypes.addAll(listToGenType(basePackageName, list));\r
 310                 }\r
 311             }\r
 312         }\r
 313         return generatedTypes;\r
 314     }\r
 315 \r
 316     /**\r
 317      * Converts all <b>choices</b> of the module to the list of\r
 318      * <code>Type</code> objects.\r
 319      *\r
 320      * @param module\r
 321      *            module from which is obtained DataNodeIterator to iterate over\r
 322      *            all choices\r
 323      * @return list of <code>Type</code> which are generated from choices\r
 324      *         (objects of type <code>ChoiceNode</code>)\r
 325      * @throws IllegalArgumentException\r
 326      *             <ul>\r
 327      *             <li>if the module equals null</li>\r
 328      *             <li>if the name of module equals null</li> *\r
 329      *             </ul>\r
 330      *\r
 331      */\r
 332     private def List<GeneratedType> allChoicesToGenTypes(Module module) {\r
 333         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 334         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 335 \r
 336         val it = new DataNodeIterator(module);\r
 337         val choiceNodes = it.allChoices();\r
 338         val basePackageName = moduleNamespaceToPackageName(module);\r
 339 \r
 340         val List<GeneratedType> generatedTypes = new ArrayList();\r
 341         for (choice : choiceNodes) {\r
 342             if((choice !== null) && !choice.isAddedByUses()) {\r
 343                 generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice));\r
 344             }\r
 345         }\r
 346         return generatedTypes;\r
 347     }\r
 348 \r
 349     /**\r
 350      * Converts all <b>augmentation</b> of the module to the list\r
 351      * <code>Type</code> objects.\r
 352      *\r
 353      * @param module\r
 354      *            module from which is obtained list of all augmentation objects\r
 355      *            to iterate over them\r
 356      * @return list of <code>Type</code> which are generated from augments\r
 357      *         (objects of type <code>AugmentationSchema</code>)\r
 358      * @throws IllegalArgumentException\r
 359      *             <ul>\r
 360      *             <li>if the module equals null</li>\r
 361      *             <li>if the name of module equals null</li>\r
 362      *             <li>if the set of child nodes equals null</li>\r
 363      *             </ul>\r
 364      *\r
 365      */\r
 366     private def List<Type> allAugmentsToGenTypes(Module module) {\r
 367         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 368         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 369         if(module.childNodes === null) {\r
 370             throw new IllegalArgumentException(\r
 371                 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");\r
 372         }\r
 373 \r
 374         val List<Type> generatedTypes = new ArrayList();\r
 375         val basePackageName = moduleNamespaceToPackageName(module);\r
 376         val List<AugmentationSchema> augmentations = resolveAugmentations(module);\r
 377         for (augment : augmentations) {\r
 378             generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment));\r
 379         }\r
 380         return generatedTypes;\r
 381     }\r
 382 \r
 383     /**\r
 384      * Returns list of <code>AugmentationSchema</code> objects. The objects are\r
 385      * sorted according to the length of their target path from the shortest to\r
 386      * the longest.\r
 387      *\r
 388      * @param module\r
 389      *            module from which is obtained list of all augmentation objects\r
 390      * @return list of sorted <code>AugmentationSchema</code> objects obtained\r
 391      *         from <code>module</code>\r
 392      * @throws IllegalArgumentException\r
 393      *             <ul>\r
 394      *             <li>if the module equals null</li>\r
 395      *             <li>if the set of augmentation equals null</li>\r
 396      *             </ul>\r
 397      *\r
 398      */\r
 399     private def List<AugmentationSchema> resolveAugmentations(Module module) {\r
 400         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 401         checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");\r
 402 \r
 403         val Set<AugmentationSchema> augmentations = module.augmentations;\r
 404         val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);\r
 405         Collections.sort(sortedAugmentations,\r
 406             [ augSchema1, augSchema2 |\r
 407                 if(augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {\r
 408                     return 1;\r
 409                 } else if(augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {\r
 410                     return -1;\r
 411                 }\r
 412                 return 0;\r
 413             ]);\r
 414         return sortedAugmentations;\r
 415     }\r
 416 \r
 417     /**\r
 418      * Converts whole <b>module</b> to <code>GeneratedType</code> object.\r
 419      * Firstly is created the module builder object from which is vally\r
 420      * obtained reference to <code>GeneratedType</code> object.\r
 421      *\r
 422      * @param module\r
 423      *            module from which are obtained the module name, child nodes,\r
 424      *            uses and is derived package name\r
 425      * @return <code>GeneratedType</code> which is internal representation of\r
 426      *         the module\r
 427      * @throws IllegalArgumentException\r
 428      *             if the module equals null\r
 429      *\r
 430      */\r
 431     private def GeneratedType moduleToDataType(Module module) {\r
 432         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 433 \r
 434         val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");\r
 435         addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);\r
 436         moduleDataTypeBuilder.addImplementsType(DATA_ROOT);\r
 437 \r
 438         val basePackageName = moduleNamespaceToPackageName(module);\r
 439         if(moduleDataTypeBuilder !== null) {\r
 440             val Set<DataSchemaNode> dataNodes = module.childNodes;\r
 441             resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);\r
 442         }\r
 443         return moduleDataTypeBuilder.toInstance();\r
 444     }\r
 445 \r
 446     /**\r
 447      * Converts all <b>rpcs</b> inputs and outputs substatements of the module\r
 448      * to the list of <code>Type</code> objects. In addition are to containers\r
 449      * and lists which belong to input or output also part of returning list.\r
 450      *\r
 451      * @param module\r
 452      *            module from which is obtained set of all rpc objects to\r
 453      *            iterate over them\r
 454      * @return list of <code>Type</code> which are generated from rpcs inputs,\r
 455      *         outputs + container and lists which are part of inputs or outputs\r
 456      * @throws IllegalArgumentException\r
 457      *             <ul>\r
 458      *             <li>if the module equals null</li>\r
 459      *             <li>if the name of module equals null</li>\r
 460      *             <li>if the set of child nodes equals null</li>\r
 461      *             </ul>\r
 462      *\r
 463      */\r
 464     private def List<Type> allRPCMethodsToGenType(Module module) {\r
 465         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 466 \r
 467         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 468 \r
 469         if(module.childNodes === null) {\r
 470             throw new IllegalArgumentException(\r
 471                 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");\r
 472         }\r
 473 \r
 474         val basePackageName = moduleNamespaceToPackageName(module);\r
 475         val Set<RpcDefinition> rpcDefinitions = module.rpcs;\r
 476 \r
 477         if(rpcDefinitions.isEmpty()) {\r
 478             return Collections.emptyList();\r
 479         }\r
 480 \r
 481         val List<Type> genRPCTypes = new ArrayList();\r
 482         val interfaceBuilder = moduleTypeBuilder(module, "Service");\r
 483         interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));\r
 484         for (rpc : rpcDefinitions) {\r
 485             if(rpc !== null) {\r
 486 \r
 487                 val rpcName = parseToClassName(rpc.QName.localName);\r
 488                 val rpcMethodName = parseToValidParamName(rpcName);\r
 489                 val method = interfaceBuilder.addMethod(rpcMethodName);\r
 490 \r
 491                 val rpcInOut = new ArrayList();\r
 492 \r
 493                 val input = rpc.input;\r
 494                 val output = rpc.output;\r
 495 \r
 496                 if(input !== null) {\r
 497                     rpcInOut.add(new DataNodeIterator(input));\r
 498                     val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);\r
 499                     addImplementedInterfaceFromUses(input, inType);\r
 500                     inType.addImplementsType(DATA_OBJECT);\r
 501                     inType.addImplementsType(augmentable(inType));\r
 502                     resolveDataSchemaNodes(basePackageName, inType, input.childNodes);\r
 503                     val inTypeInstance = inType.toInstance();\r
 504                     genRPCTypes.add(inTypeInstance);\r
 505                     method.addParameter(inTypeInstance, "input");\r
 506                 }\r
 507 \r
 508                 var Type outTypeInstance = VOID;\r
 509                 if(output !== null) {\r
 510                     rpcInOut.add(new DataNodeIterator(output));\r
 511                     val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);\r
 512                     addImplementedInterfaceFromUses(output, outType);\r
 513                     outType.addImplementsType(DATA_OBJECT);\r
 514                     outType.addImplementsType(augmentable(outType));\r
 515 \r
 516                     resolveDataSchemaNodes(basePackageName, outType, output.childNodes);\r
 517                     outTypeInstance = outType.toInstance();\r
 518                     genRPCTypes.add(outTypeInstance);\r
 519 \r
 520                 }\r
 521 \r
 522                 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);\r
 523                 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));\r
 524                 for (iter : rpcInOut) {\r
 525                     val List<ContainerSchemaNode> nContainers = iter.allContainers();\r
 526                     if((nContainers !== null) && !nContainers.isEmpty()) {\r
 527                         for (container : nContainers) {\r
 528                             if(!container.isAddedByUses()) {\r
 529                                 genRPCTypes.add(containerToGenType(basePackageName, container));\r
 530                             }\r
 531                         }\r
 532                     }\r
 533                     val List<ListSchemaNode> nLists = iter.allLists();\r
 534                     if((nLists !== null) && !nLists.isEmpty()) {\r
 535                         for (list : nLists) {\r
 536                             if(!list.isAddedByUses()) {\r
 537                                 genRPCTypes.addAll(listToGenType(basePackageName, list));\r
 538                             }\r
 539                         }\r
 540                     }\r
 541                 }\r
 542             }\r
 543         }\r
 544         genRPCTypes.add(interfaceBuilder.toInstance());\r
 545         return genRPCTypes;\r
 546     }\r
 547 \r
 548     /**\r
 549      * Converts all <b>notifications</b> of the module to the list of\r
 550      * <code>Type</code> objects. In addition are to this list added containers\r
 551      * and lists which are part of this notification.\r
 552      *\r
 553      * @param module\r
 554      *            module from which is obtained set of all notification objects\r
 555      *            to iterate over them\r
 556      * @return list of <code>Type</code> which are generated from notification\r
 557      *         (object of type <code>NotificationDefinition</code>\r
 558      * @throws IllegalArgumentException\r
 559      *             <ul>\r
 560      *             <li>if the module equals null</li>\r
 561      *             <li>if the name of module equals null</li>\r
 562      *             <li>if the set of child nodes equals null</li>\r
 563      *             </ul>\r
 564      *\r
 565      */\r
 566     private def List<Type> allNotificationsToGenType(Module module) {\r
 567         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 568 \r
 569         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 570 \r
 571         if(module.childNodes === null) {\r
 572             throw new IllegalArgumentException(\r
 573                 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");\r
 574         }\r
 575         val notifications = module.notifications;\r
 576         if(notifications.isEmpty()) return Collections.emptyList();\r
 577 \r
 578         val listenerInterface = moduleTypeBuilder(module, "Listener");\r
 579         listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);\r
 580 \r
 581         val basePackageName = moduleNamespaceToPackageName(module);\r
 582         val List<Type> generatedTypes = new ArrayList();\r
 583 \r
 584         for (notification : notifications) {\r
 585             if(notification !== null) {\r
 586                 val iter = new DataNodeIterator(notification);\r
 587 \r
 588                 // Containers\r
 589                 for (node : iter.allContainers()) {\r
 590                     if(!node.isAddedByUses()) {\r
 591                         generatedTypes.add(containerToGenType(basePackageName, node));\r
 592                     }\r
 593                 }\r
 594 \r
 595                 // Lists\r
 596                 for (node : iter.allLists()) {\r
 597                     if(!node.isAddedByUses()) {\r
 598                         generatedTypes.addAll(listToGenType(basePackageName, node));\r
 599                     }\r
 600                 }\r
 601                 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification);\r
 602                 notificationInterface.addImplementsType(NOTIFICATION);\r
 603 \r
 604                 // Notification object\r
 605                 resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);\r
 606 \r
 607                 listenerInterface.addMethod("on" + notificationInterface.name) //\r
 608                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").\r
 609                     setReturnType(Types.VOID);\r
 610 \r
 611                 generatedTypes.add(notificationInterface.toInstance());\r
 612             }\r
 613         }\r
 614         generatedTypes.add(listenerInterface.toInstance());\r
 615         return generatedTypes;\r
 616     }\r
 617 \r
 618     /**\r
 619      * Converts all <b>identities</b> of the module to the list of\r
 620      * <code>Type</code> objects.\r
 621      *\r
 622      * @param module\r
 623      *            module from which is obtained set of all identity objects to\r
 624      *            iterate over them\r
 625      * @param context\r
 626      *            schema context only used as input parameter for method\r
 627      *            {@link identityToGenType}\r
 628      * @return list of <code>Type</code> which are generated from identities\r
 629      *         (object of type <code>IdentitySchemaNode</code>\r
 630      *\r
 631      */\r
 632     private def List<Type> allIdentitiesToGenTypes(Module module, SchemaContext context) {\r
 633         val List<Type> genTypes = new ArrayList();\r
 634 \r
 635         val Set<IdentitySchemaNode> schemaIdentities = module.identities;\r
 636 \r
 637         val basePackageName = moduleNamespaceToPackageName(module);\r
 638 \r
 639         if(schemaIdentities !== null && !schemaIdentities.isEmpty()) {\r
 640             for (identity : schemaIdentities) {\r
 641                 genTypes.add(identityToGenType(basePackageName, identity, context));\r
 642             }\r
 643         }\r
 644         return genTypes;\r
 645     }\r
 646 \r
 647     /**\r
 648      * Converts the <b>identity</b> object to GeneratedType. Firstly it is\r
 649      * created transport object builder. If identity contains base identity then\r
 650      * reference to base identity is added to superior identity as its extend.\r
 651      * If identity doesn't contain base identity then only reference to abstract\r
 652      * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity\r
 653      * BaseIdentity} is added\r
 654      *\r
 655      * @param basePackageName\r
 656      *            string contains the module package name\r
 657      * @param identity\r
 658      *            IdentitySchemaNode which contains data about identity\r
 659      * @param context\r
 660      *            SchemaContext which is used to get package and name\r
 661      *            information about base of identity\r
 662      *\r
 663      * @return GeneratedType which is generated from identity (object of type\r
 664      *         <code>IdentitySchemaNode</code>\r
 665      *\r
 666      */\r
 667     private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,\r
 668         SchemaContext context) {\r
 669         if(identity === null) {\r
 670             return null;\r
 671         }\r
 672 \r
 673         val packageName = packageNameForGeneratedType(basePackageName, identity.path);\r
 674         val genTypeName = parseToClassName(identity.QName.localName);\r
 675         val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);\r
 676 \r
 677         val baseIdentity = identity.baseIdentity;\r
 678         if(baseIdentity !== null) {\r
 679             val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);\r
 680 \r
 681             val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);\r
 682             val returnTypeName = parseToClassName(baseIdentity.QName.localName);\r
 683 \r
 684             val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();\r
 685             newType.setExtendsType(gto);\r
 686         } else {\r
 687             newType.setExtendsType(Types.baseIdentityTO);\r
 688         }\r
 689         newType.setAbstract(true);\r
 690         return newType.toInstance();\r
 691     }\r
 692 \r
 693     /**\r
 694      * Converts all <b>groupings</b> of the module to the list of\r
 695      * <code>Type</code> objects. Firstly are groupings sorted according mutual\r
 696      * dependencies. At least dependend (indepedent) groupings are in the list\r
 697      * saved at first positions. For every grouping the record is added to map\r
 698      * {@link BindingGeneratorImpl#allGroupings allGroupings}\r
 699      *\r
 700      * @param module\r
 701      *            module from which is obtained set of all grouping objects to\r
 702      *            iterate over them\r
 703      * @return list of <code>Type</code> which are generated from groupings\r
 704      *         (object of type <code>GroupingDefinition</code>)\r
 705      *\r
 706      */\r
 707     private def List<Type> allGroupingsToGenTypes(Module module) {\r
 708         checkArgument(module !== null, "Module parameter can not be null");\r
 709         val List<Type> genTypes = new ArrayList();\r
 710         val basePackageName = moduleNamespaceToPackageName(module);\r
 711         val Set<GroupingDefinition> groupings = module.groupings;\r
 712         val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(\r
 713             groupings);\r
 714 \r
 715         for (grouping : groupingsSortedByDependencies) {\r
 716             val genType = groupingToGenType(basePackageName, grouping);\r
 717             genTypes.add(genType);\r
 718             val schemaPath = grouping.path;\r
 719             allGroupings.put(schemaPath, genType);\r
 720         }\r
 721         return genTypes;\r
 722     }\r
 723 \r
 724     /**\r
 725      * Converts individual grouping to GeneratedType. Firstly generated type\r
 726      * builder is created and every child node of grouping is resolved to the\r
 727      * method.\r
 728      *\r
 729      * @param basePackageName\r
 730      *            string contains the module package name\r
 731      * @param grouping\r
 732      *            GroupingDefinition which contains data about grouping\r
 733      * @return GeneratedType which is generated from grouping (object of type\r
 734      *         <code>GroupingDefinition</code>)\r
 735      */\r
 736     private def GeneratedType groupingToGenType(String basePackageName, GroupingDefinition grouping) {\r
 737         if(grouping === null) {\r
 738             return null;\r
 739         }\r
 740 \r
 741         val packageName = packageNameForGeneratedType(basePackageName, grouping.path);\r
 742         val Set<DataSchemaNode> schemaNodes = grouping.childNodes;\r
 743         val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);\r
 744 \r
 745         resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);\r
 746         return typeBuilder.toInstance();\r
 747     }\r
 748 \r
 749     /**\r
 750      * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base\r
 751      * type of <code>typeDefinition</code> is of the type ExtendedType then this\r
 752      * method is recursivelly called with this base type.\r
 753      *\r
 754      * @param typeDefinition\r
 755      *            TypeDefinition in which should be EnumTypeDefinition found as\r
 756      *            base type\r
 757      * @return EnumTypeDefinition if it is found inside\r
 758      *         <code>typeDefinition</code> or <code>null</code> in other case\r
 759      */\r
 760     private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {\r
 761         if(typeDefinition !== null) {\r
 762             if(typeDefinition.baseType instanceof EnumTypeDefinition) {\r
 763                 return typeDefinition.baseType as EnumTypeDefinition;\r
 764             } else if(typeDefinition.baseType instanceof ExtendedType) {\r
 765                 return enumTypeDefFromExtendedType(typeDefinition.baseType);\r
 766             }\r
 767         }\r
 768         return null;\r
 769     }\r
 770 \r
 771     /**\r
 772      * Adds enumeration builder created from <code>enumTypeDef</code> to\r
 773      * <code>typeBuilder</code>.\r
 774      *\r
 775      * Each <code>enumTypeDef</code> item is added to builder with its name and\r
 776      * value.\r
 777      *\r
 778      * @param enumTypeDef\r
 779      *            EnumTypeDefinition contains enum data\r
 780      * @param enumName\r
 781      *            string contains name which will be assigned to enumeration\r
 782      *            builder\r
 783      * @param typeBuilder\r
 784      *            GeneratedTypeBuilder to which will be enum builder assigned\r
 785      * @return enumeration builder which contais data from\r
 786      *         <code>enumTypeDef</code>\r
 787      */\r
 788     private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, String enumName,\r
 789         GeneratedTypeBuilder typeBuilder) {\r
 790         if((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&\r
 791             (enumTypeDef.QName.localName !== null)) {\r
 792 \r
 793             val enumerationName = parseToClassName(enumName);\r
 794             val enumBuilder = typeBuilder.addEnumeration(enumerationName);\r
 795             enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);\r
 796 \r
 797             return enumBuilder;\r
 798         }\r
 799         return null;\r
 800     }\r
 801 \r
 802     /**\r
 803      * Generates type builder for <code>module</code>.\r
 804      *\r
 805      * @param module\r
 806      *            Module which is source of package name for generated type\r
 807      *            builder\r
 808      * @param postfix\r
 809      *            string which is added to the module class name representation\r
 810      *            as suffix\r
 811      * @return instance of GeneratedTypeBuilder which represents\r
 812      *         <code>module</code>.\r
 813      * @throws IllegalArgumentException\r
 814      *             if <code>module</code> equals null\r
 815      */\r
 816     private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {\r
 817         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 818         val packageName = moduleNamespaceToPackageName(module);\r
 819         val moduleName = parseToClassName(module.name) + postfix;\r
 820 \r
 821         return new GeneratedTypeBuilderImpl(packageName, moduleName);\r
 822 \r
 823     }\r
 824 \r
 825     /**\r
 826      * Converts <code>augSchema</code> to list of <code>Type</code> which\r
 827      * contains generated type for augmentation. In addition there are also\r
 828      * generated types for all containers, list and choices which are child of\r
 829      * <code>augSchema</code> node or a generated types for cases are added if\r
 830      * augmented node is choice.\r
 831      *\r
 832      * @param augmentPackageName\r
 833      *            string with the name of the package to which the augmentation\r
 834      *            belongs\r
 835      * @param augSchema\r
 836      *            AugmentationSchema which is contains data about agumentation\r
 837      *            (target path, childs...)\r
 838      * @return list of <code>Type</code> objects which contains generated type\r
 839      *         for augmentation and for container, list and choice child nodes\r
 840      * @throws IllegalArgumentException\r
 841      *             <ul>\r
 842      *             <li>if <code>augmentPackageName</code> equals null</li>\r
 843      *             <li>if <code>augSchema</code> equals null</li>\r
 844      *             <li>if target path of <code>augSchema</code> equals null</li>\r
 845      *             </ul>\r
 846      */\r
 847     private def List<Type> augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema) {\r
 848         checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");\r
 849         checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");\r
 850         checkState(augSchema.targetPath !== null,\r
 851             "Augmentation Schema does not contain Target Path (Target Path is NULL).");\r
 852         val List<Type> genTypes = new ArrayList();\r
 853 \r
 854         // EVERY augmented interface will extends Augmentation<T> interface\r
 855         // and DataObject interface!!!\r
 856         val targetPath = augSchema.targetPath;\r
 857         val targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);\r
 858         if(targetSchemaNode !== null) {\r
 859             var targetType = yangToJavaMapping.get(targetSchemaNode.path);\r
 860             if(targetType == null) {\r
 861 \r
 862                 // FIXME: augmentation should be added as last, all types should already be generated\r
 863                 // and have assigned Java Types,\r
 864                 val targetModule = findParentModule(schemaContext, targetSchemaNode);\r
 865                 val targetBasePackage = moduleNamespaceToPackageName(targetModule);\r
 866                 val typePackage = packageNameForGeneratedType(targetBasePackage, targetSchemaNode.getPath());\r
 867                 val targetSchemaNodeName = targetSchemaNode.getQName().getLocalName();\r
 868                 val typeName = parseToClassName(targetSchemaNodeName);\r
 869                 targetType = new ReferencedTypeImpl(typePackage, typeName);\r
 870             }\r
 871             val augChildNodes = augSchema.childNodes;\r
 872             if(!(targetSchemaNode instanceof ChoiceNode)) {\r
 873                 val augTypeBuilder = addRawAugmentGenTypeDefinition(augmentPackageName, targetType, augSchema);\r
 874                 val augType = augTypeBuilder.toInstance();\r
 875                 genTypes.add(augType);\r
 876             } else {\r
 877                 val choiceTarget = targetSchemaNode as ChoiceNode;\r
 878                 val choiceCaseNodes = choiceTarget.cases;\r
 879                 genTypes.addAll(\r
 880                     generateTypesFromAugmentedChoiceCases(augmentPackageName, targetType, choiceCaseNodes));\r
 881             }\r
 882             genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes));\r
 883         }\r
 884         return genTypes;\r
 885     }\r
 886 \r
 887     /**\r
 888      * Returns a generated type builder for an augmentation.\r
 889      *\r
 890      * The name of the type builder is equal to the name of augmented node with\r
 891      * serial number as suffix.\r
 892      *\r
 893      * @param augmentPackageName\r
 894      *            string with contains the package name to which the augment\r
 895      *            belongs\r
 896      * @param targetPackageName\r
 897      *            string with the package name to which the augmented node\r
 898      *            belongs\r
 899      * @param targetSchemaNodeName\r
 900      *            string with the name of the augmented node\r
 901      * @param augSchema\r
 902      *            augmentation schema which contains data about the child nodes\r
 903      *            and uses of augment\r
 904      * @return generated type builder for augment\r
 905      */\r
 906     private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(String augmentPackageName, Type targetTypeRef,\r
 907         AugmentationSchema augSchema) {\r
 908         var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);\r
 909         if(augmentBuilders === null) {\r
 910             augmentBuilders = new HashMap();\r
 911             genTypeBuilders.put(augmentPackageName, augmentBuilders);\r
 912         }\r
 913         val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);\r
 914 \r
 915         val augTypeName = if(augIdentifier !== null) {\r
 916                 parseToClassName(augIdentifier)\r
 917             } else {\r
 918                 augGenTypeName(augmentBuilders, targetTypeRef.name);\r
 919             }\r
 920         val Set<DataSchemaNode> augChildNodes = augSchema.childNodes;\r
 921 \r
 922         val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);\r
 923 \r
 924         augTypeBuilder.addImplementsType(DATA_OBJECT);\r
 925         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));\r
 926         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);\r
 927 \r
 928         augSchemaNodeToMethods(augmentPackageName, augTypeBuilder, augChildNodes);\r
 929         augmentBuilders.put(augTypeName, augTypeBuilder);\r
 930         return augTypeBuilder;\r
 931     }\r
 932 \r
 933     /**\r
 934      *\r
 935      * @param unknownSchemaNodes\r
 936      * @return nodeParameter of UnknownSchemaNode\r
 937      */\r
 938     private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {\r
 939         for (unknownSchemaNode : unknownSchemaNodes) {\r
 940             val nodeType = unknownSchemaNode.nodeType;\r
 941             if(AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&\r
 942                 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {\r
 943                 return unknownSchemaNode.nodeParameter;\r
 944             }\r
 945         }\r
 946         return null;\r
 947     }\r
 948 \r
 949     /**\r
 950      * Convert a container, list and choice subnodes (and recursivelly their\r
 951      * subnodes) of augment to generated types\r
 952      *\r
 953      * @param augBasePackageName\r
 954      *            string with the augment package name\r
 955      * @param augChildNodes\r
 956      *            set of data schema nodes which represents child nodes of the\r
 957      *            augment\r
 958      *\r
 959      * @return list of <code>Type</code> which represents container, list and\r
 960      *         choice subnodes of augment\r
 961      */\r
 962     private def List<Type> augmentationBodyToGenTypes(String augBasePackageName, Set<DataSchemaNode> augChildNodes) {\r
 963         val List<Type> genTypes = new ArrayList();\r
 964         val List<DataNodeIterator> augSchemaIts = new ArrayList();\r
 965         for (childNode : augChildNodes) {\r
 966             if(childNode instanceof DataNodeContainer) {\r
 967                 augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));\r
 968 \r
 969                 if(childNode instanceof ContainerSchemaNode) {\r
 970                     genTypes.add(containerToGenType(augBasePackageName, childNode as ContainerSchemaNode));\r
 971                 } else if(childNode instanceof ListSchemaNode) {\r
 972                     genTypes.addAll(listToGenType(augBasePackageName, childNode as ListSchemaNode));\r
 973                 }\r
 974             } else if(childNode instanceof ChoiceNode) {\r
 975                 val choice = childNode as ChoiceNode;\r
 976                 for (caseNode : choice.cases) {\r
 977                     augSchemaIts.add(new DataNodeIterator(caseNode));\r
 978                 }\r
 979                 genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode));\r
 980             }\r
 981         }\r
 982 \r
 983         for (it : augSchemaIts) {\r
 984             val List<ContainerSchemaNode> augContainers = it.allContainers();\r
 985             val List<ListSchemaNode> augLists = it.allLists();\r
 986             val List<ChoiceNode> augChoices = it.allChoices();\r
 987 \r
 988             if(augContainers !== null) {\r
 989                 for (container : augContainers) {\r
 990                     genTypes.add(containerToGenType(augBasePackageName, container));\r
 991                 }\r
 992             }\r
 993             if(augLists !== null) {\r
 994                 for (list : augLists) {\r
 995                     genTypes.addAll(listToGenType(augBasePackageName, list));\r
 996                 }\r
 997             }\r
 998             if(augChoices !== null) {\r
 999                 for (choice : augChoices) {\r
1000                     genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice));\r
1001                 }\r
1002             }\r
1003         }\r
1004         return genTypes;\r
1005     }\r
1006 \r
1007     /**\r
1008      * Returns first unique name for the augment generated type builder. The\r
1009      * generated type builder name for augment consists from name of augmented\r
1010      * node and serial number of its augmentation.\r
1011      *\r
1012      * @param builders\r
1013      *            map of builders which were created in the package to which the\r
1014      *            augmentation belongs\r
1015      * @param genTypeName\r
1016      *            string with name of augmented node\r
1017      * @return string with unique name for augmentation builder\r
1018      */\r
1019     private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {\r
1020         var index = 1;\r
1021         while((builders !== null) && builders.containsKey(genTypeName + index)) {\r
1022             index = index + 1;\r
1023         }\r
1024         return genTypeName + index;\r
1025     }\r
1026 \r
1027     /**\r
1028      * Converts <code>containerNode</code> to generated type. Firstly the\r
1029      * generated type builder is created. The subnodes of\r
1030      * <code>containerNode</code> are added as methods and the instance of\r
1031      * <code>GeneratedType</code> is returned.\r
1032      *\r
1033      * @param basePackageName\r
1034      *            string contains the module package name\r
1035      * @param containerNode\r
1036      *            container schema node with the data about childs nodes and\r
1037      *            schema paths\r
1038      * @return generated type for <code>containerNode</code>\r
1039      */\r
1040     private def GeneratedType containerToGenType(String basePackageName, ContainerSchemaNode containerNode) {\r
1041         if(containerNode === null) {\r
1042             return null;\r
1043         }\r
1044 \r
1045         val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);\r
1046         val schemaNodes = containerNode.childNodes;\r
1047         val typeBuilder = addDefaultInterfaceDefinition(packageName, containerNode);\r
1048 \r
1049         resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);\r
1050         return typeBuilder.toInstance();\r
1051     }\r
1052 \r
1053     /**\r
1054      * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
1055      * node for which <code>typeBuilder</code> was created.\r
1056      *\r
1057      * The subnodes aren't mapped to the methods if they are part of grouping or\r
1058      * augment (in this case are already part of them).\r
1059      *\r
1060      * @param basePackageName\r
1061      *            string contains the module package name\r
1062      * @param typeBuilder\r
1063      *            generated type builder which represents any node. The subnodes\r
1064      *            of this node are added to the <code>typeBuilder</code> as\r
1065      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1066      *            container, choice.\r
1067      * @param schemaNodes\r
1068      *            set of data schema nodes which are the children of the node\r
1069      *            for which <code>typeBuilder</code> was created\r
1070      * @return generated type builder which is the same builder as input\r
1071      *         parameter. The getter methods (representing child nodes) could be\r
1072      *         added to it.\r
1073      */\r
1074     private def GeneratedTypeBuilder resolveDataSchemaNodes(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1075         Set<DataSchemaNode> schemaNodes) {\r
1076         if((schemaNodes !== null) && (typeBuilder !== null)) {\r
1077             for (schemaNode : schemaNodes) {\r
1078                 if(!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {\r
1079                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
1080                 }\r
1081 \r
1082             }\r
1083         }\r
1084         return typeBuilder;\r
1085     }\r
1086 \r
1087     /**\r
1088      * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
1089      * node for which <code>typeBuilder</code> was created.\r
1090      *\r
1091      * @param basePackageName\r
1092      *            string contains the module package name\r
1093      * @param typeBuilder\r
1094      *            generated type builder which represents any node. The subnodes\r
1095      *            of this node are added to the <code>typeBuilder</code> as\r
1096      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1097      *            container, choice.\r
1098      * @param schemaNodes\r
1099      *            set of data schema nodes which are the children of the node\r
1100      *            for which <code>typeBuilder</code> was created\r
1101      * @return generated type builder which is the same object as the input\r
1102      *         parameter <code>typeBuilder</code>. The getter method could be\r
1103      *         added to it.\r
1104      */\r
1105     private def GeneratedTypeBuilder augSchemaNodeToMethods(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1106         Set<DataSchemaNode> schemaNodes) {\r
1107         if((schemaNodes !== null) && (typeBuilder !== null)) {\r
1108             for (schemaNode : schemaNodes) {\r
1109                 if(schemaNode.isAugmenting()) {\r
1110                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
1111                 }\r
1112             }\r
1113         }\r
1114         return typeBuilder;\r
1115     }\r
1116 \r
1117     /**\r
1118      * Adds to <code>typeBuilder</code> a method which is derived from\r
1119      * <code>schemaNode</code>.\r
1120      *\r
1121      * @param basePackageName\r
1122      *            string with the module package name\r
1123      * @param schemaNode\r
1124      *            data schema node which is added to <code>typeBuilder</code> as\r
1125      *            a method\r
1126      * @param typeBuilder\r
1127      *            generated type builder to which is <code>schemaNode</code>\r
1128      *            added as a method.\r
1129      */\r
1130     private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,\r
1131         GeneratedTypeBuilder typeBuilder) {\r
1132         if(node !== null && typeBuilder !== null) {\r
1133             switch (node) {\r
1134                 case node instanceof LeafSchemaNode:\r
1135                     resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)\r
1136                 case node instanceof LeafListSchemaNode:\r
1137                     resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)\r
1138                 case node instanceof ContainerSchemaNode:\r
1139                     resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)\r
1140                 case node instanceof ListSchemaNode:\r
1141                     resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)\r
1142                 case node instanceof ChoiceNode:\r
1143                     resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)\r
1144             }\r
1145         }\r
1146     }\r
1147 \r
1148     /**\r
1149      * Creates a getter method for a choice node.\r
1150      *\r
1151      * Firstly generated type builder for choice is created or found in\r
1152      * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
1153      * in the builder is created as concatenation of module package name and\r
1154      * names of all parent nodes. In the end the getter method for choice is\r
1155      * added to <code>typeBuilder</code> and return type is set to choice\r
1156      * builder.\r
1157      *\r
1158      * @param basePackageName\r
1159      *            string with the module package name\r
1160      * @param typeBuilder\r
1161      *            generated type builder to which is <code>choiceNode</code>\r
1162      *            added as getter method\r
1163      * @param choiceNode\r
1164      *            choice node which is mapped as a getter method\r
1165      * @throws IllegalArgumentException\r
1166      *             <ul>\r
1167      *             <li>if <code>basePackageName</code> equals null</li>\r
1168      *             <li>if <code>typeBuilder</code> equals null</li>\r
1169      *             <li>if <code>choiceNode</code> equals null</li>\r
1170      *             </ul>\r
1171      *\r
1172      */\r
1173     private def void resolveChoiceSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1174         ChoiceNode choiceNode) {\r
1175         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1176         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");\r
1177         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");\r
1178 \r
1179         val choiceName = choiceNode.QName.localName;\r
1180         if(choiceName !== null && !choiceNode.isAddedByUses()) {\r
1181             val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);\r
1182             val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);\r
1183             constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);\r
1184         }\r
1185     }\r
1186 \r
1187     /**\r
1188      * Converts <code>choiceNode</code> to the list of generated types for\r
1189      * choice and its cases.\r
1190      *\r
1191      * The package names for choice and for its cases are created as\r
1192      * concatenation of the module package (<code>basePackageName</code>) and\r
1193      * names of all parents node.\r
1194      *\r
1195      * @param basePackageName\r
1196      *            string with the module package name\r
1197      * @param choiceNode\r
1198      *            choice node which is mapped to generated type. Also child\r
1199      *            nodes - cases are mapped to generated types.\r
1200      * @return list of generated types which contains generated type for choice\r
1201      *         and generated types for all cases which aren't added do choice\r
1202      *         through <i>uses</i>.\r
1203      * @throws IllegalArgumentException\r
1204      *             <ul>\r
1205      *             <li>if <code>basePackageName</code> equals null</li>\r
1206      *             <li>if <code>choiceNode</code> equals null</li>\r
1207      *             </ul>\r
1208      *\r
1209      */\r
1210     private def List<GeneratedType> choiceToGeneratedType(String basePackageName, ChoiceNode choiceNode) {\r
1211         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1212         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");\r
1213 \r
1214         val List<GeneratedType> generatedTypes = new ArrayList();\r
1215         val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);\r
1216         val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);\r
1217 \r
1218         //choiceTypeBuilder.addImplementsType(DATA_OBJECT);\r
1219         val choiceType = choiceTypeBuilder.toInstance();\r
1220 \r
1221         generatedTypes.add(choiceType);\r
1222         val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;\r
1223         if((caseNodes !== null) && !caseNodes.isEmpty()) {\r
1224             generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes));\r
1225         }\r
1226         return generatedTypes;\r
1227     }\r
1228 \r
1229     /**\r
1230      * Converts <code>caseNodes</code> set to list of corresponding generated\r
1231      * types.\r
1232      *\r
1233      * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
1234      * created generated type builder. The package names for the builder is\r
1235      * created as concatenation of the module package (\r
1236      * <code>basePackageName</code>) and names of all parents nodes of the\r
1237      * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
1238      * between every case builder and <i>choice</i> type\r
1239      *\r
1240      * @param basePackageName\r
1241      *            string with the module package name\r
1242      * @param refChoiceType\r
1243      *            type which represents superior <i>case</i>\r
1244      * @param caseNodes\r
1245      *            set of choice case nodes which are mapped to generated types\r
1246      * @return list of generated types for <code>caseNodes</code>.\r
1247      * @throws IllegalArgumentException\r
1248      *             <ul>\r
1249      *             <li>if <code>basePackageName</code> equals null</li>\r
1250      *             <li>if <code>refChoiceType</code> equals null</li>\r
1251      *             <li>if <code>caseNodes</code> equals null</li>\r
1252      *             </ul>\r
1253      *             *\r
1254      */\r
1255     private def List<GeneratedType> generateTypesFromChoiceCases(String basePackageName, Type refChoiceType,\r
1256         Set<ChoiceCaseNode> caseNodes) {\r
1257         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1258         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");\r
1259         checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");\r
1260 \r
1261         val List<GeneratedType> generatedTypes = new ArrayList();\r
1262         for (caseNode : caseNodes) {\r
1263             if(caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {\r
1264                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);\r
1265                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
1266                 caseTypeBuilder.addImplementsType(refChoiceType);\r
1267 \r
1268                 val Set<DataSchemaNode> childNodes = caseNode.childNodes;\r
1269                 if(childNodes !== null) {\r
1270                     resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);\r
1271                 }\r
1272                 generatedTypes.add(caseTypeBuilder.toInstance());\r
1273             }\r
1274         }\r
1275 \r
1276         return generatedTypes;\r
1277     }\r
1278 \r
1279     /**\r
1280      * Generates list of generated types for all the cases of a choice which are\r
1281      * added to the choice through the augment.\r
1282      *\r
1283      *\r
1284      * @param basePackageName\r
1285      *            string contains name of package to which augment belongs. If\r
1286      *            an augmented choice is from an other package (pcg1) than an\r
1287      *            augmenting choice (pcg2) then case's of the augmenting choice\r
1288      *            will belong to pcg2.\r
1289      * @param refChoiceType\r
1290      *            Type which represents the choice to which case belongs. Every\r
1291      *            case has to contain its choice in extend part.\r
1292      * @param caseNodes\r
1293      *            set of choice case nodes for which is checked if are/aren't\r
1294      *            added to choice through augmentation\r
1295      * @return list of generated types which represents augmented cases of\r
1296      *         choice <code>refChoiceType</code>\r
1297      * @throws IllegalArgumentException\r
1298      *             <ul>\r
1299      *             <li>if <code>basePackageName</code> equals null</li>\r
1300      *             <li>if <code>refChoiceType</code> equals null</li>\r
1301      *             <li>if <code>caseNodes</code> equals null</li>\r
1302      *             </ul>\r
1303      */\r
1304     private def List<GeneratedType> generateTypesFromAugmentedChoiceCases(String basePackageName, Type refChoiceType,\r
1305         Set<ChoiceCaseNode> caseNodes) {\r
1306         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1307         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");\r
1308         checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");\r
1309 \r
1310         val List<GeneratedType> generatedTypes = new ArrayList();\r
1311         for (caseNode : caseNodes) {\r
1312             if(caseNode !== null && caseNode.isAugmenting()) {\r
1313                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);\r
1314                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
1315                 caseTypeBuilder.addImplementsType(refChoiceType);\r
1316 \r
1317                 val Set<DataSchemaNode> childNodes = caseNode.childNodes;\r
1318                 if(childNodes !== null) {\r
1319                     resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);\r
1320                 }\r
1321                 generatedTypes.add(caseTypeBuilder.toInstance());\r
1322             }\r
1323         }\r
1324 \r
1325         return generatedTypes;\r
1326     }\r
1327 \r
1328     /**\r
1329      * Converts <code>leaf</code> to the getter method which is added to\r
1330      * <code>typeBuilder</code>.\r
1331      *\r
1332      * @param typeBuilder\r
1333      *            generated type builder to which is added getter method as\r
1334      *            <code>leaf</code> mapping\r
1335      * @param leaf\r
1336      *            leaf schema node which is mapped as getter method which is\r
1337      *            added to <code>typeBuilder</code>\r
1338      * @return boolean value\r
1339      *         <ul>\r
1340      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
1341      *         null</li>\r
1342      *         <li>true - in other cases</li>\r
1343      *         </ul>\r
1344      */\r
1345     private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {\r
1346         if((leaf !== null) && (typeBuilder !== null)) {\r
1347             val leafName = leaf.QName.localName;\r
1348             var String leafDesc = leaf.description;\r
1349             if(leafDesc === null) {\r
1350                 leafDesc = "";\r
1351             }\r
1352 \r
1353             val parentModule = findParentModule(schemaContext, leaf);\r
1354             if(leafName !== null && !leaf.isAddedByUses()) {\r
1355                 val TypeDefinition<?> typeDef = leaf.type;\r
1356 \r
1357                 var Type returnType = null;\r
1358                 if(typeDef instanceof EnumTypeDefinition) {\r
1359                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1360                     val enumTypeDef = typeDef as EnumTypeDefinition;\r
1361                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);\r
1362 \r
1363                     if(enumBuilder !== null) {\r
1364                         returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);\r
1365                     }\r
1366                     (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);\r
1367                 } else if(typeDef instanceof UnionType) {\r
1368                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
1369                     if(genTOBuilder !== null) {\r
1370                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1371                     }\r
1372                 } else if(typeDef instanceof BitsTypeDefinition) {\r
1373                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
1374                     if(genTOBuilder !== null) {\r
1375                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1376                     }\r
1377                 } else {\r
1378                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1379                 }\r
1380                 if(returnType !== null) {\r
1381                     constructGetter(typeBuilder, leafName, leafDesc, returnType);\r
1382                     return true;\r
1383                 }\r
1384             }\r
1385         }\r
1386         return false;\r
1387     }\r
1388 \r
1389     /**\r
1390      * Converts <code>leaf</code> schema node to property of generated TO\r
1391      * builder.\r
1392      *\r
1393      * @param toBuilder\r
1394      *            generated TO builder to which is <code>leaf</code> added as\r
1395      *            property\r
1396      * @param leaf\r
1397      *            leaf schema node which is added to <code>toBuilder</code> as\r
1398      *            property\r
1399      * @param isReadOnly\r
1400      *            boolean value which says if leaf property is|isn't read only\r
1401      * @return boolean value\r
1402      *         <ul>\r
1403      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
1404      *         name equals null or if leaf is added by <i>uses</i>.</li>\r
1405      *         <li>true - other cases</li>\r
1406      *         </ul>\r
1407      */\r
1408     private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,\r
1409         boolean isReadOnly) {\r
1410         if((leaf !== null) && (toBuilder !== null)) {\r
1411             val leafName = leaf.QName.localName;\r
1412             var String leafDesc = leaf.description;\r
1413             if(leafDesc === null) {\r
1414                 leafDesc = "";\r
1415             }\r
1416 \r
1417             if(leafName !== null) {\r
1418                 val TypeDefinition<?> typeDef = leaf.type;\r
1419 \r
1420                 // TODO: properly resolve enum types\r
1421                 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1422 \r
1423                 if(returnType !== null) {\r
1424                     val propBuilder = toBuilder.addProperty(parseToClassName(leafName));\r
1425 \r
1426                     propBuilder.setReadOnly(isReadOnly);\r
1427                     propBuilder.setReturnType(returnType);\r
1428                     propBuilder.setComment(leafDesc);\r
1429 \r
1430                     toBuilder.addEqualsIdentity(propBuilder);\r
1431                     toBuilder.addHashIdentity(propBuilder);\r
1432                     toBuilder.addToStringProperty(propBuilder);\r
1433 \r
1434                     return true;\r
1435                 }\r
1436             }\r
1437         }\r
1438         return false;\r
1439     }\r
1440 \r
1441     /**\r
1442      * Converts <code>node</code> leaf list schema node to getter method of\r
1443      * <code>typeBuilder</code>.\r
1444      *\r
1445      * @param typeBuilder\r
1446      *            generated type builder to which is <code>node</code> added as\r
1447      *            getter method\r
1448      * @param node\r
1449      *            leaf list schema node which is added to\r
1450      *            <code>typeBuilder</code> as getter method\r
1451      * @return boolean value\r
1452      *         <ul>\r
1453      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
1454      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
1455      *         <li>false - other cases</li>\r
1456      *         </ul>\r
1457      */\r
1458     private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {\r
1459         if((node !== null) && (typeBuilder !== null)) {\r
1460             val nodeName = node.QName.localName;\r
1461             var String nodeDesc = node.description;\r
1462             if(nodeDesc === null) {\r
1463                 nodeDesc = "";\r
1464             }\r
1465 \r
1466             if(nodeName !== null && !node.isAddedByUses()) {\r
1467                 val TypeDefinition<?> type = node.type;\r
1468                 val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));\r
1469 \r
1470                 constructGetter(typeBuilder, nodeName, nodeDesc, listType);\r
1471                 return true;\r
1472             }\r
1473         }\r
1474         return false;\r
1475     }\r
1476 \r
1477     /**\r
1478      * Creates a getter method for a container node.\r
1479      *\r
1480      * Firstly generated type builder for container is created or found in\r
1481      * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
1482      * in the builder is created as concatenation of module package name and\r
1483      * names of all parent nodes. In the end the getter method for container is\r
1484      * added to <code>typeBuilder</code> and return type is set to container\r
1485      * type builder.\r
1486      *\r
1487      * @param basePackageName\r
1488      *            string with the module package name\r
1489      * @param typeBuilder\r
1490      *            generated type builder to which is <code>containerNode</code>\r
1491      *            added as getter method\r
1492      * @param containerNode\r
1493      *            container schema node which is mapped as getter method to\r
1494      *            <code>typeBuilder</code>\r
1495      * @return boolean value\r
1496      *         <ul>\r
1497      *         <li>false - if <code>containerNode</code>,\r
1498      *         <code>typeBuilder</code>, container node name equal null or\r
1499      *         <code>containerNode</code> is added by uses</li>\r
1500      *         <li>true - other cases</li>\r
1501      *         </ul>\r
1502      */\r
1503     private def boolean resolveContainerSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1504         ContainerSchemaNode containerNode) {\r
1505         if((containerNode !== null) && (typeBuilder !== null)) {\r
1506             val nodeName = containerNode.QName.localName;\r
1507 \r
1508             if(nodeName !== null && !containerNode.isAddedByUses()) {\r
1509                 val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);\r
1510 \r
1511                 val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);\r
1512                 constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);\r
1513 \r
1514                 return true;\r
1515             }\r
1516         }\r
1517         return false;\r
1518     }\r
1519 \r
1520     /**\r
1521      * Creates a getter method for a list node.\r
1522      *\r
1523      * Firstly generated type builder for list is created or found in\r
1524      * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
1525      * in the builder is created as concatenation of module package name and\r
1526      * names of all parent nodes. In the end the getter method for list is added\r
1527      * to <code>typeBuilder</code> and return type is set to list type builder.\r
1528      *\r
1529      * @param basePackageName\r
1530      *            string with the module package name\r
1531      * @param typeBuilder\r
1532      *            generated type builder to which is <code></code> added as\r
1533      *            getter method\r
1534      * @param listNode\r
1535      *            list schema node which is mapped as getter method to\r
1536      *            <code>typeBuilder</code>\r
1537      * @return boolean value\r
1538      *         <ul>\r
1539      *         <li>false - if <code>listNode</code>, <code>typeBuilder</code>,\r
1540      *         list node name equal null or <code>listNode</code> is added by\r
1541      *         uses</li>\r
1542      *         <li>true - other cases</li>\r
1543      *         </ul>\r
1544      */\r
1545     private def boolean resolveListSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1546         ListSchemaNode listNode) {\r
1547         if((listNode !== null) && (typeBuilder !== null)) {\r
1548             val listName = listNode.QName.localName;\r
1549 \r
1550             if(listName !== null && !listNode.isAddedByUses()) {\r
1551                 val packageName = packageNameForGeneratedType(basePackageName, listNode.path);\r
1552                 val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);\r
1553                 constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));\r
1554                 return true;\r
1555             }\r
1556         }\r
1557         return false;\r
1558     }\r
1559 \r
1560     /**\r
1561      * Instantiates generated type builder with <code>packageName</code> and\r
1562      * <code>schemaNode</code>.\r
1563      *\r
1564      * The new builder always implements\r
1565      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
1566      * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
1567      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
1568      * Augmentable}.<br />\r
1569      * If <code>schemaNode</code> is instance of\r
1570      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
1571      * DataNodeContainer} it can also implement nodes which are specified in\r
1572      * <i>uses</i>.\r
1573      *\r
1574      * @param packageName\r
1575      *            string with the name of the package to which\r
1576      *            <code>schemaNode</code> belongs.\r
1577      * @param schemaNode\r
1578      *            schema node for which is created generated type builder\r
1579      * @return generated type builder <code>schemaNode</code>\r
1580      */\r
1581     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {\r
1582         val builder = addRawInterfaceDefinition(packageName, schemaNode, "");\r
1583         builder.addImplementsType(DATA_OBJECT);\r
1584         if(!(schemaNode instanceof GroupingDefinition)) {\r
1585             builder.addImplementsType(augmentable(builder));\r
1586         }\r
1587 \r
1588         if(schemaNode instanceof DataNodeContainer) {\r
1589             addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, builder);\r
1590         }\r
1591 \r
1592         return builder;\r
1593     }\r
1594 \r
1595     /**\r
1596      * Wraps the calling of the same overloaded method.\r
1597      *\r
1598      * @param packageName\r
1599      *            string with the package name to which returning generated type\r
1600      *            builder belongs\r
1601      * @param schemaNode\r
1602      *            schema node which provide data about the schema node name\r
1603      * @return generated type builder for <code>schemaNode</code>\r
1604      */\r
1605     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {\r
1606         return addRawInterfaceDefinition(packageName, schemaNode, "");\r
1607     }\r
1608 \r
1609     /**\r
1610      * Returns reference to generated type builder for specified\r
1611      * <code>schemaNode</code> with <code>packageName</code>.\r
1612      *\r
1613      * Firstly the generated type builder is searched in\r
1614      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
1615      * found it is created and added to <code>genTypeBuilders</code>.\r
1616      *\r
1617      * @param packageName\r
1618      *            string with the package name to which returning generated type\r
1619      *            builder belongs\r
1620      * @param schemaNode\r
1621      *            schema node which provide data about the schema node name\r
1622      * @return generated type builder for <code>schemaNode</code>\r
1623      * @throws IllegalArgumentException\r
1624      *             <ul>\r
1625      *             <li>if <code>schemaNode</code> equals null</li>\r
1626      *             <li>if <code>packageName</code> equals null</li>\r
1627      *             <li>if Q name of schema node is null</li>\r
1628      *             <li>if schema node name is nul</li>\r
1629      *             </ul>\r
1630      *\r
1631      */\r
1632     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,\r
1633         String prefix) {\r
1634         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");\r
1635         checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");\r
1636         checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");\r
1637         val schemaNodeName = schemaNode.QName.localName;\r
1638         checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");\r
1639 \r
1640         var String genTypeName;\r
1641         if(prefix === null) {\r
1642             genTypeName = parseToClassName(schemaNodeName);\r
1643         } else {\r
1644             genTypeName = prefix + parseToClassName(schemaNodeName);\r
1645         }\r
1646 \r
1647         //FIXME: Validation of name conflict\r
1648         val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);\r
1649         yangToJavaMapping.put(schemaNode.path, newType);\r
1650         if(!genTypeBuilders.containsKey(packageName)) {\r
1651             val Map<String, GeneratedTypeBuilder> builders = new HashMap();\r
1652             builders.put(genTypeName, newType);\r
1653             genTypeBuilders.put(packageName, builders);\r
1654         } else {\r
1655             val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);\r
1656             if(!builders.containsKey(genTypeName)) {\r
1657                 builders.put(genTypeName, newType);\r
1658             }\r
1659         }\r
1660         return newType;\r
1661     }\r
1662 \r
1663     /**\r
1664      * Creates the name of the getter method from <code>methodName</code>.\r
1665      *\r
1666      * @param methodName\r
1667      *            string with the name of the getter method\r
1668      * @return string with the name of the getter method for\r
1669      *         <code>methodName</code> in JAVA method format\r
1670      */\r
1671     private def String getterMethodName(String methodName, Type returnType) {\r
1672         val method = new StringBuilder();\r
1673         if(BOOLEAN.equals(returnType)) {\r
1674             method.append("is");\r
1675         } else {\r
1676             method.append("get");\r
1677         }\r
1678         method.append(parseToClassName(methodName));\r
1679         return method.toString();\r
1680     }\r
1681 \r
1682     /**\r
1683      * Created a method signature builder as part of\r
1684      * <code>interfaceBuilder</code>.\r
1685      *\r
1686      * The method signature builder is created for the getter method of\r
1687      * <code>schemaNodeName</code>. Also <code>comment</code> and\r
1688      * <code>returnType</code> information are added to the builder.\r
1689      *\r
1690      * @param interfaceBuilder\r
1691      *            generated type builder for which the getter method should be\r
1692      *            created\r
1693      * @param schemaNodeName\r
1694      *            string with schema node name. The name will be the part of the\r
1695      *            getter method name.\r
1696      * @param comment\r
1697      *            string with comment for the getter method\r
1698      * @param returnType\r
1699      *            type which represents the return type of the getter method\r
1700      * @return method signature builder which represents the getter method of\r
1701      *         <code>interfaceBuilder</code>\r
1702      */\r
1703     private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,\r
1704         String comment, Type returnType) {\r
1705 \r
1706         val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));\r
1707 \r
1708         getMethod.setComment(comment);\r
1709         getMethod.setReturnType(returnType);\r
1710 \r
1711         return getMethod;\r
1712     }\r
1713 \r
1714     private def listToGenType(String basePackageName, ListSchemaNode list) {\r
1715         checkArgument(basePackageName !== null, "Package Name for Generated Type cannot be NULL.");\r
1716         checkArgument(list !== null, "List Schema Node cannot be NULL.");\r
1717 \r
1718         val packageName = packageNameForGeneratedType(basePackageName, list.path);\r
1719 \r
1720         // val typeBuilder =\r
1721         // resolveListTypeBuilder(packageName, list);\r
1722         val typeBuilder = addDefaultInterfaceDefinition(packageName, list);\r
1723 \r
1724         val List<String> listKeys = listKeys(list);\r
1725         val genTOBuilder = resolveListKeyTOBuilder(packageName, list);\r
1726 \r
1727         if(genTOBuilder !== null) {\r
1728             val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);\r
1729             val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);\r
1730             genTOBuilder.addImplementsType(identifierMarker);\r
1731             typeBuilder.addImplementsType(identifiableMarker);\r
1732         }\r
1733         val schemaNodes = list.childNodes;\r
1734 \r
1735         for (schemaNode : schemaNodes) {\r
1736             if(!schemaNode.isAugmenting()) {\r
1737                 addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);\r
1738             }\r
1739         }\r
1740         return typeBuildersToGenTypes(typeBuilder, genTOBuilder);\r
1741     }\r
1742 \r
1743     /**\r
1744      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
1745      * or to <code>genTOBuilder</code> as property.\r
1746      *\r
1747      * @param basePackageName\r
1748      *            string contains the module package name\r
1749      * @param schemaNode\r
1750      *            data schema node which should be added as getter method to\r
1751      *            <code>typeBuilder</code> or as a property to\r
1752      *            <code>genTOBuilder</code> if is part of the list key\r
1753      * @param typeBuilder\r
1754      *            generated type builder for the list schema node\r
1755      * @param genTOBuilder\r
1756      *            generated TO builder for the list keys\r
1757      * @param listKeys\r
1758      *            list of string which contains names of the list keys\r
1759      * @throws IllegalArgumentException\r
1760      *             <ul>\r
1761      *             <li>if <code>schemaNode</code> equals null</li>\r
1762      *             <li>if <code>typeBuilder</code> equals null</li>\r
1763      *             </ul>\r
1764      */\r
1765     private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,\r
1766         GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {\r
1767         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");\r
1768 \r
1769         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");\r
1770 \r
1771         if(schemaNode instanceof LeafSchemaNode) {\r
1772             val leaf = schemaNode as LeafSchemaNode;\r
1773             val leafName = leaf.QName.localName;\r
1774             if(!listKeys.contains(leafName)) {\r
1775                 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);\r
1776             } else {\r
1777                 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);\r
1778             }\r
1779         } else if(schemaNode instanceof LeafListSchemaNode) {\r
1780             resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);\r
1781         } else if(schemaNode instanceof ContainerSchemaNode) {\r
1782             resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);\r
1783         } else if(schemaNode instanceof ChoiceNode) {\r
1784             resolveChoiceSchemaNode(basePackageName,typeBuilder,schemaNode as ChoiceNode);\r
1785         } else if(schemaNode instanceof ListSchemaNode) {\r
1786             resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);\r
1787         }\r
1788     }\r
1789 \r
1790     private def typeBuildersToGenTypes(GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {\r
1791         val List<Type> genTypes = new ArrayList();\r
1792         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");\r
1793 \r
1794         if(genTOBuilder !== null) {\r
1795             val genTO = genTOBuilder.toInstance();\r
1796             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);\r
1797             genTypes.add(genTO);\r
1798         }\r
1799         genTypes.add(typeBuilder.toInstance());\r
1800         return genTypes;\r
1801     }\r
1802 \r
1803     /**\r
1804      * Selects the names of the list keys from <code>list</code> and returns\r
1805      * them as the list of the strings\r
1806      *\r
1807      * @param list\r
1808      *            of string with names of the list keys\r
1809      * @return list of string which represents names of the list keys. If the\r
1810      *         <code>list</code> contains no keys then the empty list is\r
1811      *         returned.\r
1812      */\r
1813     private def listKeys(ListSchemaNode list) {\r
1814         val List<String> listKeys = new ArrayList();\r
1815 \r
1816         if(list.keyDefinition !== null) {\r
1817             val keyDefinitions = list.keyDefinition;\r
1818             for (keyDefinition : keyDefinitions) {\r
1819                 listKeys.add(keyDefinition.localName);\r
1820             }\r
1821         }\r
1822         return listKeys;\r
1823     }\r
1824 \r
1825     /**\r
1826      * Generates for the <code>list</code> which contains any list keys special\r
1827      * generated TO builder.\r
1828      *\r
1829      * @param packageName\r
1830      *            string with package name to which the list belongs\r
1831      * @param list\r
1832      *            list schema node which is source of data about the list name\r
1833      * @return generated TO builder which represents the keys of the\r
1834      *         <code>list</code> or null if <code>list</code> is null or list of\r
1835      *         key definitions is null or empty.\r
1836      */\r
1837     private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {\r
1838         var GeneratedTOBuilder genTOBuilder = null;\r
1839         if((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {\r
1840             if(list !== null) {\r
1841                 val listName = list.QName.localName + "Key";\r
1842                 val String genTOName = parseToClassName(listName);\r
1843                 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);\r
1844             }\r
1845         }\r
1846         return genTOBuilder;\r
1847 \r
1848     }\r
1849 \r
1850     /**\r
1851      * Builds generated TO builders for <code>typeDef</code> of type\r
1852      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
1853      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
1854      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
1855      * enclosing transfer object.\r
1856      *\r
1857      * If more then one generated TO builder is created for enclosing then all\r
1858      * of the generated TO builders are added to <code>typeBuilder</code> as\r
1859      * enclosing transfer objects.\r
1860      *\r
1861      * @param typeDef\r
1862      *            type definition which can be of type <code>UnionType</code> or\r
1863      *            <code>BitsTypeDefinition</code>\r
1864      * @param typeBuilder\r
1865      *            generated type builder to which is added generated TO created\r
1866      *            from <code>typeDef</code>\r
1867      * @param leafName\r
1868      *            string with name for generated TO builder\r
1869      * @return generated TO builder for <code>typeDef</code>\r
1870      */\r
1871     private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,\r
1872         String leafName, LeafSchemaNode leaf, Module parentModule) {\r
1873         val classNameFromLeaf = parseToClassName(leafName);\r
1874         val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();\r
1875         val packageName = typeBuilder.fullyQualifiedName;\r
1876         if(typeDef instanceof UnionTypeDefinition) {\r
1877             genTOBuilders.addAll(\r
1878                 (typeProvider as TypeProviderImpl).\r
1879                     provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),\r
1880                         classNameFromLeaf, leaf));\r
1881         } else if(typeDef instanceof BitsTypeDefinition) {\r
1882             genTOBuilders.add(\r
1883                 ((typeProvider as TypeProviderImpl) ).\r
1884                     provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));\r
1885         }\r
1886         if(genTOBuilders !== null && !genTOBuilders.isEmpty()) {\r
1887             for (genTOBuilder : genTOBuilders) {\r
1888                 typeBuilder.addEnclosingTransferObject(genTOBuilder);\r
1889             }\r
1890             return genTOBuilders.get(0);\r
1891         }\r
1892         return null;\r
1893 \r
1894     }\r
1895 \r
1896     /**\r
1897      * Adds the implemented types to type builder.\r
1898      *\r
1899      * The method passes through the list of <i>uses</i> in\r
1900      * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding\r
1901      * generated type from {@link BindingGeneratorImpl#allGroupings\r
1902      * allGroupings} which is added as <i>implements type</i> to\r
1903      * <code>builder</code>\r
1904      *\r
1905      * @param dataNodeContainer\r
1906      *            element which contains the list of used YANG groupings\r
1907      * @param builder\r
1908      *            builder to which are added implemented types according to\r
1909      *            <code>dataNodeContainer</code>\r
1910      * @return generated type builder with all implemented types\r
1911      */\r
1912     private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {\r
1913         for (usesNode : dataNodeContainer.uses) {\r
1914             if(usesNode.groupingPath !== null) {\r
1915                 val genType = allGroupings.get(usesNode.groupingPath);\r
1916                 if(genType === null) {\r
1917                     throw new IllegalStateException(\r
1918                         "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);\r
1919                 }\r
1920                 builder.addImplementsType(genType);\r
1921             }\r
1922         }\r
1923         return builder;\r
1924     }\r
1925 }\r