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) {\r
 886                     if (result != null && result.addedByUses) {\r
 887                         result = findOriginal(result);\r
 888                     }
 889                     return result;
 890                 } else {
 891                     var DataSchemaNode newParent = result;
 892                     Collections.reverse(tmpPath);
 893                     tmpPath.remove(0);
 894                     for (name : tmpPath) {
 895                         newParent = (newParent as DataNodeContainer).getDataChildByName(name);
 896                     }\r
 897                     if (newParent != null && newParent.addedByUses) {\r
 898                         newParent = findOriginal(newParent);\r
 899                     }
 900                     return newParent;
 901                 }
 902             }
 903
 904             return result;
 905         }
 906     }
 907
 908     /**\r
 909      * Convenient method to find node added by uses statement.\r
 910      */
 911     private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
 912         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
 913         if (!(targetGrouping instanceof GroupingDefinition)) {
 914             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
 915         }
 916
 917         var grouping = targetGrouping as GroupingDefinition;
 918         var result = grouping.getDataChildByName(targetSchemaNodeName);
 919         if (result == null) {
 920             return null;
 921         }
 922         var boolean fromUses = result.addedByUses;
 923
 924         var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
 925         while (fromUses) {
 926             if (groupingUses.hasNext()) {
 927                 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
 928                 result = grouping.getDataChildByName(targetSchemaNodeName);
 929                 fromUses = result.addedByUses;
 930             } else {
 931                 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
 932             }
 933         }
 934
 935         return result;
 936     }
 937
 938     /**\r
 939      * Returns a generated type builder for an augmentation.\r
 940      *\r
 941      * The name of the type builder is equal to the name of augmented node with\r
 942      * serial number as suffix.\r
 943      *\r
 944      * @param module current module\r
 945      * @param augmentPackageName\r
 946      *            string with contains the package name to which the augment\r
 947      *            belongs\r
 948      * @param basePackageName\r
 949      *            string with the package name to which the augmented node\r
 950      *            belongs\r
 951      * @param targetTypeRef\r
 952      *            target type\r
 953      * @param augSchema\r
 954      *            augmentation schema which contains data about the child nodes\r
 955      *            and uses of augment\r
 956      * @return generated type builder for augment\r
 957      */
 958     private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
 959         String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
 960         var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
 961         if (augmentBuilders === null) {
 962             augmentBuilders = new HashMap();
 963             genTypeBuilders.put(augmentPackageName, augmentBuilders);
 964         }
 965         val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
 966
 967         val augTypeName = if (augIdentifier !== null) {
 968                 parseToClassName(augIdentifier)
 969             } else {
 970                 augGenTypeName(augmentBuilders, targetTypeRef.name);
 971             }
 972
 973         val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
 974
 975         augTypeBuilder.addImplementsType(DATA_OBJECT);
 976         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 977         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
 978
 979         augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
 980         augmentBuilders.put(augTypeName, augTypeBuilder);
 981         return augTypeBuilder;
 982     }
 983
 984     /**\r
 985      *\r
 986      * @param unknownSchemaNodes\r
 987      * @return nodeParameter of UnknownSchemaNode\r
 988      */
 989     private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
 990         for (unknownSchemaNode : unknownSchemaNodes) {
 991             val nodeType = unknownSchemaNode.nodeType;
 992             if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
 993                 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
 994                 return unknownSchemaNode.nodeParameter;
 995             }
 996         }
 997         return null;
 998     }
 999
