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.AnyDataSchemaNode;
  69 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  70 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  71 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  72 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  73 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  74 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  75 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  76 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  77 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  78 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  79 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  80 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  81 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  82 import org.opendaylight.yangtools.yang.model.api.Module;
  83 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  84 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  85 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  86 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  87 import org.opendaylight.yangtools.yang.model.api.Status;
  88 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  89 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  90 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  91 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  92 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  93 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  94
  95 /**
  96  * Helper util class used for generation of types in Binding spec v2.
  97  */
  98 @Beta
  99 final class GenHelperUtil {
 100
 101     private GenHelperUtil() {
 102         throw new UnsupportedOperationException("Util class");
 103     }
 104
 105     /**
 106      * Create GeneratedTypeBuilder object from module argument.
 107      *
 108      * @param module
 109      *            Module object from which builder will be created
 110      * @param genCtx
 111      * @param verboseClassComments
 112      *
 113      * @return <code>GeneratedTypeBuilder</code> which is internal
 114      *         representation of the module
 115      * @throws IllegalArgumentException
 116      *             if module is null
 117      */
 118     static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
 119         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
 120
 121         final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments);
 122         addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
 123         moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
 124         moduleDataTypeBuilder.addComment(module.getDescription());
 125         moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
 126         moduleDataTypeBuilder.setReference(module.getReference());
 127         return moduleDataTypeBuilder;
 128     }
 129
 130     /**
 131      * Generates type builder for <code>module</code>.
 132      *
 133      * @param module
 134      *            Module which is source of package name for generated type
 135      *            builder
 136      * @param postfix
 137      *            string which is added to the module class name representation
 138      *            as suffix
 139      * @param verboseClassComments
 140      * @return instance of GeneratedTypeBuilder which represents
 141      *         <code>module</code>.
 142      * @throws IllegalArgumentException
 143      *             if <code>module</code> is null
 144      */
 145     static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
 146             verboseClassComments) {
 147         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
 148         final String packageName = BindingMapping.getRootPackageName(module);
 149         // underscore used as separator for distinction of module name parts
 150         final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
 151
 152         final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
 153         moduleBuilder.setDescription(createDescription(module, verboseClassComments));
 154         moduleBuilder.setReference(module.getReference());
 155         moduleBuilder.setModuleName(moduleName);
 156
 157         return moduleBuilder;
 158     }
 159
 160     /**
 161      * Adds the implemented types to type builder.
 162      *
 163      * The method passes through the list of <i>uses</i> in
 164      * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
 165      * generated type from all groupings
 166      * allGroupings} which is added as <i>implements type</i> to
 167      * <code>builder</code>
 168      *
 169      * @param dataNodeContainer
 170      *            element which contains the list of used YANG groupings
 171      * @param builder
 172      *            builder to which are added implemented types according to
 173      *            <code>dataNodeContainer</code>
 174      * @param genCtx generated context
 175      * @return generated type builder with all implemented types
 176      */
 177     static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
 178                           final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
 179         for (final UsesNode usesNode : dataNodeContainer.getUses()) {
 180             final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
 181             if (genType == null) {
 182                 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
 183                     + builder.getName());
 184             }
 185             builder.addImplementsType(genType);
 186         }
 187         return builder;
 188     }
 189
 190      static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 191         for (final ModuleContext ctx : genCtx.values()) {
 192             final GeneratedTypeBuilder result = ctx.getGrouping(path);
 193             if (result != null) {
 194                 return result;
 195             }
 196         }
 197         return null;
 198      }
 199
 200     /**
 201      * Adds the methods to <code>typeBuilder</code> which represent subnodes of
 202      * node for which <code>typeBuilder</code> was created.
 203      *
 204      * The subnodes aren't mapped to the methods if they are part of grouping or
 205      * augment (in this case are already part of them).
 206      *
 207      * @param module
 208      *            current module
 209      * @param basePackageName
 210      *            string contains the module package name
 211      * @param parent
 212      *            generated type builder which represents any node. The subnodes
 213      *            of this node are added to the <code>typeBuilder</code> as
 214      *            methods. The subnode can be of type leaf, leaf-list, list,
 215      *            container, choice.
 216      * @param childOf
 217      *            parent type
 218      * @param schemaNodes
 219      *            set of data schema nodes which are the children of the node
 220      *            for which <code>typeBuilder</code> was created
 221      * @return generated type builder which is the same builder as input
 222      *         parameter. The getter methods (representing child nodes) could be
 223      *         added to it.
 224      */
 225     static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
 226                           final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
 227                           final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
 228                           final SchemaContext schemaContext, final boolean verboseClassComments,
 229                           final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 230                           final TypeProvider typeProvider) {
 231
 232         if (schemaNodes != null && parent != null) {
 233             for (final DataSchemaNode schemaNode : schemaNodes) {
 234                 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
 235                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
 236                             schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 237                 }
 238             }
 239         }
 240         return parent;
 241     }
 242
 243     static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
 244             schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
 245             final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 246             final TypeProvider typeProvider) {
 247         return addDefaultInterfaceDefinition(packageName, schemaNode, null, module, genCtx, schemaContext,
 248                 verboseClassComments, genTypeBuilders, typeProvider);
 249     }
 250
 251     static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
 252                         DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
 253                         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 254                         final boolean verboseClassComments, final TypeProvider typeProvider) {
 255         final String basePackageName = BindingMapping.getRootPackageName(module);
 256         for (final UsesNode usesNode : node.getUses()) {
 257             for (final AugmentationSchema augment : usesNode.getAugmentations()) {
 258                 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName, augment, module,
 259                         usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider);
 260                 genCtx = processUsesAugments(schemaContext, augment, module, genCtx, genTypeBuilders,
 261                         verboseClassComments, typeProvider);
 262             }
 263         }
 264         return genCtx;
 265     }
 266
 267     static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 268         for (final ModuleContext ctx : genCtx.values()) {
 269             final GeneratedTypeBuilder result = ctx.getChildNode(path);
 270             if (result != null) {
 271                 return result;
 272             }
 273         }
 274         return null;
 275     }
 276
 277     static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 278         for (final ModuleContext ctx : genCtx.values()) {
 279             final GeneratedTypeBuilder result = ctx.getCase(path);
 280             if (result != null) {
 281                 return result;
 282             }
 283         }
 284         return null;
 285     }
 286
 287     /**
 288      * Returns a generated type builder for an augmentation.
 289      *
 290      * The name of the type builder is equal to the name of augmented node with
 291      * serial number as suffix.
 292      *
 293      * @param module
 294      *            current module
 295      * @param augmentPackageName
 296      *            string with contains the package name to which the augment
 297      *            belongs
 298      * @param basePackageName
 299      *            string with the package name to which the augmented node
 300      *            belongs
 301      * @param targetTypeRef
 302      *            target type
 303      * @param augSchema
 304      *            augmentation schema which contains data about the child nodes
 305      *            and uses of augment
 306      * @return generated type builder for augment in genCtx
 307      */
 308     static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
 309                 final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema,
 310                 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module,
 311                 ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments, final
 312                 TypeProvider typeProvider) {
 313
 314         Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(augmentPackageName, k -> new HashMap<>());
 315         String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
 316
 317         if (augIdentifier == null) {
 318             augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
 319         }
 320
 321         GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier);
 322
 323         augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
 324         augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
 325         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 326         annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
 327         augTypeBuilder = addImplementedInterfaceFromUses(augSchema, augTypeBuilder, genCtx);
 328
 329         augTypeBuilder = augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema
 330                 .getChildNodes(), genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders);
 331         augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
 332
 333         if(!augSchema.getChildNodes().isEmpty()) {
 334             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
 335
 336         }
 337         genCtx.get(module).addAugmentType(augTypeBuilder);
 338         return genCtx;
 339     }
 340
 341     /**
 342      * Adds the methods to <code>typeBuilder</code> what represents subnodes of
 343      * node for which <code>typeBuilder</code> was created.
 344      *
 345      * @param module
 346      *            current module
 347      * @param basePackageName
 348      *            string contains the module package name
 349      * @param typeBuilder
 350      *            generated type builder which represents any node. The subnodes
 351      *            of this node are added to the <code>typeBuilder</code> as
 352      *            methods. The subnode can be of type leaf, leaf-list, list,
 353      *            container, choice.
 354      * @param childOf
 355      *            parent type
 356      * @param schemaNodes
 357      *            set of data schema nodes which are the children of the node
 358      *            for which <code>typeBuilder</code> was created
 359      * @return generated type builder which is the same object as the input
 360      *         parameter <code>typeBuilder</code>. The getter method could be
 361      *         added to it.
 362      */
 363     private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
 364             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
 365             final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
 366             verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
 367             GeneratedTypeBuilder>> genTypeBuilders) {
 368         if (schemaNodes != null && typeBuilder != null) {
 369             for (final DataSchemaNode schemaNode : schemaNodes) {
 370                 if (!schemaNode.isAugmenting()) {
 371                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
 372                             schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 373                 }
 374             }
 375         }
 376         return typeBuilder;
 377     }
 378
 379     /**
 380      * Instantiates generated type builder with <code>packageName</code> and
 381      * <code>schemaNode</code>.
 382      *
 383      * The new builder always implements
 384      * {@link TreeNode TreeNode}.<br>
 385      * If <code>schemaNode</code> is instance of GroupingDefinition it also
 386      * implements {@link Augmentable
 387      * Augmentable}.<br>
 388      * If <code>schemaNode</code> is instance of
 389      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
 390      * DataNodeContainer} it can also implement nodes which are specified in
 391      * <i>uses</i>.
 392      *
 393      * @param packageName
 394      *            string with the name of the package to which
 395      *            <code>schemaNode</code> belongs.
 396      * @param schemaNode
 397      *            schema node for which is created generated type builder
 398      * @param parent
 399      *            parent type (can be null)
 400      * @param schemaContext schema context
 401      * @return generated type builder <code>schemaNode</code>
 402      */
 403     private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
 404             schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
 405             final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
 406             GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 407
 408         GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, schemaContext, "",
 409                 verboseClassComments, genTypeBuilders);
 410         if (parent == null) {
 411             it.addImplementsType(BindingTypes.TREE_NODE);
 412         } else {
 413             if (parent instanceof ListSchemaNode) {
 414                 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
 415                         (BindingTypes.IDENTIFIABLE_ITEM, parent)));
 416             } else {
 417                 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
 418                         (BindingTypes.ITEM, parent)));
 419                 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
 420             }
 421         }
 422
 423         if (!(schemaNode instanceof GroupingDefinition)) {
 424             it.addImplementsType(BindingTypes.augmentable(it));
 425         }
 426
 427         if (schemaNode instanceof DataNodeContainer) {
 428             groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
 429                     verboseClassComments, genTypeBuilders, typeProvider);
 430             it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
 431         }
 432
 433         return it;
 434     }
 435
 436     static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
 437             parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
 438             final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
 439             genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
 440
 441         processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
 442                 verboseClassComments, typeProvider);
 443
 444         final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
 445                 (basePackageName, notification, null, module, genCtx, schemaContext,
 446                         verboseClassComments, genTypeBuilders, typeProvider);
 447         annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
 448         notificationInterface.addImplementsType(NOTIFICATION);
 449         genCtx.get(module).addChildNodeType(notification, notificationInterface);
 450
 451         // Notification object
 452         resolveDataSchemaNodes(module, basePackageName, notificationInterface,
 453                 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
 454                 verboseClassComments, genTypeBuilders, typeProvider);
 455
 456         //in case of tied notification, incorporate parent's localName
 457         final StringBuilder sb = new StringBuilder("on_");
 458         if (parentName != null) {
 459             sb.append(parentName).append('_');
 460         }
 461         sb.append(notificationInterface.getName());
 462
 463         listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
 464                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
 465                 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
 466         return listenerInterface;
 467     }
 468
 469     /**
 470      * Returns reference to generated type builder for specified
 471      * <code>schemaNode</code> with <code>packageName</code>.
 472      *
 473      * Firstly the generated type builder is searched in
 474      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
 475      * found it is created and added to <code>genTypeBuilders</code>.
 476      *
 477      * @param packageName
 478      *            string with the package name to which returning generated type
 479      *            builder belongs
 480      * @param schemaNode
 481      *            schema node which provide data about the schema node name
 482      * @param schemaContext schema context
 483      * @param prefix
 484      *            return type name prefix
 485      * @return generated type builder for <code>schemaNode</code>
 486      * @throws IllegalArgumentException
 487      *             <ul>
 488      *             <li>if <code>schemaNode</code> is null</li>
 489      *             <li>if <code>packageName</code> is null</li>
 490      *             <li>if QName of schema node is null</li>
 491      *             <li>if schemaNode name is null</li>
 492      *             </ul>
 493      *
 494      */
 495     static GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
 496                        final SchemaContext schemaContext, final String prefix, final boolean verboseClassComments,
 497                        final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders) {
 498
 499         Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
 500         Preconditions.checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
 501         String schemaNodeName = schemaNode.getQName().getLocalName();
 502         Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
 503
 504         if (prefix != null && !prefix.isEmpty()) {
 505             // underscore used as separator for distinction of class name parts
 506             schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
 507         }
 508
 509         final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
 510         final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
 511         qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
 512         newType.addComment(schemaNode.getDescription());
 513         newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext, verboseClassComments));
 514         newType.setReference(schemaNode.getReference());
 515         newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
 516         newType.setModuleName(module.getName());
 517
 518         if (!genTypeBuilders.containsKey(packageName)) {
 519             final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
 520             builders.put(newType.getName(), newType);
 521             genTypeBuilders.put(packageName, builders);
 522         } else {
 523             final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
 524             if (!builders.containsKey(newType.getName())) {
 525                 builders.put(newType.getName(), newType);
 526             }
 527         }
 528         return newType;
 529
 530     }
 531
 532     private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
 533         final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
 534         final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
 535         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 536
 537         if (node != null && typeBuilder != null) {
 538             if (node instanceof ContainerSchemaNode) {
 539                 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
 540                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
 541             } else if (node instanceof LeafListSchemaNode) {
 542                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
 543                             typeProvider, genCtx);
 544             } else if (node instanceof LeafSchemaNode) {
 545                 resolveLeafSchemaNodeAsMethod(schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
 546                         typeProvider);
 547             } else if (node instanceof ListSchemaNode) {
 548                 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
 549                         verboseClassComments, genCtx, genTypeBuilders, typeProvider);
 550             } else if (node instanceof ChoiceSchemaNode) {
 551                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
 552                         (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider);
 553             } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
 554                 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, 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 resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
 919             typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
 920             final TypeProvider typeProvider) {
 921
 922         final String anyName = node.getQName().getLocalName();
 923         if (anyName == null) {
 924             return null;
 925         }
 926
 927         String anyDesc = node.getDescription();
 928         if (anyDesc == null) {
 929             anyDesc = "";
 930         }
 931
 932         Type returnType = Types.DOCUMENT;
 933
 934         constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
 935         return returnType;
 936     }
 937
 938     /**
 939      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
 940      * or to <code>genTOBuilder</code> as property.
 941      *
 942      * @param nodeName
 943      *            string contains the name of list
 944      * @param basePackageName
 945      *            string contains the module package name
 946      * @param schemaNode
 947      *            data schema node which should be added as getter method to
 948      *            <code>typeBuilder</code> or as a property to
 949      *            <code>genTOBuilder</code> if is part of the list key
 950      * @param typeBuilder
 951      *            generated type builder for the list schema node
 952      * @param genTOBuilder
 953      *            generated TO builder for the list keys
 954      * @param listKeys
 955      *            list of string which contains QNames of the list keys
 956      * @param module
 957      *            current module
 958      * @param typeProvider
 959      *            provider that defines contract for generated types
 960      * @param schemaContext
 961      *            schema context
 962      * @param genCtx
 963      *            map of generated entities in context of YANG modules
 964      * @param genTypeBuilders
 965      *            map of generated type builders
 966      * @param verboseClassComments
 967      *            generate verbose comments
 968      * @throws IllegalArgumentException
 969      *             <ul>
 970      *             <li>if <code>schemaNode</code> equals null</li>
 971      *             <li>if <code>typeBuilder</code> equals null</li>
 972      *             </ul>
 973      */
 974     private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
 975             final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
 976             final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
 977             final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
 978             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments) {
 979         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
 980         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
 981
 982         if (schemaNode instanceof LeafSchemaNode) {
 983             final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
 984             final QName leafQName = leaf.getQName();
 985             final String leafName = leafQName.getLocalName();
 986             String leafPckgName = basePackageName;
 987             boolean isKeyPart = false;
 988             if (listKeys.contains(leafQName)) {
 989                 leafPckgName = new StringBuilder(leafPckgName).append('.').append(BindingNamespaceType.Key).append('.')
 990                         .append(nodeName).toString();
 991                 isKeyPart = true;
 992             } else {
 993                 leafPckgName = new StringBuilder(leafPckgName).append('.').append(BindingNamespaceType.Data).append('.')
 994                         .append(nodeName).toString();
 995             }
 996
 997             final String leafGTOName = new StringBuilder(nodeName).append('_').append(leafName).toString();
 998             final GeneratedTypeBuilder leafGTp = new GeneratedTypeBuilderImpl(leafPckgName, leafGTOName);
 999             resolveLeafSchemaNodeAsMethod(schemaContext, leafGTp, genCtx, leaf, module,
1000                     typeProvider);
1001
1002             constructGetter(typeBuilder, leafGTOName, schemaNode.getDescription(), leafGTp, Status.CURRENT);
1003
1004             if (isKeyPart) {
1005                 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, leafGTp, true);
1006             }
1007         } else if (!schemaNode.isAddedByUses()) {
1008             if (schemaNode instanceof LeafListSchemaNode) {
1009                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1010                         typeProvider, genCtx);
1011             } else if (schemaNode instanceof ContainerSchemaNode) {
1012                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1013                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
1014             } else if (schemaNode instanceof ListSchemaNode) {
1015                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1016                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
1017             } else if (schemaNode instanceof ChoiceSchemaNode) {
1018                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1019                         (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider);
1020             }
1021         }
1022     }
1023
1024     private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1025         final TypeDefinition<?> baseType = typeDef.getBaseType();
1026         return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1027     }
1028
1029     @SuppressWarnings({ "rawtypes", "unchecked" })
1030     private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1031         final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1032         final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1033         GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1034
1035         if (node.isAugmenting() || node.isAddedByUses()) {
1036             return null;
1037         }
1038         final String packageName = packageNameForGeneratedType(basePackageName, node.getPath(), BindingNamespaceType.Data);
1039         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module,
1040                 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1041         genType.addComment(node.getDescription());
1042         annotateDeprecatedIfNecessary(node.getStatus(), genType);
1043         genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext, verboseClassComments));
1044         genType.setModuleName(module.getName());
1045         genType.setReference(node.getReference());
1046         genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1047         genType.setParentTypeForBuilder(childOf);
1048         if (node instanceof DataNodeContainer) {
1049             genCtx.get(module).addChildNodeType(node, genType);
1050             genCtx = groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings(), genCtx, schemaContext,
1051                     verboseClassComments, genTypeBuilders, typeProvider);
1052             processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
1053                     verboseClassComments, typeProvider);
1054         }
1055         return genType;
1056     }
1057
1058     /**
1059      * Converts all <b>groupings</b> of the module to the list of
1060      * <code>Type</code> objects. Firstly are groupings sorted according mutual
1061      * dependencies. At least dependent (independent) groupings are in the list
1062      * saved at first positions. For every grouping the record is added to map
1063      * {@link ModuleContext#groupings allGroupings}
1064      *
1065      * @param module
1066      *            current module
1067      * @param groupings
1068      *            collection of groupings from which types will be generated
1069      * @param typeProvider
1070      *            provider that defines contract for generated types
1071      * @param schemaContext
1072      *            schema context
1073      * @param genCtx
1074      *            map of generated entities in context of YANG modules
1075      * @param genTypeBuilders
1076      *            map of generated type builders
1077      * @param verboseClassComments
1078      *            generate verbose comments
1079      *
1080      */
1081     static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1082             groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1083             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1084         final String basePackageName = BindingMapping.getRootPackageName(module);
1085         final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1086                 .sort(groupings);
1087         for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1088             genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1089                     verboseClassComments, genTypeBuilders, typeProvider);
1090         }
1091         return genCtx;
1092     }
1093
1094     /**
1095      * Converts individual grouping to GeneratedType. Firstly generated type
1096      * builder is created and every child node of grouping is resolved to the
1097      * method.
1098      *
1099      * @param basePackageName
1100      *            string contains the module package name
1101      * @param grouping
1102      *            GroupingDefinition which contains data about grouping
1103      * @param module
1104      *            current module
1105      * @param typeProvider
1106      *            provider that defines contract for generated types
1107      * @param schemaContext
1108      *            schema context
1109      * @param genCtx
1110      *            map of generated entities in context of YANG modules
1111      * @param genTypeBuilders
1112      *            map of generated type builders
1113      * @param verboseClassComments
1114      *            generate verbose comments
1115      *
1116      * @return GeneratedType which is generated from grouping (object of type
1117      *         <code>GroupingDefinition</code>)
1118      */
1119     private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1120             module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1121             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1122         final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath(), BindingNamespaceType.Grouping);
1123         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module, genCtx,
1124                 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1125         annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1126         genCtx.get(module).addGroupingType(grouping.getPath(), genType);
1127         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1128                 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1129         genCtx = groupingsToGenTypes(module, grouping.getGroupings(), genCtx, schemaContext, verboseClassComments,
1130                 genTypeBuilders, typeProvider);
1131         genCtx = processUsesAugments(schemaContext, grouping, module, genCtx, genTypeBuilders, verboseClassComments,
1132                 typeProvider);
1133         return genCtx;
1134     }
1135
1136     /**
1137      * //TODO: add information about multiple base identities in YANG 1.1
1138      * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1139      * created transport object builder. If identity contains base identity then
1140      * reference to base identity is added to superior identity as its extend.
1141      * If identity doesn't contain base identity then only reference to abstract
1142      * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1143      * BaseIdentity} is added
1144      *
1145      * @param module
1146      *            current module
1147      * @param basePackageName
1148      *            string contains the module package name
1149      * @param identity
1150      *            IdentitySchemaNode which contains data about identity
1151      * @param schemaContext
1152      *            SchemaContext which is used to get package and name
1153      *            information about base of identity
1154      * @param genCtx generated context
1155      * @return returns generated context
1156      */
1157     static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1158             final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1159             boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
1160             final TypeProvider typeProvider, Map<QName, GeneratedTOBuilderImpl> generatedIdentities) {
1161
1162         final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1163             BindingNamespaceType.Identity);
1164         final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName,
1165                 identity.getQName().getLocalName());
1166
1167         final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1168         if (baseIdentities.size() == 0) {
1169             //no base - abstract
1170             final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1171                 BaseIdentity.class.getSimpleName());
1172             newType.setExtendsType(gto.toInstance());
1173             generatedIdentities.put(identity.getQName(), newType);
1174         } else {
1175             //one base - inheritance
1176             final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1177             final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(schemaContext, baseIdentity);
1178             final String returnTypePkgName = new StringBuilder(BindingMapping.getRootPackageName
1179                     (baseIdentityParentModule))
1180                     .append('.')
1181                     .append(BindingNamespaceType.Identity.getPackagePrefix())
1182                     .toString();
1183
1184             final GeneratedTOBuilderImpl existingIdentityGto = generatedIdentities.get(baseIdentity.getQName());
1185             if (existingIdentityGto != null) {
1186                 newType.setExtendsType(existingIdentityGto.toInstance());
1187             } else {
1188                 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(returnTypePkgName,
1189                         baseIdentity.getQName().getLocalName());
1190                 newType.setExtendsType(gto.toInstance());
1191                 generatedIdentities.put(baseIdentity.getQName(), gto);
1192             }
1193
1194             //FIXME: more bases - possible composition, multiple inheritance not possible
1195         }
1196         generatedIdentities.put(identity.getQName(), newType);
1197
1198         newType.setAbstract(true);
1199         newType.addComment(identity.getDescription());
1200         newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1201                 verboseClassComments));
1202         newType.setReference(identity.getReference());
1203         newType.setModuleName(module.getName());
1204         newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1205
1206         qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1207
1208         genCtx.get(module).addIdentityType(identity.getQName(), newType);
1209         return genCtx;
1210     }
1211 }