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

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