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);
 577         genCtx.get(module).addIdentityType(newType)
 578     }
 579
 580     /**\r
 581      * Converts all <b>groupings</b> of the module to the list of\r
 582      * <code>Type</code> objects. Firstly are groupings sorted according mutual\r
 583      * dependencies. At least dependend (indepedent) groupings are in the list\r
 584      * saved at first positions. For every grouping the record is added to map\r
 585      * {@link BindingGeneratorImpl#allGroupings allGroupings}\r
 586      *\r
 587      * @param module\r
 588      *            current module\r
 589      * @param collection of groupings from which types will be generated\r
 590      *\r
 591      */
 592     private def void groupingsToGenTypes(Module module, Collection<GroupingDefinition> groupings) {
 593         val basePackageName = moduleNamespaceToPackageName(module);
 594         val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
 595             groupings);
 596         for (grouping : groupingsSortedByDependencies) {
 597             groupingToGenType(basePackageName, grouping, module);
 598         }
 599     }
 600
 601     /**\r
 602      * Converts individual grouping to GeneratedType. Firstly generated type\r
 603      * builder is created and every child node of grouping is resolved to the\r
 604      * method.\r
 605      *\r
 606      * @param basePackageName\r
 607      *            string contains the module package name\r
 608      * @param grouping\r
 609      *            GroupingDefinition which contains data about grouping\r
 610      * @param module current module\r
 611      * @return GeneratedType which is generated from grouping (object of type\r
 612      *         <code>GroupingDefinition</code>)\r
 613      */
 614     private def void groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
 615         val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
 616         val genType = addDefaultInterfaceDefinition(packageName, grouping);
 617         genCtx.get(module).addGroupingType(grouping.path, genType)
 618         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.childNodes);
 619         groupingsToGenTypes(module, grouping.groupings);
 620         processUsesAugments(grouping, module);
 621     }
 622
 623     /**\r
 624      * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base\r
 625      * type of <code>typeDefinition</code> is of the type ExtendedType then this\r
 626      * method is recursivelly called with this base type.\r
 627      *\r
 628      * @param typeDefinition\r
 629      *            TypeDefinition in which should be EnumTypeDefinition found as\r
 630      *            base type\r
 631      * @return EnumTypeDefinition if it is found inside\r
 632      *         <code>typeDefinition</code> or <code>null</code> in other case\r
 633      */
 634     private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
 635         if (typeDefinition !== null) {
 636             if (typeDefinition.baseType instanceof EnumTypeDefinition) {
 637                 return typeDefinition.baseType as EnumTypeDefinition;
 638             } else if (typeDefinition.baseType instanceof ExtendedType) {
 639                 return enumTypeDefFromExtendedType(typeDefinition.baseType);
 640             }
 641         }
 642         return null;
 643     }
 644
 645     /**\r
 646      * Adds enumeration builder created from <code>enumTypeDef</code> to\r
 647      * <code>typeBuilder</code>.\r
 648      *\r
 649      * Each <code>enumTypeDef</code> item is added to builder with its name and\r
 650      * value.\r
 651      *\r
 652      * @param enumTypeDef\r
 653      *            EnumTypeDefinition contains enum data\r
 654      * @param enumName\r
 655      *            string contains name which will be assigned to enumeration\r
 656      *            builder\r
 657      * @param typeBuilder\r
 658      *            GeneratedTypeBuilder to which will be enum builder assigned\r
 659      * @return enumeration builder which contais data from\r
 660      *         <code>enumTypeDef</code>\r
 661      */
 662     private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, String enumName,
 663         GeneratedTypeBuilder typeBuilder) {
 664         if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
 665             (enumTypeDef.QName.localName !== null)) {
 666             val enumerationName = parseToClassName(enumName);
 667             val enumBuilder = typeBuilder.addEnumeration(enumerationName);
 668             enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
 669             return enumBuilder;
 670         }
 671         return null;
 672     }
 673
 674     /**\r
 675      * Generates type builder for <code>module</code>.\r
 676      *\r
 677      * @param module\r
 678      *            Module which is source of package name for generated type\r
 679      *            builder\r
 680      * @param postfix\r
 681      *            string which is added to the module class name representation\r
 682      *            as suffix\r
 683      * @return instance of GeneratedTypeBuilder which represents\r
 684      *         <code>module</code>.\r
 685      * @throws IllegalArgumentException\r
 686      *             if <code>module</code> equals null\r
 687      */
 688     private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
 689         checkArgument(module !== null, "Module reference cannot be NULL.");
 690         val packageName = moduleNamespaceToPackageName(module);
 691         val moduleName = parseToClassName(module.name) + postfix;
 692         return new GeneratedTypeBuilderImpl(packageName, moduleName);
 693     }
 694
 695     /**\r
 696      * Converts <code>augSchema</code> to list of <code>Type</code> which\r
 697      * contains generated type for augmentation. In addition there are also\r
 698      * generated types for all containers, list and choices which are child of\r
 699      * <code>augSchema</code> node or a generated types for cases are added if\r
 700      * augmented node is choice.\r
 701      *\r
 702      * @param augmentPackageName\r
 703      *            string with the name of the package to which the augmentation\r
 704      *            belongs\r
 705      * @param augSchema\r
 706      *            AugmentationSchema which is contains data about agumentation\r
 707      *            (target path, childs...)\r
 708      * @param module current module\r
 709      * @param parentUsesNode parent uses node of this augment (can be null if this augment is not defined under uses statement)\r
 710      * @throws IllegalArgumentException\r
 711      *             <ul>\r
 712      *             <li>if <code>augmentPackageName</code> equals null</li>\r
 713      *             <li>if <code>augSchema</code> equals null</li>\r
 714      *             <li>if target path of <code>augSchema</code> equals null</li>\r
 715      *             </ul>\r
 716      */
 717     private def void augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
 718         UsesNode parentUsesNode) {
 719         checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
 720         checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
 721         checkState(augSchema.targetPath !== null,
 722             "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 723
 724         processUsesAugments(augSchema, module);
 725
 726         // EVERY augmented interface will extends Augmentation<T> interface\r
 727         // and DataObject interface\r
 728         val targetPath = augSchema.targetPath;
 729         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
 730         if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
 731             if (parentUsesNode == null) {
 732                 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
 733             } else {
 734                 targetSchemaNode = findOriginalTargetFromGrouping(targetSchemaNode.QName.localName, parentUsesNode);
 735             }
 736             if (targetSchemaNode == null) {
 737                 throw new NullPointerException(
 738                     "Failed to find target node from grouping for augmentation " + augSchema + " in module " +
 739                         module.name);
 740             }
 741         }
 742
 743         if (targetSchemaNode !== null) {
 744             var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
 745             if (targetTypeBuilder === null) {
 746                 targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
 747             }
 748             if (targetTypeBuilder === null) {
 749                 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 750             }
 751             if (!(targetSchemaNode instanceof ChoiceNode)) {
 752                 var packageName = augmentPackageName;
 753                 if (parentUsesNode != null) {
 754                     packageName = packageNameForGeneratedType(augmentPackageName, augSchema.targetPath);
 755                 }
 756                 val augTypeBuilder = addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
 757                     targetTypeBuilder.toInstance, augSchema);
 758                 genCtx.get(module).addAugmentType(augTypeBuilder)\r
 759                 genCtx.get(module).addTypeToAugmentation(augTypeBuilder,augSchema);
 760             } else {
 761                 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
 762                     targetSchemaNode as ChoiceNode, augSchema.childNodes);
 763             }
 764         }
 765     }
 766
 767     /**\r
 768      * Utility method which search for original node defined in grouping.\r
 769      */
 770     private def DataSchemaNode findOriginal(DataSchemaNode node) {
 771         var DataSchemaNode result = findCorrectTargetFromGrouping(node);
 772         if (result == null) {
 773             result = findCorrectTargetFromAugment(node);
 774             if (result != null) {
 775                 if (result.addedByUses) {
 776                     result = findOriginal(result);
 777                 }
 778             }
 779         }
 780         return result;
 781     }
 782
 783     private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
 784         if (!node.augmenting) {
 785             return null;
 786         }
 787
 788         var String currentName = node.QName.localName;
 789         var tmpPath = new ArrayList<String>();
 790         var YangNode parent = node;
 791         var AugmentationSchema augment = null;
 792         do {
 793             parent = (parent as DataSchemaNode).parent;
 794             if (parent instanceof AugmentationTarget) {
 795                 tmpPath.add(currentName);
 796                 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
 797                 if (augment == null) {
 798                     currentName = (parent as DataSchemaNode).QName.localName;
 799                 }
 800             }
 801         } while ((parent as DataSchemaNode).augmenting && augment == null);
 802
 803         if (augment == null) {
 804             return null;
 805         } else {
 806             Collections.reverse(tmpPath);
 807             var Object actualParent = augment;
 808             var DataSchemaNode result = null;
 809             for (name : tmpPath) {
 810                 if (actualParent instanceof DataNodeContainer) {
 811                     result = (actualParent as DataNodeContainer).getDataChildByName(name);
 812                     actualParent = (actualParent as DataNodeContainer).getDataChildByName(name);
 813                 } else {
 814                     if (actualParent instanceof ChoiceNode) {
 815                         result = (actualParent as ChoiceNode).getCaseNodeByName(name);
 816                         actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name);
 817                     }
 818                 }
 819             }
 820
 821             if (result.addedByUses) {
 822                 result = findCorrectTargetFromGrouping(result);
 823             }
 824
 825             return result;
 826         }
 827     }
 828
 829     private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, String name) {
 830         for (augment : augments) {
 831             if (augment.getDataChildByName(name) != null) {
 832                 return augment;
 833             }
 834         }
 835         return null;
 836     }
 837
 838     private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {
 839         if (node.path.path.size == 1) {
 840
 841             // uses is under module statement\r
 842             val Module m = findParentModule(schemaContext, node);
 843             var DataSchemaNode result = null;
 844             for (u : m.uses) {
 845                 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
 846                 if (!(targetGrouping instanceof GroupingDefinition)) {
 847                     throw new IllegalArgumentException("Failed to generate code for augment in " + u);
 848                 }
 849                 var gr = targetGrouping as GroupingDefinition;
 850                 result = gr.getDataChildByName(node.QName.localName);
 851             }
 852             if (result == null) {
 853                 throw new IllegalArgumentException("Failed to generate code for augment");
 854             }
 855             return result;
 856         } else {
 857             var DataSchemaNode result = null;
 858             var String currentName = node.QName.localName;
 859             var tmpPath = new ArrayList<String>();
 860             var YangNode parent = node.parent;
 861             do {
 862                 tmpPath.add(currentName);
 863                 val dataNodeParent = parent as DataNodeContainer;
 864                 for (u : dataNodeParent.uses) {
 865                     if (result == null) {\r
 866                         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
 867                         if (!(targetGrouping instanceof GroupingDefinition)) {
 868                             throw new IllegalArgumentException("Failed to generate code for augment in " + u);
 869                         }
 870                         var gr = targetGrouping as GroupingDefinition;
 871                         result = gr.getDataChildByName(currentName);\r
 872                     }
 873                 }
 874                 if (result == null) {
 875                     currentName = (parent as SchemaNode).QName.localName;
 876                     if (parent instanceof DataSchemaNode) {
 877                         parent = (parent as DataSchemaNode).parent;
 878                     } else {
 879                         parent = (parent as DataNodeContainer).parent;
 880                     }
 881                 }
 882             } while (result == null && !(parent instanceof Module));
 883
 884             if (result != null) {
 885                 if (tmpPath.size == 1) {
 886                     return result;
 887                 } else {
 888                     var DataSchemaNode newParent = result;
 889                     Collections.reverse(tmpPath);
 890                     tmpPath.remove(0);
 891                     for (name : tmpPath) {
 892                         newParent = (newParent as DataNodeContainer).getDataChildByName(name);
 893                     }
 894                     return newParent;
 895                 }
 896             }
 897
 898             return result;
 899         }
 900     }
 901
 902     /**\r
 903      * Convenient method to find node added by uses statement.\r
 904      */
 905     private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
 906         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
 907         if (!(targetGrouping instanceof GroupingDefinition)) {
 908             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
 909         }
 910
 911         var grouping = targetGrouping as GroupingDefinition;
 912         var result = grouping.getDataChildByName(targetSchemaNodeName);
 913         if (result == null) {
 914             return null;
 915         }
 916         var boolean fromUses = result.addedByUses;
 917
 918         var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
 919         while (fromUses) {
 920             if (groupingUses.hasNext()) {
 921                 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
 922                 result = grouping.getDataChildByName(targetSchemaNodeName);
 923                 fromUses = result.addedByUses;
 924             } else {
 925                 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
 926             }
 927         }
 928
 929         return result;
 930     }
 931
 932     /**\r
 933      * Returns a generated type builder for an augmentation.\r
 934      *\r
 935      * The name of the type builder is equal to the name of augmented node with\r
 936      * serial number as suffix.\r
 937      *\r
 938      * @param module current module\r
 939      * @param augmentPackageName\r
 940      *            string with contains the package name to which the augment\r
 941      *            belongs\r
 942      * @param basePackageName\r
 943      *            string with the package name to which the augmented node\r
 944      *            belongs\r
 945      * @param targetTypeRef\r
 946      *            target type\r
 947      * @param augSchema\r
 948      *            augmentation schema which contains data about the child nodes\r
 949      *            and uses of augment\r
 950      * @return generated type builder for augment\r
 951      */
 952     private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
 953         String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
 954         var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
 955         if (augmentBuilders === null) {
 956             augmentBuilders = new HashMap();
 957             genTypeBuilders.put(augmentPackageName, augmentBuilders);
 958         }
 959         val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
 960
 961         val augTypeName = if (augIdentifier !== null) {
 962                 parseToClassName(augIdentifier)
 963             } else {
 964                 augGenTypeName(augmentBuilders, targetTypeRef.name);
 965             }
 966
 967         val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
 968
 969         augTypeBuilder.addImplementsType(DATA_OBJECT);
 970         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 971         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
 972
 973         augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
 974         augmentBuilders.put(augTypeName, augTypeBuilder);
 975         return augTypeBuilder;
 976     }
 977
 978     /**\r
 979      *\r
 980      * @param unknownSchemaNodes\r
 981      * @return nodeParameter of UnknownSchemaNode\r
 982      */
 983     private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
 984         for (unknownSchemaNode : unknownSchemaNodes) {
 985             val nodeType = unknownSchemaNode.nodeType;
 986             if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
 987                 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
 988                 return unknownSchemaNode.nodeParameter;
 989             }
 990         }
 991         return null;
 992     }
 993
 994     /**\r
 995      * Returns first unique name for the augment generated type builder. The\r
 996      * generated type builder name for augment consists from name of augmented\r
 997      * node and serial number of its augmentation.\r
 998      *\r
 999      * @param builders\r
1000      *            map of builders which were created in the package to which the\r
1001      *            augmentation belongs\r
1002      * @param genTypeName\r
1003      *            string with name of augmented node\r
1004      * @return string with unique name for augmentation builder\r
1005      */
1006     private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
1007         var index = 1;
1008         while ((builders !== null) && builders.containsKey(genTypeName + index)) {
1009             index = index + 1;
1010         }
1011         return genTypeName + index;
1012     }
1013
1014     /**\r
1015      * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
1016      * node for which <code>typeBuilder</code> was created.\r
1017      *\r
1018      * The subnodes aren't mapped to the methods if they are part of grouping or\r
1019      * augment (in this case are already part of them).\r
1020      *\r
1021      * @param module current module\r
1022      * @param basePackageName\r
1023      *            string contains the module package name\r
1024      * @param parent\r
1025      *            generated type builder which represents any node. The subnodes\r
1026      *            of this node are added to the <code>typeBuilder</code> as\r
1027      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1028      *            container, choice.\r
1029      * @param childOf parent type\r
1030      * @param schemaNodes\r
1031      *            set of data schema nodes which are the children of the node\r
1032      *            for which <code>typeBuilder</code> was created\r
1033      * @return generated type builder which is the same builder as input\r
1034      *         parameter. The getter methods (representing child nodes) could be\r
1035      *         added to it.\r
1036      */
1037     private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
1038         GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1039         if ((schemaNodes !== null) && (parent !== null)) {
1040             for (schemaNode : schemaNodes) {
1041                 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
1042                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1043                 }
1044             }
1045         }
1046         return parent;
1047     }
1048
1049     /**\r
1050      * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
1051      * node for which <code>typeBuilder</code> was created.\r
1052      *\r
1053      * @param module current module\r
1054      * @param basePackageName\r
1055      *            string contains the module package name\r
1056      * @param typeBuilder\r
1057      *            generated type builder which represents any node. The subnodes\r
1058      *            of this node are added to the <code>typeBuilder</code> as\r
1059      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1060      *            container, choice.\r
1061      * @param childOf parent type\r
1062      * @param schemaNodes\r
1063      *            set of data schema nodes which are the children of the node\r
1064      *            for which <code>typeBuilder</code> was created\r
1065      * @return generated type builder which is the same object as the input\r
1066      *         parameter <code>typeBuilder</code>. The getter method could be\r
1067      *         added to it.\r
1068      */
1069     private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1070         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1071         if ((schemaNodes !== null) && (typeBuilder !== null)) {
1072             for (schemaNode : schemaNodes) {
1073                 if (!schemaNode.isAugmenting()) {
1074                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1075                 }
1076             }
1077         }
1078         return typeBuilder;
1079     }
1080
1081     /**\r
1082      * Adds to <code>typeBuilder</code> a method which is derived from\r
1083      * <code>schemaNode</code>.\r
1084      *\r
1085      * @param basePackageName\r
1086      *            string with the module package name\r
1087      * @param node\r
1088      *            data schema node which is added to <code>typeBuilder</code> as\r
1089      *            a method\r
1090      * @param typeBuilder\r
1091      *            generated type builder to which is <code>schemaNode</code>\r
1092      *            added as a method.\r
1093      * @param childOf parent type\r
1094      * @param module current module\r
1095      */
1096     private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1097         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1098         if (node !== null && typeBuilder !== null) {
1099             switch (node) {
1100                 case node instanceof LeafSchemaNode:
1101                     resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1102                 case node instanceof LeafListSchemaNode:
1103                     resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1104                 case node instanceof ContainerSchemaNode:
1105                     containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1106                 case node instanceof ListSchemaNode:
1107                     listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1108                 case node instanceof ChoiceNode:
1109                     choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1110             }
1111         }
1112     }
1113
1114     /**\r
1115      * Converts <code>choiceNode</code> to the list of generated types for\r
1116      * choice and its cases.\r
1117      *\r
1118      * The package names for choice and for its cases are created as\r
1119      * concatenation of the module package (<code>basePackageName</code>) and\r
1120      * names of all parents node.\r
1121      *\r
1122      * @param module current module\r
1123      * @param basePackageName\r
1124      *            string with the module package name\r
1125      * @param parent parent type\r
1126      * @param childOf concrete parent for case child nodes\r
1127      * @param choiceNode\r
1128      *            choice node which is mapped to generated type. Also child\r
1129      *            nodes - cases are mapped to generated types.\r
1130      * @throws IllegalArgumentException\r
1131      *             <ul>\r
1132      *             <li>if <code>basePackageName</code> equals null</li>\r
1133      *             <li>if <code>choiceNode</code> equals null</li>\r
1134      *             </ul>\r
1135      *\r
1136      */
1137     private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1138         ChoiceNode choiceNode) {
1139         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1140         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1141
1142         val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1143         val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1144         constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1145         choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1146         genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1147         generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1148     }
1149
1150     /**\r
1151      * Converts <code>caseNodes</code> set to list of corresponding generated\r
1152      * types.\r
1153      *\r
1154      * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
1155      * created generated type builder. The package names for the builder is\r
1156      * created as concatenation of the module package (\r
1157      * <code>basePackageName</code>) and names of all parents nodes of the\r
1158      * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
1159      * between every case builder and <i>choice</i> type\r
1160      *\r
1161      * @param basePackageName\r
1162      *            string with the module package name\r
1163      * @param refChoiceType\r
1164      *            type which represents superior <i>case</i>\r
1165      * @param caseNodes\r
1166      *            set of choice case nodes which are mapped to generated types\r
1167      * @return list of generated types for <code>caseNodes</code>.\r
1168      * @throws IllegalArgumentException\r
1169      *             <ul>\r
1170      *             <li>if <code>basePackageName</code> equals null</li>\r
1171      *             <li>if <code>refChoiceType</code> equals null</li>\r
1172      *             <li>if <code>caseNodes</code> equals null</li>\r
1173      *             </ul>\r
1174      *             *\r
1175      */
1176     private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1177         GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1178         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1179         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1180         checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1181
1182         val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1183         if (caseNodes == null) {
1184             return
1185         }
1186
1187         for (caseNode : caseNodes) {
1188             if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1189                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1190                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1191                 caseTypeBuilder.addImplementsType(refChoiceType)
1192                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1193                 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1194                 if (caseChildNodes !== null) {
1195                     val parentNode = choiceNode.parent
1196                     var SchemaNode parent
1197                     if (parentNode instanceof AugmentationSchema) {
1198                         val augSchema = parentNode as AugmentationSchema;
1199                         val targetPath = augSchema.targetPath;
1200                         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1201                         if (targetSchemaNode instanceof DataSchemaNode &&
1202                             (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1203                             targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
1204                             if (targetSchemaNode == null) {
1205                                 throw new NullPointerException(
1206                                     "Failed to find target node from grouping for augmentation " + augSchema +
1207                                         " in module " + module.name);
1208                             }
1209                         }
1210                         parent = targetSchemaNode
1211                     } else {
1212                         parent = choiceNode.parent as SchemaNode
1213                     }
1214                     var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1215                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1216                 }
1217             }
1218
1219             processUsesAugments(caseNode, module);
1220         }
1221     }
1222
1223     /**\r
1224      * Generates list of generated types for all the cases of a choice which are\r
1225      * added to the choice through the augment.\r
1226      *\r
1227      *\r
1228      * @param basePackageName\r
1229      *            string contains name of package to which augment belongs. If\r
1230      *            an augmented choice is from an other package (pcg1) than an\r
1231      *            augmenting choice (pcg2) then case's of the augmenting choice\r
1232      *            will belong to pcg2.\r
1233      * @param refChoiceType\r
1234      *            Type which represents the choice to which case belongs. Every\r
1235      *            case has to contain its choice in extend part.\r
1236      * @param caseNodes\r
1237      *            set of choice case nodes for which is checked if are/aren't\r
1238      *            added to choice through augmentation\r
1239      * @return list of generated types which represents augmented cases of\r
1240      *         choice <code>refChoiceType</code>\r
1241      * @throws IllegalArgumentException\r
1242      *             <ul>\r
1243      *             <li>if <code>basePackageName</code> equals null</li>\r
1244      *             <li>if <code>refChoiceType</code> equals null</li>\r
1245      *             <li>if <code>caseNodes</code> equals null</li>\r
1246      *             </ul>\r
1247      */
1248     private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1249         ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1250         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1251         checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1252         checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1253
1254         for (caseNode : augmentedNodes) {
1255             if (caseNode !== null) {
1256                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1257                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1258                 caseTypeBuilder.addImplementsType(targetType);
1259
1260                 val SchemaNode parent = targetNode.parent as SchemaNode;
1261                 var GeneratedTypeBuilder childOfType = null;
1262                 if (parent instanceof Module) {
1263                     childOfType = genCtx.get(parent as Module).moduleNode
1264                 } else if (parent instanceof ChoiceCaseNode) {
1265                     childOfType = findCaseByPath(parent.path)
1266                 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1267                     childOfType = findChildNodeByPath(parent.path)
1268                 } else if (parent instanceof GroupingDefinition) {
1269                     childOfType = findGroupingByPath(parent.path);
1270                 }
1271
1272                 if (childOfType == null) {
1273                     throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1274                 }
1275
1276                 if (caseNode instanceof DataNodeContainer) {
1277                     val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
1278                     val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
1279                     if (childNodes !== null) {
1280                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1281                     }
1282                 } else {
1283                     val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1284                     val Set<DataSchemaNode> childNodes = node.childNodes;
1285                     if (childNodes !== null) {
1286                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1287                     }
1288                 }
1289
1290                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1291             }
1292         }
1293
1294     }
1295
1296     /**\r
1297      * Converts <code>leaf</code> to the getter method which is added to\r
1298      * <code>typeBuilder</code>.\r
1299      *\r
1300      * @param typeBuilder\r
1301      *            generated type builder to which is added getter method as\r
1302      *            <code>leaf</code> mapping\r
1303      * @param leaf\r
1304      *            leaf schema node which is mapped as getter method which is\r
1305      *            added to <code>typeBuilder</code>\r
1306      * @return boolean value\r
1307      *         <ul>\r
1308      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
1309      *         null</li>\r
1310      *         <li>true - in other cases</li>\r
1311      *         </ul>\r
1312      */
1313     private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1314         if ((leaf !== null) && (typeBuilder !== null)) {
1315             val leafName = leaf.QName.localName;
1316             var String leafDesc = leaf.description;
1317             if (leafDesc === null) {
1318                 leafDesc = "";
1319             }
1320
1321             val parentModule = findParentModule(schemaContext, leaf);
1322             if (leafName !== null && !leaf.isAddedByUses()) {
1323                 val TypeDefinition<?> typeDef = leaf.type;
1324
1325                 var Type returnType = null;
1326                 if (typeDef instanceof EnumTypeDefinition) {
1327                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1328                     val enumTypeDef = typeDef as EnumTypeDefinition;
1329                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);
1330
1331                     if (enumBuilder !== null) {
1332                         returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1333                     }
1334                     (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1335                 } else if (typeDef instanceof UnionType) {
1336                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
1337                     if (genTOBuilder !== null) {
1338                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1339                     }
1340                 } else if (typeDef instanceof BitsTypeDefinition) {
1341                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
1342                     if (genTOBuilder !== null) {
1343                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1344                     }
1345                 } else {\r
1346                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);\r
1347                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1348                 }
1349                 if (returnType !== null) {
1350                     val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1351                     processContextRefExtension(leaf, getter, parentModule);
1352                     return true;
1353                 }
1354             }
1355         }
1356         return false;
1357     }
1358
1359     private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1360         for (node : leaf.unknownSchemaNodes) {
1361             val nodeType = node.nodeType;
1362             if ("context-reference".equals(nodeType.localName)) {
1363                 val nodeParam = node.nodeParameter;
1364                 var IdentitySchemaNode identity = null;
1365                 var String basePackageName = null;
1366                 val String[] splittedElement = nodeParam.split(":");
1367                 if (splittedElement.length == 1) {
1368                     identity = findIdentityByName(module.identities, splittedElement.get(0));
1369                     basePackageName = moduleNamespaceToPackageName(module);
1370                 } else if (splittedElement.length == 2) {
1371                     var prefix = splittedElement.get(0);
1372                     val Module dependentModule = findModuleFromImports(module.imports, prefix)
1373                     if (dependentModule == null) {
1374                         throw new IllegalArgumentException(
1375                             "Failed to process context-reference: unknown prefix " + prefix);
1376                     }
1377                     identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1378                     basePackageName = moduleNamespaceToPackageName(dependentModule);
1379                 } else {
1380                     throw new IllegalArgumentException(
1381                         "Failed to process context-reference: unknown identity " + nodeParam);
1382                 }
1383                 if (identity == null) {
1384                     throw new IllegalArgumentException(
1385                         "Failed to process context-reference: unknown identity " + nodeParam);
1386                 }
1387
1388                 val Class<RoutingContext> clazz = typeof(RoutingContext);
1389                 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1390                 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1391                 val genTypeName = parseToClassName(identity.QName.localName);
1392                 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1393             }
1394         }
1395     }
1396
1397     private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1398         for (id : identities) {
1399             if (id.QName.localName.equals(name)) {
1400                 return id;
1401             }
1402         }
1403         return null;
1404     }
1405
1406     private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1407         for (imp : imports) {
1408             if (imp.prefix.equals(prefix)) {
1409                 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1410             }
1411         }
1412         return null;
1413     }
1414
1415     /**\r
1416      * Converts <code>leaf</code> schema node to property of generated TO\r
1417      * builder.\r
1418      *\r
1419      * @param toBuilder\r
1420      *            generated TO builder to which is <code>leaf</code> added as\r
1421      *            property\r
1422      * @param leaf\r
1423      *            leaf schema node which is added to <code>toBuilder</code> as\r
1424      *            property\r
1425      * @param isReadOnly\r
1426      *            boolean value which says if leaf property is|isn't read only\r
1427      * @return boolean value\r
1428      *         <ul>\r
1429      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
1430      *         name equals null or if leaf is added by <i>uses</i>.</li>\r
1431      *         <li>true - other cases</li>\r
1432      *         </ul>\r
1433      */
1434     private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1435         boolean isReadOnly) {
1436         if ((leaf !== null) && (toBuilder !== null)) {
1437             val leafName = leaf.QName.localName;
1438             var String leafDesc = leaf.description;
1439             if (leafDesc === null) {
1440                 leafDesc = "";
1441             }
1442
1443             if (leafName !== null) {
1444                 val TypeDefinition<?> typeDef = leaf.type;
1445
1446                 // TODO: properly resolve enum types\r
1447                 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1448                 if (returnType !== null) {
1449                     val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1450                     propBuilder.setReadOnly(isReadOnly);
1451                     propBuilder.setReturnType(returnType);
1452                     propBuilder.setComment(leafDesc);
1453                     toBuilder.addEqualsIdentity(propBuilder);
1454                     toBuilder.addHashIdentity(propBuilder);
1455                     toBuilder.addToStringProperty(propBuilder);
1456                     return true;
1457                 }
1458             }
1459         }
1460         return false;
1461     }
1462
1463     /**\r
1464      * Converts <code>node</code> leaf list schema node to getter method of\r
1465      * <code>typeBuilder</code>.\r
1466      *\r
1467      * @param typeBuilder\r
1468      *            generated type builder to which is <code>node</code> added as\r
1469      *            getter method\r
1470      * @param node\r
1471      *            leaf list schema node which is added to\r
1472      *            <code>typeBuilder</code> as getter method\r
1473      * @return boolean value\r
1474      *         <ul>\r
1475      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
1476      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
1477      *         <li>false - other cases</li>\r
1478      *         </ul>\r
1479      */
1480     private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1481         if ((node !== null) && (typeBuilder !== null)) {
1482             val nodeName = node.QName.localName;
1483             var String nodeDesc = node.description;
1484             if (nodeDesc === null) {
1485                 nodeDesc = "";
1486             }
1487             if (nodeName !== null && !node.isAddedByUses()) {
1488                 val TypeDefinition<?> type = node.type;
1489                 val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));
1490                 constructGetter(typeBuilder, nodeName, nodeDesc, listType);
1491                 return true;
1492             }
1493         }
1494         return false;
1495     }
1496
1497     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1498         return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1499     }
1500
1501     /**\r
1502      * Instantiates generated type builder with <code>packageName</code> and\r
1503      * <code>schemaNode</code>.\r
1504      *\r
1505      * The new builder always implements\r
1506      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
1507      * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
1508      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
1509      * Augmentable}.<br />\r
1510      * If <code>schemaNode</code> is instance of\r
1511      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
1512      * DataNodeContainer} it can also implement nodes which are specified in\r
1513      * <i>uses</i>.\r
1514      *\r
1515      * @param packageName\r
1516      *            string with the name of the package to which\r
1517      *            <code>schemaNode</code> belongs.\r
1518      * @param schemaNode\r
1519      *            schema node for which is created generated type builder\r
1520      * @param parent parent type (can be null)\r
1521      * @return generated type builder <code>schemaNode</code>\r
1522      */
1523     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1524         Type parent) {
1525         val it = addRawInterfaceDefinition(packageName, schemaNode, "");\r
1526         val qname = schemaNode.QName;
1527         addConstant(QName.typeForClass,"QNAME",'''\r
1528             org.opendaylight.yangtools.yang.common.QName.create("«qname.namespace»","«qname.formattedRevision»","«qname.localName»")\r
1529         ''');\r
1530         if (parent === null) {
1531             addImplementsType(DATA_OBJECT);
1532         } else {
1533             addImplementsType(BindingTypes.childOf(parent));
1534         }
1535         if (!(schemaNode instanceof GroupingDefinition)) {
1536             addImplementsType(augmentable(it));
1537         }
1538
1539         if (schemaNode instanceof DataNodeContainer) {
1540             addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1541         }
1542
1543         return it;
1544     }
1545
1546     /**\r
1547      * Wraps the calling of the same overloaded method.\r
1548      *\r
1549      * @param packageName\r
1550      *            string with the package name to which returning generated type\r
1551      *            builder belongs\r
1552      * @param schemaNode\r
1553      *            schema node which provide data about the schema node name\r
1554      * @return generated type builder for <code>schemaNode</code>\r
1555      */
1556     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1557         return addRawInterfaceDefinition(packageName, schemaNode, "");
1558     }
1559
1560     /**\r
1561      * Returns reference to generated type builder for specified\r
1562      * <code>schemaNode</code> with <code>packageName</code>.\r
1563      *\r
1564      * Firstly the generated type builder is searched in\r
1565      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
1566      * found it is created and added to <code>genTypeBuilders</code>.\r
1567      *\r
1568      * @param packageName\r
1569      *            string with the package name to which returning generated type\r
1570      *            builder belongs\r
1571      * @param schemaNode\r
1572      *            schema node which provide data about the schema node name\r
1573      * @param prefix return type name prefix\r
1574      * @return generated type builder for <code>schemaNode</code>\r
1575      * @throws IllegalArgumentException\r
1576      *             <ul>\r
1577      *             <li>if <code>schemaNode</code> equals null</li>\r
1578      *             <li>if <code>packageName</code> equals null</li>\r
1579      *             <li>if Q name of schema node is null</li>\r
1580      *             <li>if schema node name is nul</li>\r
1581      *             </ul>\r
1582      *\r
1583      */
1584     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1585         String prefix) {
1586         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1587         checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1588         checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1589         val schemaNodeName = schemaNode.QName.localName;
1590         checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1591
1592         var String genTypeName;
1593         if (prefix === null) {
1594             genTypeName = parseToClassName(schemaNodeName);
1595         } else {
1596             genTypeName = prefix + parseToClassName(schemaNodeName);
1597         }
1598
1599         //FIXME: Validation of name conflict\r
1600         val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1601         if (!genTypeBuilders.containsKey(packageName)) {
1602             val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1603             builders.put(genTypeName, newType);
1604             genTypeBuilders.put(packageName, builders);
1605         } else {
1606             val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1607             if (!builders.containsKey(genTypeName)) {
1608                 builders.put(genTypeName, newType);
1609             }
1610         }
1611         return newType;
1612     }
1613
1614     /**\r
1615      * Creates the name of the getter method from <code>methodName</code>.\r
1616      *\r
1617      * @param methodName\r
1618      *            string with the name of the getter method\r
1619      * @param returnType return type\r
1620      * @return string with the name of the getter method for\r
1621      *         <code>methodName</code> in JAVA method format\r
1622      */
1623     public static def String getterMethodName(String localName, Type returnType) {
1624         val method = new StringBuilder();
1625         if (BOOLEAN.equals(returnType)) {
1626             method.append("is");
1627         } else {
1628             method.append("get");
1629         }
1630         method.append(parseToClassName(localName));
1631         return method.toString();
1632     }
1633
1634     /**\r
1635      * Created a method signature builder as part of\r
1636      * <code>interfaceBuilder</code>.\r
1637      *\r
1638      * The method signature builder is created for the getter method of\r
1639      * <code>schemaNodeName</code>. Also <code>comment</code> and\r
1640      * <code>returnType</code> information are added to the builder.\r
1641      *\r
1642      * @param interfaceBuilder\r
1643      *            generated type builder for which the getter method should be\r
1644      *            created\r
1645      * @param schemaNodeName\r
1646      *            string with schema node name. The name will be the part of the\r
1647      *            getter method name.\r
1648      * @param comment\r
1649      *            string with comment for the getter method\r
1650      * @param returnType\r
1651      *            type which represents the return type of the getter method\r
1652      * @return method signature builder which represents the getter method of\r
1653      *         <code>interfaceBuilder</code>\r
1654      */
1655     private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1656         String comment, Type returnType) {
1657         val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1658         getMethod.setComment(comment);
1659         getMethod.setReturnType(returnType);
1660         return getMethod;
1661     }
1662
1663     /**\r
1664      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
1665      * or to <code>genTOBuilder</code> as property.\r
1666      *\r
1667      * @param basePackageName\r
1668      *            string contains the module package name\r
1669      * @param schemaNode\r
1670      *            data schema node which should be added as getter method to\r
1671      *            <code>typeBuilder</code> or as a property to\r
1672      *            <code>genTOBuilder</code> if is part of the list key\r
1673      * @param typeBuilder\r
1674      *            generated type builder for the list schema node\r
1675      * @param genTOBuilder\r
1676      *            generated TO builder for the list keys\r
1677      * @param listKeys\r
1678      *            list of string which contains names of the list keys\r
1679      * @param module current module\r
1680      * @throws IllegalArgumentException\r
1681      *             <ul>\r
1682      *             <li>if <code>schemaNode</code> equals null</li>\r
1683      *             <li>if <code>typeBuilder</code> equals null</li>\r
1684      *             </ul>\r
1685      */
1686     private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1687         GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1688         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1689         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1690
1691         if (schemaNode instanceof LeafSchemaNode) {
1692             val leaf = schemaNode as LeafSchemaNode;
1693             val leafName = leaf.QName.localName;\r
1694             resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1695             if (listKeys.contains(leafName)) {
1696                 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
1697             }
1698         } else if (!schemaNode.addedByUses) {
1699             if (schemaNode instanceof LeafListSchemaNode) {
1700                 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1701             } else if (schemaNode instanceof ContainerSchemaNode) {
1702                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1703             } else if (schemaNode instanceof ChoiceNode) {
1704                 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1705             } else if (schemaNode instanceof ListSchemaNode) {
1706                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1707             }
1708         }
1709     }
1710
1711     private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1712         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1713
1714         if (genTOBuilder !== null) {
1715             val genTO = genTOBuilder.toInstance();
1716             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1717             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1718         }
1719     }
1720
1721     /**\r
1722      * Selects the names of the list keys from <code>list</code> and returns\r
1723      * them as the list of the strings\r
1724      *\r
1725      * @param list\r
1726      *            of string with names of the list keys\r
1727      * @return list of string which represents names of the list keys. If the\r
1728      *         <code>list</code> contains no keys then the empty list is\r
1729      *         returned.\r
1730      */
1731     private def listKeys(ListSchemaNode list) {
1732         val List<String> listKeys = new ArrayList();
1733
1734         if (list.keyDefinition !== null) {
1735             val keyDefinitions = list.keyDefinition;
1736             for (keyDefinition : keyDefinitions) {
1737                 listKeys.add(keyDefinition.localName);
1738             }
1739         }
1740         return listKeys;
1741     }
1742
1743     /**\r
1744      * Generates for the <code>list</code> which contains any list keys special\r
1745      * generated TO builder.\r
1746      *\r
1747      * @param packageName\r
1748      *            string with package name to which the list belongs\r
1749      * @param list\r
1750      *            list schema node which is source of data about the list name\r
1751      * @return generated TO builder which represents the keys of the\r
1752      *         <code>list</code> or null if <code>list</code> is null or list of\r
1753      *         key definitions is null or empty.\r
1754      */
1755     private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1756         var GeneratedTOBuilder genTOBuilder = null;
1757         if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1758             val listName = list.QName.localName + "Key";
1759             val String genTOName = parseToClassName(listName);
1760             genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1761         }
1762         return genTOBuilder;
1763     }
1764
1765     /**\r
1766      * Builds generated TO builders for <code>typeDef</code> of type\r
1767      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
1768      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
1769      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
1770      * enclosing transfer object.\r
1771      *\r
1772      * If more then one generated TO builder is created for enclosing then all\r
1773      * of the generated TO builders are added to <code>typeBuilder</code> as\r
1774      * enclosing transfer objects.\r
1775      *\r
1776      * @param typeDef\r
1777      *            type definition which can be of type <code>UnionType</code> or\r
1778      *            <code>BitsTypeDefinition</code>\r
1779      * @param typeBuilder\r
1780      *            generated type builder to which is added generated TO created\r
1781      *            from <code>typeDef</code>\r
1782      * @param leafName\r
1783      *            string with name for generated TO builder\r
1784      * @param leaf\r
1785      * @param parentModule\r
1786      * @return generated TO builder for <code>typeDef</code>\r
1787      */
1788     private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
1789         String leafName, LeafSchemaNode leaf, Module parentModule) {
1790         val classNameFromLeaf = parseToClassName(leafName);
1791         val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
1792         val packageName = typeBuilder.fullyQualifiedName;
1793         if (typeDef instanceof UnionTypeDefinition) {
1794             genTOBuilders.addAll(
1795                 (typeProvider as TypeProviderImpl).
1796                     provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
1797                         classNameFromLeaf, leaf));
1798         } else if (typeDef instanceof BitsTypeDefinition) {
1799             genTOBuilders.add(
1800                 ((typeProvider as TypeProviderImpl) ).
1801                     provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
1802         }
1803         if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
1804             for (genTOBuilder : genTOBuilders) {
1805                 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1806             }
1807             return genTOBuilders.get(0);
1808         }
1809         return null;
1810
1811     }
1812
1813     /**\r
1814      * Adds the implemented types to type builder.\r
1815      *\r
1816      * The method passes through the list of <i>uses</i> in\r
1817      * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding\r
1818      * generated type from {@link BindingGeneratorImpl#allGroupings\r
1819      * allGroupings} which is added as <i>implements type</i> to\r
1820      * <code>builder</code>\r
1821      *\r
1822      * @param dataNodeContainer\r
1823      *            element which contains the list of used YANG groupings\r
1824      * @param builder\r
1825      *            builder to which are added implemented types according to\r
1826      *            <code>dataNodeContainer</code>\r
1827      * @return generated type builder with all implemented types\r
1828      */
1829     private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
1830         for (usesNode : dataNodeContainer.uses) {
1831             if (usesNode.groupingPath !== null) {
1832                 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
1833                 if (genType === null) {
1834                     throw new IllegalStateException(
1835                         "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
1836                 }
1837                 builder.addImplementsType(genType);
1838             }
1839         }
1840         return builder;
1841     }
1842
1843     private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
1844         for (ctx : genCtx.values) {
1845             var result = ctx.getChildNode(path)
1846             if (result !== null) {
1847                 return result
1848             }
1849         }
1850         return null
1851     }
1852
1853     private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
1854         for (ctx : genCtx.values) {
1855             var result = ctx.getGrouping(path)
1856             if (result !== null) {
1857                 return result
1858             }
1859         }
1860         return null
1861     }
1862
1863     private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
1864         for (ctx : genCtx.values) {
1865             var result = ctx.getCase(path)
1866             if (result !== null) {
1867                 return result
1868             }
1869         }
1870         return null
1871     }
1872 \r
1873 \r
1874     public def getModuleContexts() {\r
1875         genCtx;\r
1876     }
1877 }