binding2/mdsal-binding2-generator-impl/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/impl/GenHelperUtil.java

   1 /*
   2  * Copyright (c) 2017 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.mdsal.binding.javav2.generator.impl;
  10
  11 import static com.google.common.base.Preconditions.checkArgument;
  12 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.addTOToTypeBuilder;
  13 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.annotateDeprecatedIfNecessary;
  14 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.augGenTypeName;
  15 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.constructGetter;
  16 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createDescription;
  17 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createReturnTypeForUnion;
  18 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.getAugmentIdentifier;
  19 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.isInnerType;
  20 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.qNameConstant;
  21 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveInnerEnumFromTypeDefinition;
  22 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTOBuilder;
  23 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.computeDefaultSUID;
  24 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
  25 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
  26 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.INSTANTIABLE;
  27 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION;
  28 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
  29 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
  30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
  31
  32 import com.google.common.annotations.Beta;
  33 import com.google.common.base.Preconditions;
  34 import com.google.common.collect.Iterables;
  35 import java.util.Collection;
  36 import java.util.HashMap;
  37 import java.util.List;
  38 import java.util.Map;
  39 import java.util.Set;
  40 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
  41 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
  42 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
  43 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
  44 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
  45 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
  46 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
  47 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
  48 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
  49 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
  50 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
  51 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
  52 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
  53 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
  54 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
  55 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
  56 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
  57 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  58 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
  59 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
  60 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
  61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
  62 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
  63 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
  64 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
  65 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
  66 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
  67 import org.opendaylight.yangtools.yang.common.QName;
  68 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  69 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  70 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  71 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  72 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  73 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  74 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  75 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  76 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  77 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  78 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  79 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  80 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  81 import org.opendaylight.yangtools.yang.model.api.Module;
  82 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  83 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  84 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  85 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  86 import org.opendaylight.yangtools.yang.model.api.Status;
  87 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  88 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  89 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  90 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  91 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  92 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  93
  94 /**
  95  * Helper util class used for generation of types in Binding spec v2.
  96  */
  97 @Beta
  98 final class GenHelperUtil {
  99
 100     private GenHelperUtil() {
 101         throw new UnsupportedOperationException("Util class");
 102     }
 103
 104     /**
 105      * Create GeneratedTypeBuilder object from module argument.
 106      *
 107      * @param module
 108      *            Module object from which builder will be created
 109      * @param genCtx
 110      * @param verboseClassComments
 111      *
 112      * @return <code>GeneratedTypeBuilder</code> which is internal
 113      *         representation of the module
 114      * @throws IllegalArgumentException
 115      *             if module is null
 116      */
 117     static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
 118         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
 119
 120         final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments);
 121         addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
 122         moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
 123         moduleDataTypeBuilder.addComment(module.getDescription());
 124         moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
 125         moduleDataTypeBuilder.setReference(module.getReference());
 126         return moduleDataTypeBuilder;
 127     }
 128
 129     /**
 130      * Generates type builder for <code>module</code>.
 131      *
 132      * @param module
 133      *            Module which is source of package name for generated type
 134      *            builder
 135      * @param postfix
 136      *            string which is added to the module class name representation
 137      *            as suffix
 138      * @param verboseClassComments
 139      * @return instance of GeneratedTypeBuilder which represents
 140      *         <code>module</code>.
 141      * @throws IllegalArgumentException
 142      *             if <code>module</code> is null
 143      */
 144     static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
 145             verboseClassComments) {
 146         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
 147         final String packageName = BindingMapping.getRootPackageName(module);
 148         // underscore used as separator for distinction of module name parts
 149         final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
 150
 151         final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
 152         moduleBuilder.setDescription(createDescription(module, verboseClassComments));
 153         moduleBuilder.setReference(module.getReference());
 154         moduleBuilder.setModuleName(moduleName);
 155
 156         return moduleBuilder;
 157     }
 158
 159     /**
 160      * Adds the implemented types to type builder.
 161      *
 162      * The method passes through the list of <i>uses</i> in
 163      * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
 164      * generated type from all groupings
 165      * allGroupings} which is added as <i>implements type</i> to
 166      * <code>builder</code>
 167      *
 168      * @param dataNodeContainer
 169      *            element which contains the list of used YANG groupings
 170      * @param builder
 171      *            builder to which are added implemented types according to
 172      *            <code>dataNodeContainer</code>
 173      * @param genCtx generated context
 174      * @return generated type builder with all implemented types
 175      */
 176     static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
 177                           final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
 178         for (final UsesNode usesNode : dataNodeContainer.getUses()) {
 179             final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
 180             if (genType == null) {
 181                 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
 182                     + builder.getName());
 183             }
 184             builder.addImplementsType(genType);
 185         }
 186         return builder;
 187     }
 188
 189      static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 190         for (final ModuleContext ctx : genCtx.values()) {
 191             final GeneratedTypeBuilder result = ctx.getGrouping(path);
 192             if (result != null) {
 193                 return result;
 194             }
 195         }
 196         return null;
 197      }
 198
 199     /**
 200      * Adds the methods to <code>typeBuilder</code> which represent subnodes of
 201      * node for which <code>typeBuilder</code> was created.
 202      *
 203      * The subnodes aren't mapped to the methods if they are part of grouping or
 204      * augment (in this case are already part of them).
 205      *
 206      * @param module
 207      *            current module
 208      * @param basePackageName
 209      *            string contains the module package name
 210      * @param parent
 211      *            generated type builder which represents any node. The subnodes
 212      *            of this node are added to the <code>typeBuilder</code> as
 213      *            methods. The subnode can be of type leaf, leaf-list, list,
 214      *            container, choice.
 215      * @param childOf
 216      *            parent type
 217      * @param schemaNodes
 218      *            set of data schema nodes which are the children of the node
 219      *            for which <code>typeBuilder</code> was created
 220      * @return generated type builder which is the same builder as input
 221      *         parameter. The getter methods (representing child nodes) could be
 222      *         added to it.
 223      */
 224     static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
 225                           final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
 226                           final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
 227                           final SchemaContext schemaContext, final boolean verboseClassComments,
 228                           final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 229                           final TypeProvider typeProvider) {
 230
 231         if (schemaNodes != null && parent != null) {
 232             for (final DataSchemaNode schemaNode : schemaNodes) {
 233                 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
 234                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
 235                             schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 236                 }
 237             }
 238         }
 239         return parent;
 240     }
 241
 242     static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
 243             schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
 244             final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 245             final TypeProvider typeProvider) {
 246         return addDefaultInterfaceDefinition(packageName, schemaNode, null, module, genCtx, schemaContext,
 247                 verboseClassComments, genTypeBuilders, typeProvider);
 248     }
 249
 250     static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
 251                         DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
 252                         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 253                         final boolean verboseClassComments, final TypeProvider typeProvider) {
 254         final String basePackageName = BindingMapping.getRootPackageName(module);
 255         for (final UsesNode usesNode : node.getUses()) {
 256             for (final AugmentationSchema augment : usesNode.getAugmentations()) {
 257                 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName, augment, module,
 258                         usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider);
 259                 genCtx = processUsesAugments(schemaContext, augment, module, genCtx, genTypeBuilders,
 260                         verboseClassComments, typeProvider);
 261             }
 262         }
 263         return genCtx;
 264     }
 265
 266     static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 267         for (final ModuleContext ctx : genCtx.values()) {
 268             final GeneratedTypeBuilder result = ctx.getChildNode(path);
 269             if (result != null) {
 270                 return result;
 271             }
 272         }
 273         return null;
 274     }
 275
 276     static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 277         for (final ModuleContext ctx : genCtx.values()) {
 278             final GeneratedTypeBuilder result = ctx.getCase(path);
 279             if (result != null) {
 280                 return result;
 281             }
 282         }
 283         return null;
 284     }
 285
 286     /**
 287      * Returns a generated type builder for an augmentation.
 288      *
 289      * The name of the type builder is equal to the name of augmented node with
 290      * serial number as suffix.
 291      *
 292      * @param module
 293      *            current module
 294      * @param augmentPackageName
 295      *            string with contains the package name to which the augment
 296      *            belongs
 297      * @param basePackageName
 298      *            string with the package name to which the augmented node
 299      *            belongs
 300      * @param targetTypeRef
 301      *            target type
 302      * @param augSchema
 303      *            augmentation schema which contains data about the child nodes
 304      *            and uses of augment
 305      * @return generated type builder for augment in genCtx
 306      */
 307     static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
 308                 final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema,
 309                 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module,
 310                 ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments, final
 311                 TypeProvider typeProvider) {
 312
 313         Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(augmentPackageName, k -> new HashMap<>());
 314         String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
 315
 316         if (augIdentifier == null) {
 317             augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
 318         }
 319
 320         GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier);
 321
 322         augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
 323         augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
 324         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 325         annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
 326         augTypeBuilder = addImplementedInterfaceFromUses(augSchema, augTypeBuilder, genCtx);
 327
 328         augTypeBuilder = augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema
 329                 .getChildNodes(), genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders);
 330         augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
 331
 332         if(!augSchema.getChildNodes().isEmpty()) {
 333             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
 334
 335         }
 336         genCtx.get(module).addAugmentType(augTypeBuilder);
 337         return genCtx;
 338     }
 339
 340     /**
 341      * Adds the methods to <code>typeBuilder</code> what represents subnodes of
 342      * node for which <code>typeBuilder</code> was created.
 343      *
 344      * @param module
 345      *            current module
 346      * @param basePackageName
 347      *            string contains the module package name
 348      * @param typeBuilder
 349      *            generated type builder which represents any node. The subnodes
 350      *            of this node are added to the <code>typeBuilder</code> as
 351      *            methods. The subnode can be of type leaf, leaf-list, list,
 352      *            container, choice.
 353      * @param childOf
 354      *            parent type
 355      * @param schemaNodes
 356      *            set of data schema nodes which are the children of the node
 357      *            for which <code>typeBuilder</code> was created
 358      * @return generated type builder which is the same object as the input
 359      *         parameter <code>typeBuilder</code>. The getter method could be
 360      *         added to it.
 361      */
 362     private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
 363             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
 364             final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
 365             verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
 366             GeneratedTypeBuilder>> genTypeBuilders) {
 367         if (schemaNodes != null && typeBuilder != null) {
 368             for (final DataSchemaNode schemaNode : schemaNodes) {
 369                 if (!schemaNode.isAugmenting()) {
 370                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
 371                             schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 372                 }
 373             }
 374         }
 375         return typeBuilder;
 376     }
 377
 378     /**
 379      * Instantiates generated type builder with <code>packageName</code> and
 380      * <code>schemaNode</code>.
 381      *
 382      * The new builder always implements
 383      * {@link TreeNode TreeNode}.<br>
 384      * If <code>schemaNode</code> is instance of GroupingDefinition it also
 385      * implements {@link Augmentable
 386      * Augmentable}.<br>
 387      * If <code>schemaNode</code> is instance of
 388      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
 389      * DataNodeContainer} it can also implement nodes which are specified in
 390      * <i>uses</i>.
 391      *
 392      * @param packageName
 393      *            string with the name of the package to which
 394      *            <code>schemaNode</code> belongs.
 395      * @param schemaNode
 396      *            schema node for which is created generated type builder
 397      * @param parent
 398      *            parent type (can be null)
 399      * @param schemaContext schema context
 400      * @return generated type builder <code>schemaNode</code>
 401      */
 402     private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
 403             schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
 404             final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
 405             GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 406
 407         GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, schemaContext, "",
 408                 verboseClassComments, genTypeBuilders);
 409         if (parent == null) {
 410             it.addImplementsType(BindingTypes.TREE_NODE);
 411         } else {
 412             if (parent instanceof ListSchemaNode) {
 413                 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
 414                         (BindingTypes.IDENTIFIABLE_ITEM, parent)));
 415             } else {
 416                 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
 417                         (BindingTypes.ITEM, parent)));
 418                 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
 419             }
 420         }
 421
 422         if (!(schemaNode instanceof GroupingDefinition)) {
 423             it.addImplementsType(BindingTypes.augmentable(it));
 424         }
 425
 426         if (schemaNode instanceof DataNodeContainer) {
 427             groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
 428                     verboseClassComments, genTypeBuilders, typeProvider);
 429             it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
 430         }
 431
 432         return it;
 433     }
 434
 435     static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
 436             parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
 437             final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
 438             genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
 439
 440         processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
 441                 verboseClassComments, typeProvider);
 442
 443         final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
 444                 (basePackageName, notification, null, module, genCtx, schemaContext,
 445                         verboseClassComments, genTypeBuilders, typeProvider);
 446         annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
 447         notificationInterface.addImplementsType(NOTIFICATION);
 448         genCtx.get(module).addChildNodeType(notification, notificationInterface);
 449
 450         // Notification object
 451         resolveDataSchemaNodes(module, basePackageName, notificationInterface,
 452                 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
 453                 verboseClassComments, genTypeBuilders, typeProvider);
 454
 455         //in case of tied notification, incorporate parent's localName
 456         final StringBuilder sb = new StringBuilder("on_");
 457         if (parentName != null) {
 458             sb.append(parentName).append('_');
 459         }
 460         sb.append(notificationInterface.getName());
 461
 462         listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
 463                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
 464                 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
 465         return listenerInterface;
 466     }
 467
 468     /**
 469      * Returns reference to generated type builder for specified
 470      * <code>schemaNode</code> with <code>packageName</code>.
 471      *
 472      * Firstly the generated type builder is searched in
 473      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
 474      * found it is created and added to <code>genTypeBuilders</code>.
 475      *
 476      * @param packageName
 477      *            string with the package name to which returning generated type
 478      *            builder belongs
 479      * @param schemaNode
 480      *            schema node which provide data about the schema node name
 481      * @param schemaContext schema context
 482      * @param prefix
 483      *            return type name prefix
 484      * @return generated type builder for <code>schemaNode</code>
 485      * @throws IllegalArgumentException
 486      *             <ul>
 487      *             <li>if <code>schemaNode</code> is null</li>
 488      *             <li>if <code>packageName</code> is null</li>
 489      *             <li>if QName of schema node is null</li>
 490      *             <li>if schemaNode name is null</li>
 491      *             </ul>
 492      *
 493      */
 494     static GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
 495                        final SchemaContext schemaContext, final String prefix, final boolean verboseClassComments,
 496                        final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders) {
 497
 498         Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
 499         Preconditions.checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
 500         String schemaNodeName = schemaNode.getQName().getLocalName();
 501         Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
 502
 503         if (prefix != null && !prefix.isEmpty()) {
 504             // underscore used as separator for distinction of class name parts
 505             schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
 506         }
 507
 508         final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
 509         final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
 510         qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
 511         newType.addComment(schemaNode.getDescription());
 512         newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext, verboseClassComments));
 513         newType.setReference(schemaNode.getReference());
 514         newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
 515         newType.setModuleName(module.getName());
 516
 517         if (!genTypeBuilders.containsKey(packageName)) {
 518             final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
 519             builders.put(newType.getName(), newType);
 520             genTypeBuilders.put(packageName, builders);
 521         } else {
 522             final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
 523             if (!builders.containsKey(newType.getName())) {
 524                 builders.put(newType.getName(), newType);
 525             }
 526         }
 527         return newType;
 528
 529     }
 530
 531     private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
 532         final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
 533         final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
 534         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 535
 536         if (node != null && typeBuilder != null) {
 537             if (node instanceof ContainerSchemaNode) {
 538                 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
 539                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
 540             } else if (node instanceof LeafListSchemaNode) {
 541                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
 542                             typeProvider, genCtx);
 543             } else if (node instanceof LeafSchemaNode) {
 544                 resolveLeafSchemaNodeAsMethod(schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
 545                         typeProvider);
 546             } else if (node instanceof ListSchemaNode) {
 547                 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
 548                         verboseClassComments, genCtx, genTypeBuilders, typeProvider);
 549             } else if (node instanceof AnyXmlSchemaNode) {
 550                 resolveAnyxmlNodeAsMethod(schemaContext, typeBuilder, genCtx, (AnyXmlSchemaNode) node, module,
 551                         typeProvider);
 552             } else if (node instanceof ChoiceSchemaNode) {
 553                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
 554                         (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider);
 555             }
 556         }
 557     }
 558
 559     /**
 560      * Converts <code>choiceNode</code> to the list of generated types for
 561      * choice and its cases.
 562      *
 563      * The package names for choice and for its cases are created as
 564      * concatenation of the module package (<code>basePackageName</code>) and
 565      * names of all parents node.
 566      *
 567      * @param module
 568      *            current module
 569      * @param basePackageName
 570      *            string with the module package name
 571      * @param parent
 572      *            parent type
 573      * @param choiceNode
 574      *            choice node which is mapped to generated type. Also child
 575      *            nodes - cases are mapped to generated types.
 576      * @throws IllegalArgumentException
 577      *             <ul>
 578      *             <li>if <code>basePackageName</code> is null</li>
 579      *             <li>if <code>choiceNode</code> is null</li>
 580      *             </ul>
 581      */
 582     private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
 583             verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
 584             ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 585             final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider) {
 586         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
 587         checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
 588
 589         if (!choiceNode.isAddedByUses()) {
 590             final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath(),
 591                     BindingNamespaceType.Data);
 592             final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode,
 593                     schemaContext, "", verboseClasssComments, genTypeBuilders);
 594             constructGetter(parent, choiceNode.getQName().getLocalName(),
 595                     choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
 596             choiceTypeBuilder.addImplementsType(INSTANTIABLE);
 597             annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
 598             genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
 599             generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
 600                 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders);
 601         }
 602     }
 603
 604     private static void containerToGenType(final Module module, final String basePackageName,
 605         final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
 606         final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
 607         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 608
 609         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
 610                 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
 611         if (genType != null) {
 612             constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType, node.getStatus());
 613             resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
 614                     schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 615         }
 616     }
 617
 618     private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
 619             parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
 620             final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
 621             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 622         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
 623                 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
 624         if (genType != null) {
 625             final String nodeName = node.getQName().getLocalName();
 626             constructGetter(parent, nodeName, node.getDescription(),
 627                     Types.listTypeFor(genType), node.getStatus());
 628             final List<QName> listKeys = node.getKeyDefinition();
 629             final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
 630                     BindingNamespaceType.Key)).append('.').append(nodeName).toString();
 631
 632             final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
 633
 634             for (final DataSchemaNode schemaNode : node.getChildNodes()) {
 635                 if (!schemaNode.isAugmenting()) {
 636                     addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
 637                             module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments);
 638                 }
 639             }
 640
 641             // serialVersionUID
 642             if (genTOBuilder != null) {
 643                 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
 644                 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
 645                 genTOBuilder.setSUID(prop);
 646             }
 647
 648             typeBuildersToGenTypes(module, genType, genTOBuilder, genCtx);
 649         }
 650     }
 651
 652     private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
 653             final GeneratedTOBuilder genTOBuilder, final Map<Module, ModuleContext> genCtx) {
 654         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
 655         if (genTOBuilder != null) {
 656             final GeneratedTransferObject genTO = genTOBuilder.toInstance();
 657             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
 658             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
 659         }
 660     }
 661
 662     /**
 663      * Converts <code>leaf</code> to the getter method which is added to
 664      * <code>typeBuilder</code>.
 665      *
 666      * @param typeBuilder
 667      *            generated type builder to which is added getter method as
 668      *            <code>leaf</code> mapping
 669      * @param leaf
 670      *            leaf schema node which is mapped as getter method which is
 671      *            added to <code>typeBuilder</code>
 672      * @param module
 673      *            Module in which type was defined
 674      * @return boolean value
 675      *         <ul>
 676      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
 677      *         null</li>
 678      *         <li>true - in other cases</li>
 679      *         </ul>
 680      */
 681     private static Type resolveLeafSchemaNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
 682             typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf, final Module module,
 683             final TypeProvider typeProvider) {
 684         if (leaf == null || typeBuilder == null || leaf.isAddedByUses()) {
 685             return null;
 686         }
 687
 688         final String leafName = leaf.getQName().getLocalName();
 689         if (leafName == null) {
 690             return null;
 691         }
 692
 693         final Module parentModule = findParentModule(schemaContext, leaf);
 694         Type returnType = null;
 695
 696         final TypeDefinition<?> typeDef = leaf.getType();
 697         if (isInnerType(leaf, typeDef)) {
 698             if (typeDef instanceof EnumTypeDefinition) {
 699                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
 700                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
 701                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
 702                         genCtx, typeBuilder, module);
 703                 if (enumBuilder != null) {
 704                     returnType = enumBuilder.toInstance(typeBuilder);
 705                 }
 706                 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
 707             } else if (typeDef instanceof UnionTypeDefinition) {
 708                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
 709                         typeProvider, schemaContext);
 710                 if (genTOBuilder != null) {
 711                     //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
 712                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
 713                 }
 714             } else if (typeDef instanceof BitsTypeDefinition) {
 715                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
 716                         typeProvider, schemaContext);
 717                 if (genTOBuilder != null) {
 718                     returnType = genTOBuilder.toInstance();
 719                 }
 720             } else {
 721                 // It is constrained version of already declared type (inner declared type exists,
 722                 // onlyfor special cases (Enum, Union, Bits), which were already checked.
 723                 // In order to get proper class we need to look up closest derived type
 724                 // and apply restrictions from leaf type
 725                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 726                 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
 727                         restrictions);
 728             }
 729         } else {
 730             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 731             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
 732         }
 733
 734         if (returnType == null) {
 735             return null;
 736         }
 737
 738         if (typeDef instanceof EnumTypeDefinition) {
 739             ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
 740         }
 741
 742         String leafDesc = leaf.getDescription();
 743         if (leafDesc == null) {
 744             leafDesc = "";
 745         }
 746
 747         constructGetter(typeBuilder, leafName, leafDesc, returnType, leaf.getStatus());
 748         return returnType;
 749     }
 750
 751     /**
 752      * Converts <code>node</code> leaf list schema node to getter method of
 753      * <code>typeBuilder</code>.
 754      *
 755      * @param typeBuilder
 756      *            generated type builder to which is <code>node</code> added as
 757      *            getter method
 758      * @param node
 759      *            leaf list schema node which is added to
 760      *            <code>typeBuilder</code> as getter method
 761      * @param module module
 762      * @param typeProvider type provider instance
 763      * @param genCtx actual generated context
 764      * @param genCtx actual generated context
 765      * @return boolean value
 766      *         <ul>
 767      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,
 768      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>
 769      *         <li>false - other cases</li>
 770      *         </ul>
 771      */
 772     private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
 773             typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
 774             final Map<Module, ModuleContext> genCtx) {
 775         if (node == null || typeBuilder == null || node.isAddedByUses()) {
 776             return false;
 777         }
 778
 779         final QName nodeName = node.getQName();
 780
 781         final TypeDefinition<?> typeDef = node.getType();
 782         final Module parentModule = findParentModule(schemaContext, node);
 783
 784         Type returnType = null;
 785         if (typeDef.getBaseType() == null) {
 786             if (typeDef instanceof EnumTypeDefinition) {
 787                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
 788                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
 789                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
 790                         genCtx, typeBuilder, module);
 791                 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
 792                 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
 793             } else if (typeDef instanceof UnionTypeDefinition) {
 794                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
 795                         typeProvider, schemaContext);
 796                 if (genTOBuilder != null) {
 797                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
 798                 }
 799             } else if (typeDef instanceof BitsTypeDefinition) {
 800                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
 801                         typeProvider, schemaContext);
 802                 returnType = genTOBuilder.toInstance();
 803             } else {
 804                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 805                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
 806             }
 807         } else {
 808             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 809             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
 810         }
 811
 812         final ParameterizedType listType = Types.listTypeFor(returnType);
 813         constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
 814         return true;
 815     }
 816
 817     /**
 818      * Converts <code>caseNodes</code> set to list of corresponding generated
 819      * types.
 820      *
 821      * For every <i>case</i> which isn't added through augment or <i>uses</i> is
 822      * created generated type builder. The package names for the builder is
 823      * created as concatenation of the module package (
 824      * <code>basePackageName</code>) and names of all parents nodes of the
 825      * concrete <i>case</i>. There is also relation "<i>implements type</i>"
 826      * between every case builder and <i>choice</i> type
 827      *
 828      * @param module
 829      *            current module
 830      * @param schemaContext
 831      *            current schema context
 832      * @param genCtx
 833      *            actual generated context
 834      * @param basePackageName
 835      *            string with the module package name
 836      * @param refChoiceType
 837      *            type which represents superior <i>case</i>
 838      * @param choiceNode
 839      *            choice case node which is mapped to generated type
 840      * @param verboseClassComments
 841      *            Javadoc verbosity switch
 842      * @throws IllegalArgumentException
 843      *             <ul>
 844      *             <li>if <code>basePackageName</code> equals null</li>
 845      *             <li>if <code>refChoiceType</code> equals null</li>
 846      *             <li>if <code>caseNodes</code> equals null</li>
 847      *             </ul>
 848      */
 849     private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
 850             final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
 851             final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
 852             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders) {
 853         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
 854         checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
 855         checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
 856
 857         final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
 858         if (caseNodes == null) {
 859             return;
 860         }
 861
 862         for (final ChoiceCaseNode caseNode : caseNodes) {
 863             if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
 864                 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath(),
 865                     BindingNamespaceType.Data);
 866                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode,
 867                     module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 868                 caseTypeBuilder.addImplementsType(refChoiceType);
 869                 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
 870                 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
 871                 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
 872                 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
 873                 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
 874                 if (caseChildNodes != null) {
 875                     final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
 876
 877                     if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
 878                         SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
 879
 880                         if (parent instanceof AugmentationSchema) {
 881                             final AugmentationSchema augSchema = (AugmentationSchema) parent;
 882                             final SchemaPath targetPath = augSchema.getTargetPath();
 883                             SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
 884                             if (targetSchemaNode instanceof DataSchemaNode
 885                                     && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
 886                                 if (targetSchemaNode instanceof DerivableSchemaNode) {
 887                                     targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
 888                                 }
 889                                 if (targetSchemaNode == null) {
 890                                     throw new IllegalStateException(
 891                                             "Failed to find target node from grouping for augmentation " + augSchema
 892                                                     + " in module " + module.getName());
 893                                 }
 894                             }
 895                             parent = targetSchemaNode;
 896                         }
 897
 898                         Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
 899                                 choiceNodeParentPath);
 900                         GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
 901                         if (childOfType == null) {
 902                             childOfType = findGroupingByPath(parent.getPath(), genCtx);
 903                         }
 904                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
 905                                 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 906                     } else {
 907                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
 908                                 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
 909                                 verboseClassComments, genTypeBuilders, typeProvider);
 910                     }
 911                 }
 912             }
 913             processUsesAugments(schemaContext, caseNode, module, genCtx, genTypeBuilders, verboseClassComments,
 914                     typeProvider);
 915         }
 916     }
 917
 918     private static Type resolveAnyxmlNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
 919             typeBuilder, final Map<Module, ModuleContext> genCtx, final AnyXmlSchemaNode anyxml, final Module module,
 920             final TypeProvider typeProvider) {
 921
 922         final String anyxmlName = anyxml.getQName().getLocalName();
 923         if (anyxmlName == null) {
 924             return null;
 925         }
 926
 927         String anyxmlDesc = anyxml.getDescription();
 928         if (anyxmlDesc == null) {
 929             anyxmlDesc = "";
 930         }
 931
 932         Type returnType = Types.DOCUMENT;
 933
 934         constructGetter(typeBuilder, anyxmlName, anyxmlDesc, returnType, anyxml.getStatus());
 935         return returnType;
 936     }
 937
 938
 939     /**
 940      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
 941      * or to <code>genTOBuilder</code> as property.
 942      *
 943      * @param nodeName
 944      *            string contains the name of list
 945      * @param basePackageName
 946      *            string contains the module package name
 947      * @param schemaNode
 948      *            data schema node which should be added as getter method to
 949      *            <code>typeBuilder</code> or as a property to
 950      *            <code>genTOBuilder</code> if is part of the list key
 951      * @param typeBuilder
 952      *            generated type builder for the list schema node
 953      * @param genTOBuilder
 954      *            generated TO builder for the list keys
 955      * @param listKeys
 956      *            list of string which contains QNames of the list keys
 957      * @param module
 958      *            current module
 959      * @param typeProvider
 960      *            provider that defines contract for generated types
 961      * @param schemaContext
 962      *            schema context
 963      * @param genCtx
 964      *            map of generated entities in context of YANG modules
 965      * @param genTypeBuilders
 966      *            map of generated type builders
 967      * @param verboseClassComments
 968      *            generate verbose comments
 969      * @throws IllegalArgumentException
 970      *             <ul>
 971      *             <li>if <code>schemaNode</code> equals null</li>
 972      *             <li>if <code>typeBuilder</code> equals null</li>
 973      *             </ul>
 974      */
 975     private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
 976             final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
 977             final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
 978             final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
 979             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments) {
 980         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
 981         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
 982
 983         if (schemaNode instanceof LeafSchemaNode) {
 984             final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
 985             final QName leafQName = leaf.getQName();
 986             final String leafName = leafQName.getLocalName();
 987             String leafPckgName = basePackageName;
 988             boolean isKeyPart = false;
 989             if (listKeys.contains(leafQName)) {
 990                 leafPckgName = new StringBuilder(leafPckgName).append('.').append(BindingNamespaceType.Key).append('.')
 991                         .append(nodeName).toString();
 992                 isKeyPart = true;
 993             } else {
 994                 leafPckgName = new StringBuilder(leafPckgName).append('.').append(BindingNamespaceType.Data).append('.')
 995                         .append(nodeName).toString();
 996             }
 997
 998             final String leafGTOName = new StringBuilder(nodeName).append('_').append(leafName).toString();
 999             final GeneratedTypeBuilder leafGTp = new GeneratedTypeBuilderImpl(leafPckgName, leafGTOName);
1000             resolveLeafSchemaNodeAsMethod(schemaContext, leafGTp, genCtx, leaf, module,
1001                     typeProvider);
1002
1003             constructGetter(typeBuilder, leafGTOName, schemaNode.getDescription(), leafGTp, Status.CURRENT);
1004
1005             if (isKeyPart) {
1006                 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, leafGTp, true);
1007             }
1008         } else if (!schemaNode.isAddedByUses()) {
1009             if (schemaNode instanceof LeafListSchemaNode) {
1010                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1011                         typeProvider, genCtx);
1012             } else if (schemaNode instanceof ContainerSchemaNode) {
1013                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1014                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
1015             } else if (schemaNode instanceof ListSchemaNode) {
1016                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1017                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
1018             } else if (schemaNode instanceof ChoiceSchemaNode) {
1019                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1020                         (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider);
1021             }
1022         }
1023     }
1024
1025     private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1026         final TypeDefinition<?> baseType = typeDef.getBaseType();
1027         return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1028     }
1029
1030     @SuppressWarnings({ "rawtypes", "unchecked" })
1031     private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1032         final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1033         final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1034         GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1035
1036         if (node.isAugmenting() || node.isAddedByUses()) {
1037             return null;
1038         }
1039         final String packageName = packageNameForGeneratedType(basePackageName, node.getPath(), BindingNamespaceType.Data);
1040         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module,
1041                 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1042         genType.addComment(node.getDescription());
1043         annotateDeprecatedIfNecessary(node.getStatus(), genType);
1044         genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext, verboseClassComments));
1045         genType.setModuleName(module.getName());
1046         genType.setReference(node.getReference());
1047         genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1048         genType.setParentTypeForBuilder(childOf);
1049         if (node instanceof DataNodeContainer) {
1050             genCtx.get(module).addChildNodeType(node, genType);
1051             genCtx = groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings(), genCtx, schemaContext,
1052                     verboseClassComments, genTypeBuilders, typeProvider);
1053             processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
1054                     verboseClassComments, typeProvider);
1055         }
1056         return genType;
1057     }
1058
1059     /**
1060      * Converts all <b>groupings</b> of the module to the list of
1061      * <code>Type</code> objects. Firstly are groupings sorted according mutual
1062      * dependencies. At least dependent (independent) groupings are in the list
1063      * saved at first positions. For every grouping the record is added to map
1064      * {@link ModuleContext#groupings allGroupings}
1065      *
1066      * @param module
1067      *            current module
1068      * @param groupings
1069      *            collection of groupings from which types will be generated
1070      * @param typeProvider
1071      *            provider that defines contract for generated types
1072      * @param schemaContext
1073      *            schema context
1074      * @param genCtx
1075      *            map of generated entities in context of YANG modules
1076      * @param genTypeBuilders
1077      *            map of generated type builders
1078      * @param verboseClassComments
1079      *            generate verbose comments
1080      *
1081      */
1082     static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1083             groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1084             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1085         final String basePackageName = BindingMapping.getRootPackageName(module);
1086         final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1087                 .sort(groupings);
1088         for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1089             genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1090                     verboseClassComments, genTypeBuilders, typeProvider);
1091         }
1092         return genCtx;
1093     }
1094
1095     /**
1096      * Converts individual grouping to GeneratedType. Firstly generated type
1097      * builder is created and every child node of grouping is resolved to the
1098      * method.
1099      *
1100      * @param basePackageName
1101      *            string contains the module package name
1102      * @param grouping
1103      *            GroupingDefinition which contains data about grouping
1104      * @param module
1105      *            current module
1106      * @param typeProvider
1107      *            provider that defines contract for generated types
1108      * @param schemaContext
1109      *            schema context
1110      * @param genCtx
1111      *            map of generated entities in context of YANG modules
1112      * @param genTypeBuilders
1113      *            map of generated type builders
1114      * @param verboseClassComments
1115      *            generate verbose comments
1116      *
1117      * @return GeneratedType which is generated from grouping (object of type
1118      *         <code>GroupingDefinition</code>)
1119      */
1120     private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1121             module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1122             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1123         final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath(), BindingNamespaceType.Grouping);
1124         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module, genCtx,
1125                 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1126         annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1127         genCtx.get(module).addGroupingType(grouping.getPath(), genType);
1128         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1129                 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1130         genCtx = groupingsToGenTypes(module, grouping.getGroupings(), genCtx, schemaContext, verboseClassComments,
1131                 genTypeBuilders, typeProvider);
1132         genCtx = processUsesAugments(schemaContext, grouping, module, genCtx, genTypeBuilders, verboseClassComments,
1133                 typeProvider);
1134         return genCtx;
1135     }
1136
1137     /**
1138      * //TODO: add information about multiple base identities in YANG 1.1
1139      * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1140      * created transport object builder. If identity contains base identity then
1141      * reference to base identity is added to superior identity as its extend.
1142      * If identity doesn't contain base identity then only reference to abstract
1143      * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1144      * BaseIdentity} is added
1145      *
1146      * @param module
1147      *            current module
1148      * @param basePackageName
1149      *            string contains the module package name
1150      * @param identity
1151      *            IdentitySchemaNode which contains data about identity
1152      * @param schemaContext
1153      *            SchemaContext which is used to get package and name
1154      *            information about base of identity
1155      * @param genCtx generated context
1156      * @return returns generated context
1157      */
1158     static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1159             final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1160             boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
1161             final TypeProvider typeProvider, Map<QName, GeneratedTOBuilderImpl> generatedIdentities) {
1162
1163         final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1164             BindingNamespaceType.Identity);
1165         final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName,
1166                 identity.getQName().getLocalName());
1167
1168         final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1169         if (baseIdentities.size() == 0) {
1170             //no base - abstract
1171             final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1172                 BaseIdentity.class.getSimpleName());
1173             newType.setExtendsType(gto.toInstance());
1174             generatedIdentities.put(identity.getQName(), newType);
1175         } else {
1176             //one base - inheritance
1177             final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1178             final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(schemaContext, baseIdentity);
1179             final String returnTypePkgName = new StringBuilder(BindingMapping.getRootPackageName
1180                     (baseIdentityParentModule))
1181                     .append('.')
1182                     .append(BindingNamespaceType.Identity.getPackagePrefix())
1183                     .toString();
1184
1185             final GeneratedTOBuilderImpl existingIdentityGto = generatedIdentities.get(baseIdentity.getQName());
1186             if (existingIdentityGto != null) {
1187                 newType.setExtendsType(existingIdentityGto.toInstance());
1188             } else {
1189                 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(returnTypePkgName,
1190                         baseIdentity.getQName().getLocalName());
1191                 newType.setExtendsType(gto.toInstance());
1192                 generatedIdentities.put(baseIdentity.getQName(), gto);
1193             }
1194
1195             //FIXME: more bases - possible composition, multiple inheritance not possible
1196         }
1197         generatedIdentities.put(identity.getQName(), newType);
1198
1199         newType.setAbstract(true);
1200         newType.addComment(identity.getDescription());
1201         newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1202                 verboseClassComments));
1203         newType.setReference(identity.getReference());
1204         newType.setModuleName(module.getName());
1205         newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1206
1207         qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1208
1209         genCtx.get(module).addIdentityType(identity.getQName(), newType);
1210         return genCtx;
1211     }
1212 }