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

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