1000     /**\r
1001      * Returns first unique name for the augment generated type builder. The\r
1002      * generated type builder name for augment consists from name of augmented\r
1003      * node and serial number of its augmentation.\r
1004      *\r
1005      * @param builders\r
1006      *            map of builders which were created in the package to which the\r
1007      *            augmentation belongs\r
1008      * @param genTypeName\r
1009      *            string with name of augmented node\r
1010      * @return string with unique name for augmentation builder\r
1011      */
1012     private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
1013         var index = 1;
1014         while ((builders !== null) && builders.containsKey(genTypeName + index)) {
1015             index = index + 1;
1016         }
1017         return genTypeName + index;
1018     }
1019
1020     /**\r
1021      * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
1022      * node for which <code>typeBuilder</code> was created.\r
1023      *\r
1024      * The subnodes aren't mapped to the methods if they are part of grouping or\r
1025      * augment (in this case are already part of them).\r
1026      *\r
1027      * @param module current module\r
1028      * @param basePackageName\r
1029      *            string contains the module package name\r
1030      * @param parent\r
1031      *            generated type builder which represents any node. The subnodes\r
1032      *            of this node are added to the <code>typeBuilder</code> as\r
1033      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1034      *            container, choice.\r
1035      * @param childOf parent type\r
1036      * @param schemaNodes\r
1037      *            set of data schema nodes which are the children of the node\r
1038      *            for which <code>typeBuilder</code> was created\r
1039      * @return generated type builder which is the same builder as input\r
1040      *         parameter. The getter methods (representing child nodes) could be\r
1041      *         added to it.\r
1042      */
1043     private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
1044         GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1045         if ((schemaNodes !== null) && (parent !== null)) {
1046             for (schemaNode : schemaNodes) {
1047                 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
1048                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1049                 }
1050             }
1051         }
1052         return parent;
1053     }
1054
1055     /**\r
1056      * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
1057      * node for which <code>typeBuilder</code> was created.\r
1058      *\r
1059      * @param module current module\r
1060      * @param basePackageName\r
1061      *            string contains the module package name\r
1062      * @param typeBuilder\r
1063      *            generated type builder which represents any node. The subnodes\r
1064      *            of this node are added to the <code>typeBuilder</code> as\r
1065      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1066      *            container, choice.\r
1067      * @param childOf parent type\r
1068      * @param schemaNodes\r
1069      *            set of data schema nodes which are the children of the node\r
1070      *            for which <code>typeBuilder</code> was created\r
1071      * @return generated type builder which is the same object as the input\r
1072      *         parameter <code>typeBuilder</code>. The getter method could be\r
1073      *         added to it.\r
1074      */
1075     private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1076         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1077         if ((schemaNodes !== null) && (typeBuilder !== null)) {
1078             for (schemaNode : schemaNodes) {
1079                 if (!schemaNode.isAugmenting()) {
1080                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1081                 }
1082             }
1083         }
1084         return typeBuilder;
1085     }
1086
1087     /**\r
1088      * Adds to <code>typeBuilder</code> a method which is derived from\r
1089      * <code>schemaNode</code>.\r
1090      *\r
1091      * @param basePackageName\r
1092      *            string with the module package name\r
1093      * @param node\r
1094      *            data schema node which is added to <code>typeBuilder</code> as\r
1095      *            a method\r
1096      * @param typeBuilder\r
1097      *            generated type builder to which is <code>schemaNode</code>\r
1098      *            added as a method.\r
1099      * @param childOf parent type\r
1100      * @param module current module\r
1101      */
1102     private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1103         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1104         if (node !== null && typeBuilder !== null) {
1105             switch (node) {
1106                 case node instanceof LeafSchemaNode:
1107                     resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1108                 case node instanceof LeafListSchemaNode:
1109                     resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1110                 case node instanceof ContainerSchemaNode:
1111                     containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1112                 case node instanceof ListSchemaNode:
1113                     listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1114                 case node instanceof ChoiceNode:
1115                     choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1116             }
1117         }
1118     }
1119
1120     /**\r
1121      * Converts <code>choiceNode</code> to the list of generated types for\r
1122      * choice and its cases.\r
1123      *\r
1124      * The package names for choice and for its cases are created as\r
1125      * concatenation of the module package (<code>basePackageName</code>) and\r
1126      * names of all parents node.\r
1127      *\r
1128      * @param module current module\r
1129      * @param basePackageName\r
1130      *            string with the module package name\r
1131      * @param parent parent type\r
1132      * @param childOf concrete parent for case child nodes\r
1133      * @param choiceNode\r
1134      *            choice node which is mapped to generated type. Also child\r
1135      *            nodes - cases are mapped to generated types.\r
1136      * @throws IllegalArgumentException\r
1137      *             <ul>\r
1138      *             <li>if <code>basePackageName</code> equals null</li>\r
1139      *             <li>if <code>choiceNode</code> equals null</li>\r
1140      *             </ul>\r
1141      *\r
1142      */
1143     private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1144         ChoiceNode choiceNode) {
1145         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1146         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1147
1148         val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1149         val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1150         constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1151         choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1152         genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1153         generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1154     }
1155
1156     /**\r
1157      * Converts <code>caseNodes</code> set to list of corresponding generated\r
1158      * types.\r
1159      *\r
1160      * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
1161      * created generated type builder. The package names for the builder is\r
1162      * created as concatenation of the module package (\r
1163      * <code>basePackageName</code>) and names of all parents nodes of the\r
1164      * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
1165      * between every case builder and <i>choice</i> type\r
1166      *\r
1167      * @param basePackageName\r
1168      *            string with the module package name\r
1169      * @param refChoiceType\r
1170      *            type which represents superior <i>case</i>\r
1171      * @param caseNodes\r
1172      *            set of choice case nodes which are mapped to generated types\r
1173      * @return list of generated types for <code>caseNodes</code>.\r
1174      * @throws IllegalArgumentException\r
1175      *             <ul>\r
1176      *             <li>if <code>basePackageName</code> equals null</li>\r
1177      *             <li>if <code>refChoiceType</code> equals null</li>\r
1178      *             <li>if <code>caseNodes</code> equals null</li>\r
1179      *             </ul>\r
1180      *             *\r
1181      */
1182     private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1183         GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1184         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1185         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1186         checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1187
1188         val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1189         if (caseNodes == null) {
1190             return
1191         }
1192
1193         for (caseNode : caseNodes) {
1194             if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1195                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1196                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1197                 caseTypeBuilder.addImplementsType(refChoiceType)
1198                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1199                 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1200                 if (caseChildNodes !== null) {
1201                     val parentNode = choiceNode.parent
1202                     var SchemaNode parent
1203                     if (parentNode instanceof AugmentationSchema) {
1204                         val augSchema = parentNode as AugmentationSchema;
1205                         val targetPath = augSchema.targetPath;
1206                         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1207                         if (targetSchemaNode instanceof DataSchemaNode &&
1208                             (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1209                             targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
1210                             if (targetSchemaNode == null) {
1211                                 throw new NullPointerException(
1212                                     "Failed to find target node from grouping for augmentation " + augSchema +
1213                                         " in module " + module.name);
1214                             }
1215                         }
1216                         parent = targetSchemaNode
1217                     } else {
1218                         parent = choiceNode.parent as SchemaNode
1219                     }
1220                     var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1221                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1222                 }
1223             }
1224
1225             processUsesAugments(caseNode, module);
1226         }
1227     }
1228
1229     /**\r
1230      * Generates list of generated types for all the cases of a choice which are\r
1231      * added to the choice through the augment.\r
1232      *\r
1233      *\r
1234      * @param basePackageName\r
1235      *            string contains name of package to which augment belongs. If\r
1236      *            an augmented choice is from an other package (pcg1) than an\r
1237      *            augmenting choice (pcg2) then case's of the augmenting choice\r
1238      *            will belong to pcg2.\r
1239      * @param refChoiceType\r
1240      *            Type which represents the choice to which case belongs. Every\r
1241      *            case has to contain its choice in extend part.\r
1242      * @param caseNodes\r
1243      *            set of choice case nodes for which is checked if are/aren't\r
1244      *            added to choice through augmentation\r
1245      * @return list of generated types which represents augmented cases of\r
1246      *         choice <code>refChoiceType</code>\r
1247      * @throws IllegalArgumentException\r
1248      *             <ul>\r
1249      *             <li>if <code>basePackageName</code> equals null</li>\r
1250      *             <li>if <code>refChoiceType</code> equals null</li>\r
1251      *             <li>if <code>caseNodes</code> equals null</li>\r
1252      *             </ul>\r
1253      */
1254     private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1255         ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1256         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1257         checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1258         checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1259
1260         for (caseNode : augmentedNodes) {
1261             if (caseNode !== null) {
1262                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1263                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1264                 caseTypeBuilder.addImplementsType(targetType);
1265
1266                 val SchemaNode parent = targetNode.parent as SchemaNode;
1267                 var GeneratedTypeBuilder childOfType = null;
1268                 if (parent instanceof Module) {
1269                     childOfType = genCtx.get(parent as Module).moduleNode
1270                 } else if (parent instanceof ChoiceCaseNode) {
1271                     childOfType = findCaseByPath(parent.path)
1272                 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1273                     childOfType = findChildNodeByPath(parent.path)
1274                 } else if (parent instanceof GroupingDefinition) {
1275                     childOfType = findGroupingByPath(parent.path);
1276                 }
1277
1278                 if (childOfType == null) {
1279                     throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1280                 }
1281
1282                 if (caseNode instanceof DataNodeContainer) {
1283                     val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
1284                     val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
1285                     if (childNodes !== null) {
1286                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1287                     }
1288                 } else {
1289                     val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1290                     val Set<DataSchemaNode> childNodes = node.childNodes;
1291                     if (childNodes !== null) {
1292                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1293                     }
1294                 }
1295
1296                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1297             }
1298         }
1299
1300     }
1301
1302     /**\r
1303      * Converts <code>leaf</code> to the getter method which is added to\r
1304      * <code>typeBuilder</code>.\r
1305      *\r
1306      * @param typeBuilder\r
1307      *            generated type builder to which is added getter method as\r
1308      *            <code>leaf</code> mapping\r
1309      * @param leaf\r
1310      *            leaf schema node which is mapped as getter method which is\r
1311      *            added to <code>typeBuilder</code>\r
1312      * @return boolean value\r
1313      *         <ul>\r
1314      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
1315      *         null</li>\r
1316      *         <li>true - in other cases</li>\r
1317      *         </ul>\r
1318      */
1319     private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1320         if ((leaf !== null) && (typeBuilder !== null)) {
1321             val leafName = leaf.QName.localName;
1322             var String leafDesc = leaf.description;
1323             if (leafDesc === null) {
1324                 leafDesc = "";
1325             }
1326
1327             val parentModule = findParentModule(schemaContext, leaf);
1328             if (leafName !== null && !leaf.isAddedByUses()) {
1329                 val TypeDefinition<?> typeDef = leaf.type;
1330
1331                 var Type returnType = null;
1332                 if (typeDef instanceof EnumTypeDefinition) {
1333                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1334                     val enumTypeDef = typeDef as EnumTypeDefinition;
1335                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);
1336
1337                     if (enumBuilder !== null) {
1338                         returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1339                     }
1340                     (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1341                 } else if (typeDef instanceof UnionType) {
1342                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
1343                     if (genTOBuilder !== null) {
1344                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1345                     }
1346                 } else if (typeDef instanceof BitsTypeDefinition) {
1347                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
1348                     if (genTOBuilder !== null) {
1349                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1350                     }
1351                 } else {\r
1352                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);\r
1353                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1354                 }
1355                 if (returnType !== null) {
1356                     val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1357                     processContextRefExtension(leaf, getter, parentModule);
1358                     return true;
1359                 }
1360             }
1361         }
1362         return false;
1363     }
1364
1365     private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1366         for (node : leaf.unknownSchemaNodes) {
1367             val nodeType = node.nodeType;
1368             if ("context-reference".equals(nodeType.localName)) {
1369                 val nodeParam = node.nodeParameter;
1370                 var IdentitySchemaNode identity = null;
1371                 var String basePackageName = null;
1372                 val String[] splittedElement = nodeParam.split(":");
1373                 if (splittedElement.length == 1) {
1374                     identity = findIdentityByName(module.identities, splittedElement.get(0));
1375                     basePackageName = moduleNamespaceToPackageName(module);
1376                 } else if (splittedElement.length == 2) {
1377                     var prefix = splittedElement.get(0);
1378                     val Module dependentModule = findModuleFromImports(module.imports, prefix)
1379                     if (dependentModule == null) {
1380                         throw new IllegalArgumentException(
1381                             "Failed to process context-reference: unknown prefix " + prefix);
1382                     }
1383                     identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1384                     basePackageName = moduleNamespaceToPackageName(dependentModule);
1385                 } else {
1386                     throw new IllegalArgumentException(
1387                         "Failed to process context-reference: unknown identity " + nodeParam);
1388                 }
1389                 if (identity == null) {
1390                     throw new IllegalArgumentException(
1391                         "Failed to process context-reference: unknown identity " + nodeParam);
1392                 }
1393
1394                 val Class<RoutingContext> clazz = typeof(RoutingContext);
1395                 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1396                 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1397                 val genTypeName = parseToClassName(identity.QName.localName);
1398                 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1399             }
1400         }
1401     }
1402
1403     private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1404         for (id : identities) {
1405             if (id.QName.localName.equals(name)) {
1406                 return id;
1407             }
1408         }
1409         return null;
1410     }
1411
1412     private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1413         for (imp : imports) {
1414             if (imp.prefix.equals(prefix)) {
1415                 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1416             }
1417         }
1418         return null;
1419     }
1420
1421     /**\r
1422      * Converts <code>leaf</code> schema node to property of generated TO\r
1423      * builder.\r
1424      *\r
1425      * @param toBuilder\r
1426      *            generated TO builder to which is <code>leaf</code> added as\r
1427      *            property\r
1428      * @param leaf\r
1429      *            leaf schema node which is added to <code>toBuilder</code> as\r
1430      *            property\r
1431      * @param isReadOnly\r
1432      *            boolean value which says if leaf property is|isn't read only\r
1433      * @return boolean value\r
1434      *         <ul>\r
1435      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
1436      *         name equals null or if leaf is added by <i>uses</i>.</li>\r
1437      *         <li>true - other cases</li>\r
1438      *         </ul>\r
1439      */
1440     private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1441         boolean isReadOnly) {
1442         if ((leaf !== null) && (toBuilder !== null)) {
1443             val leafName = leaf.QName.localName;
1444             var String leafDesc = leaf.description;
1445             if (leafDesc === null) {
1446                 leafDesc = "";
1447             }
1448
1449             if (leafName !== null) {
1450                 val TypeDefinition<?> typeDef = leaf.type;
1451
1452                 // TODO: properly resolve enum types\r
1453                 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1454                 if (returnType !== null) {
1455                     val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1456                     propBuilder.setReadOnly(isReadOnly);
1457                     propBuilder.setReturnType(returnType);
1458                     propBuilder.setComment(leafDesc);
1459                     toBuilder.addEqualsIdentity(propBuilder);
1460                     toBuilder.addHashIdentity(propBuilder);
1461                     toBuilder.addToStringProperty(propBuilder);
1462                     return true;
1463                 }
1464             }
1465         }
1466         return false;
1467     }
1468
1469     /**\r
1470      * Converts <code>node</code> leaf list schema node to getter method of\r
1471      * <code>typeBuilder</code>.\r
1472      *\r
1473      * @param typeBuilder\r
1474      *            generated type builder to which is <code>node</code> added as\r
1475      *            getter method\r
1476      * @param node\r
1477      *            leaf list schema node which is added to\r
1478      *            <code>typeBuilder</code> as getter method\r
1479      * @return boolean value\r
1480      *         <ul>\r
1481      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
1482      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
1483      *         <li>false - other cases</li>\r
1484      *         </ul>\r
1485      */
1486     private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1487         if ((node !== null) && (typeBuilder !== null)) {
1488             val nodeName = node.QName.localName;
1489             var String nodeDesc = node.description;
1490             if (nodeDesc === null) {
1491                 nodeDesc = "";
1492             }
1493             if (nodeName !== null && !node.isAddedByUses()) {
1494                 val TypeDefinition<?> typeDef = node.type;\r
1495                 val parentModule = findParentModule(schemaContext, node);\r
1496 \r
1497                 var Type returnType = null;\r
1498                 if (typeDef instanceof EnumTypeDefinition) {\r
1499                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);\r
1500                     val enumTypeDef = typeDef as EnumTypeDefinition;\r
1501                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, typeBuilder);\r
1502                     returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);\r
1503                     (typeProvider as TypeProviderImpl).putReferencedType(node.path, returnType);\r
1504                 } else if (typeDef instanceof UnionType) {\r
1505                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, nodeName, node, parentModule);\r
1506                     returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1507                 } else if (typeDef instanceof BitsTypeDefinition) {\r
1508                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, nodeName, node, parentModule);\r
1509                     returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1510                 } else {\r
1511                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);\r
1512                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);\r
1513                 }\r
1514
1515                 val listType = Types.listTypeFor(returnType);
1516                 constructGetter(typeBuilder, nodeName, nodeDesc, listType);
1517                 return true;
1518             }
1519         }
1520         return false;
1521     }
1522
1523     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1524         return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1525     }
1526
1527     /**\r
1528      * Instantiates generated type builder with <code>packageName</code> and\r
1529      * <code>schemaNode</code>.\r
1530      *\r
1531      * The new builder always implements\r
1532      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
1533      * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
1534      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
1535      * Augmentable}.<br />\r
1536      * If <code>schemaNode</code> is instance of\r
1537      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
1538      * DataNodeContainer} it can also implement nodes which are specified in\r
1539      * <i>uses</i>.\r
1540      *\r
1541      * @param packageName\r
1542      *            string with the name of the package to which\r
1543      *            <code>schemaNode</code> belongs.\r
1544      * @param schemaNode\r
1545      *            schema node for which is created generated type builder\r
1546      * @param parent parent type (can be null)\r
1547      * @return generated type builder <code>schemaNode</code>\r
1548      */
1549     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1550         Type parent) {
1551         val it = addRawInterfaceDefinition(packageName, schemaNode, "");\r
1552         val qname = schemaNode.QName;
1553         addConstant(QName.typeForClass,"QNAME",'''\r
1554             org.opendaylight.yangtools.yang.common.QName.create("«qname.namespace»","«qname.formattedRevision»","«qname.localName»")\r
1555         ''');\r
1556         if (parent === null) {
1557             addImplementsType(DATA_OBJECT);
1558         } else {
1559             addImplementsType(BindingTypes.childOf(parent));
1560         }
1561         if (!(schemaNode instanceof GroupingDefinition)) {
1562             addImplementsType(augmentable(it));
1563         }
1564
1565         if (schemaNode instanceof DataNodeContainer) {
1566             addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1567         }
1568
1569         return it;
1570     }
1571
1572     /**\r
1573      * Wraps the calling of the same overloaded method.\r
1574      *\r
1575      * @param packageName\r
1576      *            string with the package name to which returning generated type\r
1577      *            builder belongs\r
1578      * @param schemaNode\r
1579      *            schema node which provide data about the schema node name\r
1580      * @return generated type builder for <code>schemaNode</code>\r
1581      */
1582     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1583         return addRawInterfaceDefinition(packageName, schemaNode, "");
1584     }
1585
1586     /**\r
1587      * Returns reference to generated type builder for specified\r
1588      * <code>schemaNode</code> with <code>packageName</code>.\r
1589      *\r
1590      * Firstly the generated type builder is searched in\r
1591      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
1592      * found it is created and added to <code>genTypeBuilders</code>.\r
1593      *\r
1594      * @param packageName\r
1595      *            string with the package name to which returning generated type\r
1596      *            builder belongs\r
1597      * @param schemaNode\r
1598      *            schema node which provide data about the schema node name\r
1599      * @param prefix return type name prefix\r
1600      * @return generated type builder for <code>schemaNode</code>\r
1601      * @throws IllegalArgumentException\r
1602      *             <ul>\r
1603      *             <li>if <code>schemaNode</code> equals null</li>\r
1604      *             <li>if <code>packageName</code> equals null</li>\r
1605      *             <li>if Q name of schema node is null</li>\r
1606      *             <li>if schema node name is nul</li>\r
1607      *             </ul>\r
1608      *\r
1609      */
1610     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1611         String prefix) {
1612         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1613         checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1614         checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1615         val schemaNodeName = schemaNode.QName.localName;
1616         checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1617
1618         var String genTypeName;
1619         if (prefix === null) {
1620             genTypeName = parseToClassName(schemaNodeName);
1621         } else {
1622             genTypeName = prefix + parseToClassName(schemaNodeName);
1623         }
1624
1625         //FIXME: Validation of name conflict\r
1626         val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1627         if (!genTypeBuilders.containsKey(packageName)) {
1628             val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1629             builders.put(genTypeName, newType);
1630             genTypeBuilders.put(packageName, builders);
1631         } else {
1632             val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1633             if (!builders.containsKey(genTypeName)) {
1634                 builders.put(genTypeName, newType);
1635             }
1636         }
1637         return newType;
1638     }
1639
1640     /**\r
1641      * Creates the name of the getter method from <code>methodName</code>.\r
1642      *\r
1643      * @param methodName\r
1644      *            string with the name of the getter method\r
1645      * @param returnType return type\r
1646      * @return string with the name of the getter method for\r
1647      *         <code>methodName</code> in JAVA method format\r
1648      */
1649     public static def String getterMethodName(String localName, Type returnType) {
1650         val method = new StringBuilder();
1651         if (BOOLEAN.equals(returnType)) {
1652             method.append("is");
1653         } else {
1654             method.append("get");
1655         }
1656         method.append(parseToClassName(localName));
1657         return method.toString();
1658     }
1659
1660     /**\r
1661      * Created a method signature builder as part of\r
1662      * <code>interfaceBuilder</code>.\r
1663      *\r
1664      * The method signature builder is created for the getter method of\r
1665      * <code>schemaNodeName</code>. Also <code>comment</code> and\r
1666      * <code>returnType</code> information are added to the builder.\r
1667      *\r
1668      * @param interfaceBuilder\r
1669      *            generated type builder for which the getter method should be\r
1670      *            created\r
1671      * @param schemaNodeName\r
1672      *            string with schema node name. The name will be the part of the\r
1673      *            getter method name.\r
1674      * @param comment\r
1675      *            string with comment for the getter method\r
1676      * @param returnType\r
1677      *            type which represents the return type of the getter method\r
1678      * @return method signature builder which represents the getter method of\r
1679      *         <code>interfaceBuilder</code>\r
1680      */
1681     private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1682         String comment, Type returnType) {
1683         val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1684         getMethod.setComment(comment);
1685         getMethod.setReturnType(returnType);
1686         return getMethod;
1687     }
1688
1689     /**\r
1690      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
1691      * or to <code>genTOBuilder</code> as property.\r
1692      *\r
1693      * @param basePackageName\r
1694      *            string contains the module package name\r
1695      * @param schemaNode\r
1696      *            data schema node which should be added as getter method to\r
1697      *            <code>typeBuilder</code> or as a property to\r
1698      *            <code>genTOBuilder</code> if is part of the list key\r
1699      * @param typeBuilder\r
1700      *            generated type builder for the list schema node\r
1701      * @param genTOBuilder\r
1702      *            generated TO builder for the list keys\r
1703      * @param listKeys\r
1704      *            list of string which contains names of the list keys\r
1705      * @param module current module\r
1706      * @throws IllegalArgumentException\r
1707      *             <ul>\r
1708      *             <li>if <code>schemaNode</code> equals null</li>\r
1709      *             <li>if <code>typeBuilder</code> equals null</li>\r
1710      *             </ul>\r
1711      */
1712     private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1713         GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1714         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1715         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1716
1717         if (schemaNode instanceof LeafSchemaNode) {
1718             val leaf = schemaNode as LeafSchemaNode;
1719             val leafName = leaf.QName.localName;\r
1720             resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1721             if (listKeys.contains(leafName)) {
1722                 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
1723             }
1724         } else if (!schemaNode.addedByUses) {
1725             if (schemaNode instanceof LeafListSchemaNode) {
1726                 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1727             } else if (schemaNode instanceof ContainerSchemaNode) {
1728                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1729             } else if (schemaNode instanceof ChoiceNode) {
1730                 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1731             } else if (schemaNode instanceof ListSchemaNode) {
1732                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1733             }
1734         }
1735     }
1736
1737     private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1738         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1739
1740         if (genTOBuilder !== null) {
1741             val genTO = genTOBuilder.toInstance();
1742             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1743             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1744         }
1745     }
1746
1747     /**\r
1748      * Selects the names of the list keys from <code>list</code> and returns\r
1749      * them as the list of the strings\r
1750      *\r
1751      * @param list\r
1752      *            of string with names of the list keys\r
1753      * @return list of string which represents names of the list keys. If the\r
1754      *         <code>list</code> contains no keys then the empty list is\r
1755      *         returned.\r
1756      */
1757     private def listKeys(ListSchemaNode list) {
1758         val List<String> listKeys = new ArrayList();
1759
1760         if (list.keyDefinition !== null) {
1761             val keyDefinitions = list.keyDefinition;
1762             for (keyDefinition : keyDefinitions) {
1763                 listKeys.add(keyDefinition.localName);
1764             }
1765         }
1766         return listKeys;
1767     }
1768
1769     /**\r
1770      * Generates for the <code>list</code> which contains any list keys special\r
1771      * generated TO builder.\r
1772      *\r
1773      * @param packageName\r
1774      *            string with package name to which the list belongs\r
1775      * @param list\r
1776      *            list schema node which is source of data about the list name\r
1777      * @return generated TO builder which represents the keys of the\r
1778      *         <code>list</code> or null if <code>list</code> is null or list of\r
1779      *         key definitions is null or empty.\r
1780      */
1781     private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1782         var GeneratedTOBuilder genTOBuilder = null;
1783         if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1784             val listName = list.QName.localName + "Key";
1785             val String genTOName = parseToClassName(listName);
1786             genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1787         }
1788         return genTOBuilder;
1789     }
1790
1791     /**\r
1792      * Builds generated TO builders for <code>typeDef</code> of type\r
1793      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
1794      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
1795      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
1796      * enclosing transfer object.\r
1797      *\r
1798      * If more then one generated TO builder is created for enclosing then all\r
1799      * of the generated TO builders are added to <code>typeBuilder</code> as\r
1800      * enclosing transfer objects.\r
1801      *\r
1802      * @param typeDef\r
1803      *            type definition which can be of type <code>UnionType</code> or\r
1804      *            <code>BitsTypeDefinition</code>\r
1805      * @param typeBuilder\r
1806      *            generated type builder to which is added generated TO created\r
1807      *            from <code>typeDef</code>\r
1808      * @param leafName\r
1809      *            string with name for generated TO builder\r
1810      * @param leaf\r
1811      * @param parentModule\r
1812      * @return generated TO builder for <code>typeDef</code>\r
1813      */
1814     private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
1815         String leafName, DataSchemaNode leaf, Module parentModule) {
1816         val classNameFromLeaf = parseToClassName(leafName);
1817         val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
1818         val packageName = typeBuilder.fullyQualifiedName;
1819         if (typeDef instanceof UnionTypeDefinition) {
1820             genTOBuilders.addAll(
1821                 (typeProvider as TypeProviderImpl).
1822                     provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
1823                         classNameFromLeaf, leaf));
1824         } else if (typeDef instanceof BitsTypeDefinition) {
1825             genTOBuilders.add(
1826                 ((typeProvider as TypeProviderImpl) ).
1827                     provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
1828         }
1829         if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
1830             for (genTOBuilder : genTOBuilders) {
1831                 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1832             }
1833             return genTOBuilders.get(0);
1834         }
1835         return null;
1836
1837     }
1838
1839     /**\r
1840      * Adds the implemented types to type builder.\r
1841      *\r
1842      * The method passes through the list of <i>uses</i> in\r
1843      * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding\r
1844      * generated type from {@link BindingGeneratorImpl#allGroupings\r
1845      * allGroupings} which is added as <i>implements type</i> to\r
1846      * <code>builder</code>\r
1847      *\r
1848      * @param dataNodeContainer\r
1849      *            element which contains the list of used YANG groupings\r
1850      * @param builder\r
1851      *            builder to which are added implemented types according to\r
1852      *            <code>dataNodeContainer</code>\r
1853      * @return generated type builder with all implemented types\r
1854      */
1855     private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
1856         for (usesNode : dataNodeContainer.uses) {
1857             if (usesNode.groupingPath !== null) {
1858                 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
1859                 if (genType === null) {
1860                     throw new IllegalStateException(
1861                         "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
1862                 }
1863                 builder.addImplementsType(genType);
1864             }
1865         }
1866         return builder;
1867     }
1868
1869     private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
1870         for (ctx : genCtx.values) {
1871             var result = ctx.getChildNode(path)
1872             if (result !== null) {
1873                 return result
1874             }
1875         }
1876         return null
1877     }
1878
1879     private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
1880         for (ctx : genCtx.values) {
1881             var result = ctx.getGrouping(path)
1882             if (result !== null) {
1883                 return result
1884             }
1885         }
1886         return null
1887     }
1888
1889     private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
1890         for (ctx : genCtx.values) {
1891             var result = ctx.getCase(path)
1892             if (result !== null) {
1893                 return result
1894             }
1895         }
1896         return null
1897     }
1898 \r
1899 \r
1900     public def getModuleContexts() {\r
1901         genCtx;\r
1902     }
1903 }