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