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