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 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         boolean isTypeNormalized = false;
 422         if (augIdentifier == null) {
 423             augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
 424             isTypeNormalized = true;
 425         }
 426
 427         GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
 428                 false, isTypeNormalized);
 429
 430         augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
 431         augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
 432         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 433         augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
 434         augTypeBuilder.setWithBuilder(true);
 435         annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
 436
 437         //produces getters for augTypeBuilder eventually
 438         for (AugmentationSchema aug : schemaPathAugmentListEntry) {
 439             //apply all uses
 440             addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
 441             augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
 442                genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
 443         }
 444
 445         augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
 446
 447         if(!augSchema.getChildNodes().isEmpty()) {
 448             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
 449             genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
 450         }
 451         genCtx.get(module).addAugmentType(augTypeBuilder);
 452         return genCtx;
 453     }
 454
 455     /**
 456      * Adds the methods to <code>typeBuilder</code> what represents subnodes of
 457      * node for which <code>typeBuilder</code> was created.
 458      *
 459      * @param module
 460      *            current module
 461      * @param basePackageName
 462      *            string contains the module package name
 463      * @param typeBuilder
 464      *            generated type builder which represents any node. The subnodes
 465      *            of this node are added to the <code>typeBuilder</code> as
 466      *            methods. The subnode can be of type leaf, leaf-list, list,
 467      *            container, choice.
 468      * @param childOf
 469      *            parent type
 470      * @param schemaNodes
 471      *            set of data schema nodes which are the children of the node
 472      *            for which <code>typeBuilder</code> was created
 473      * @return generated type builder which is the same object as the input
 474      *         parameter <code>typeBuilder</code>. The getter method could be
 475      *         added to it.
 476      */
 477     private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
 478             final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
 479             final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
 480             verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
 481             GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
 482         if (schemaNodes != null && typeBuilder != null) {
 483             for (final DataSchemaNode schemaNode : schemaNodes) {
 484                 if (!schemaNode.isAugmenting()) {
 485                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
 486                             schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
 487                 }
 488             }
 489         }
 490         return typeBuilder;
 491     }
 492
 493     /**
 494      * Instantiates generated type builder with <code>packageName</code> and
 495      * <code>schemaNode</code>.
 496      *
 497      * The new builder always implements
 498      * {@link TreeNode TreeNode}.<br>
 499      * If <code>schemaNode</code> is instance of GroupingDefinition it also
 500      * implements {@link Augmentable
 501      * Augmentable}.<br>
 502      * If <code>schemaNode</code> is instance of
 503      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
 504      * DataNodeContainer} it can also implement nodes which are specified in
 505      * <i>uses</i>.
 506      *
 507      * @param basePackageName
 508      *            string contains the module package name
 509      * @param schemaNode
 510      *            schema node for which is created generated type builder
 511      * @param parent
 512      *            parent type (can be null)
 513      * @param schemaContext schema context
 514      * @return generated type builder <code>schemaNode</code>
 515      */
 516     private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
 517             schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
 518             final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
 519             GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
 520
 521         String suffix = "";
 522         if (schemaNode instanceof GroupingDefinition) {
 523             suffix = "grouping";
 524         } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
 525             suffix = "data";
 526         }
 527
 528         GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
 529                 verboseClassComments, genTypeBuilders, namespaceType);
 530         if (namespaceType.equals(BindingNamespaceType.Data)) {
 531             if (parent == null) {
 532                 it.addImplementsType(BindingTypes.TREE_NODE);
 533             } else {
 534                 if (parent instanceof ListSchemaNode) {
 535                     it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
 536                             (BindingTypes.IDENTIFIABLE_ITEM, parent)));
 537                 } else {
 538                     it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
 539                             (BindingTypes.ITEM, parent)));
 540                     it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
 541                 }
 542             }
 543
 544             if (!(schemaNode instanceof GroupingDefinition)) {
 545                 it.addImplementsType(BindingTypes.augmentable(it));
 546             }
 547         } else {
 548             it.addImplementsType(BindingTypes.TREE_NODE);
 549         }
 550
 551         if (schemaNode instanceof DataNodeContainer) {
 552             groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
 553                     verboseClassComments, genTypeBuilders, typeProvider);
 554             it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
 555         }
 556
 557         return it;
 558     }
 559
 560     static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
 561             parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
 562             final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
 563             genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
 564         final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
 565                 (basePackageName, notification, null, module, genCtx, schemaContext,
 566                         verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
 567         annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
 568         notificationInterface.addImplementsType(NOTIFICATION);
 569         genCtx.get(module).addChildNodeType(notification, notificationInterface);
 570
 571         // Notification object
 572         resolveDataSchemaNodes(module, basePackageName, notificationInterface,
 573                 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
 574                 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
 575
 576         //in case of tied notification, incorporate parent's localName
 577         final StringBuilder sb = new StringBuilder("on_");
 578         if (parentName != null) {
 579             sb.append(parentName).append('_');
 580         }
 581         sb.append(notificationInterface.getName());
 582
 583         listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
 584                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
 585                 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
 586         return listenerInterface;
 587     }
 588
 589     /**
 590      * Returns reference to generated type builder for specified
 591      * <code>schemaNode</code> with <code>packageName</code>.
 592      *
 593      * Firstly the generated type builder is searched in
 594      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
 595      * found it is created and added to <code>genTypeBuilders</code>.
 596      *
 597      * @param basePackageName
 598      *            string contains the module package name
 599      * @param schemaNode
 600      *            schema node which provide data about the schema node name
 601      * @param schemaContext schema context
 602      * @param prefix
 603      *            return type name prefix
 604      * @return generated type builder for <code>schemaNode</code>
 605      * @throws IllegalArgumentException
 606      *             <ul>
 607      *             <li>if <code>schemaNode</code> is null</li>
 608      *             <li>if <code>packageName</code> is null</li>
 609      *             <li>if QName of schema node is null</li>
 610      *             <li>if schemaNode name is null</li>
 611      *             </ul>
 612      *
 613      */
 614     static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
 615             final SchemaContext schemaContext, final String prefix, final String suffix,
 616             final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 617             final BindingNamespaceType namespaceType) {
 618
 619         Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
 620         Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
 621         String schemaNodeName = schemaNode.getQName().getLocalName();
 622         Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
 623
 624         if (prefix != null && !prefix.isEmpty()) {
 625             // underscore used as separator for distinction of class name parts
 626             schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
 627         }
 628
 629         if (suffix != null && !suffix.isEmpty()) {
 630             // underscore used as separator for distinction of class name parts
 631             schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
 632         }
 633
 634         final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
 635         final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
 636         final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
 637         qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
 638         newType.addComment(schemaNode.getDescription());
 639         newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
 640                 verboseClassComments, namespaceType));
 641         newType.setReference(schemaNode.getReference());
 642         newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
 643         newType.setModuleName(module.getName());
 644         newType.setBasePackageName(BindingMapping.getRootPackageName(module));
 645         newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
 646
 647         if (!genTypeBuilders.containsKey(packageName)) {
 648             final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
 649             builders.put(newType.getName(), newType);
 650             genTypeBuilders.put(packageName, builders);
 651         } else {
 652             final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
 653             if (!builders.containsKey(newType.getName())) {
 654                 builders.put(newType.getName(), newType);
 655             }
 656         }
 657         return newType;
 658
 659     }
 660
 661     private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
 662         final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
 663         final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
 664         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
 665         final BindingNamespaceType namespaceType) {
 666
 667         if (node != null && typeBuilder != null) {
 668             if (node instanceof ContainerSchemaNode) {
 669                 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
 670                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 671             } else if (node instanceof LeafListSchemaNode) {
 672                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
 673                             typeProvider, genCtx);
 674             } else if (node instanceof LeafSchemaNode) {
 675                 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
 676                         typeProvider);
 677             } else if (node instanceof ListSchemaNode) {
 678                 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
 679                         verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 680             } else if (node instanceof ChoiceSchemaNode) {
 681                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
 682                         (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
 683             } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
 684                 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
 685             }
 686         }
 687     }
 688
 689     /**
 690      * Converts <code>choiceNode</code> to the list of generated types for
 691      * choice and its cases.
 692      *
 693      * The package names for choice and for its cases are created as
 694      * concatenation of the module package (<code>basePackageName</code>) and
 695      * names of all parents node.
 696      *
 697      * @param module
 698      *            current module
 699      * @param basePackageName
 700      *            string with the module package name
 701      * @param parent
 702      *            parent type
 703      * @param choiceNode
 704      *            choice node which is mapped to generated type. Also child
 705      *            nodes - cases are mapped to generated types.
 706      * @throws IllegalArgumentException
 707      *             <ul>
 708      *             <li>if <code>basePackageName</code> is null</li>
 709      *             <li>if <code>choiceNode</code> is null</li>
 710      *             </ul>
 711      */
 712     private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
 713             verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
 714             ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 715             final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
 716         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
 717         checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
 718
 719         final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
 720                 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType);
 721         constructGetter(parent, choiceNode.getQName().getLocalName(),
 722                 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
 723         if (namespaceType.equals(BindingNamespaceType.Data)) {
 724             choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
 725         }
 726         annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
 727         genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
 728         generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
 729             choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
 730     }
 731
 732     private static void containerToGenType(final Module module, final String basePackageName,
 733         final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
 734         final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
 735         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
 736         final BindingNamespaceType namespaceType) {
 737
 738         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
 739                 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 740         if (genType != null) {
 741             StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
 742             final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
 743             resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
 744                     schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
 745             processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
 746         }
 747     }
 748
 749     private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
 750             parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
 751             final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
 752             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
 753             final BindingNamespaceType namespaceType) {
 754
 755         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
 756                 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 757         if (genType != null) {
 758             final String nodeName = node.getQName().getLocalName();
 759
 760             Type getterReturnType = Types.listTypeFor(genType);
 761             if (namespaceType.equals(BindingNamespaceType.Grouping)) {
 762                 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
 763                                 true, true));
 764             }
 765             constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
 766
 767             final List<QName> listKeys = node.getKeyDefinition();
 768             final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
 769                     BindingNamespaceType.Key)).append('.').append(nodeName).toString();
 770             //FIXME: Is it neccessary to generate interface of key and implemented by class?
 771             if (namespaceType.equals(BindingNamespaceType.Grouping)) {
 772                 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node);
 773                 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
 774                     if (resolveDataSchemaNodesCheck(schemaNode)) {
 775                         addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
 776                                 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
 777                     }
 778                 }
 779                 if (genTypeBuilder != null) {
 780                     typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
 781                     genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
 782                 }
 783             } else {
 784                 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
 785                 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
 786                     if (resolveDataSchemaNodesCheck(schemaNode)) {
 787                         addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
 788                                 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
 789                     }
 790                 }
 791
 792                 // serialVersionUID
 793                 if (genTOBuilder != null) {
 794                     final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
 795                     prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
 796                     genTOBuilder.setSUID(prop);
 797
 798                     typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
 799                     genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
 800                 }
 801             }
 802         }
 803     }
 804
 805     private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
 806             final Type keyType, final Map<Module, ModuleContext> genCtx,
 807             final BindingNamespaceType namespaceType) {
 808         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
 809         if (keyType != null) {
 810             Type returnKeyType = keyType;
 811             if (namespaceType.equals(BindingNamespaceType.Grouping)) {
 812                 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
 813                         true, true);
 814             }
 815             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
 816
 817         }
 818     }
 819
 820     /**
 821      * Converts <code>leaf</code> to the getter method which is added to
 822      * <code>typeBuilder</code>.
 823      *
 824      * @param typeBuilder
 825      *            generated type builder to which is added getter method as
 826      *            <code>leaf</code> mapping
 827      * @param leaf
 828      *            leaf schema node which is mapped as getter method which is
 829      *            added to <code>typeBuilder</code>
 830      * @param module
 831      *            Module in which type was defined
 832      * @return boolean value
 833      *         <ul>
 834      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
 835      *         null</li>
 836      *         <li>true - in other cases</li>
 837      *         </ul>
 838      */
 839     private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
 840             final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
 841             final Module module, final TypeProvider typeProvider) {
 842         if (leaf == null || typeBuilder == null) {
 843             return null;
 844         }
 845
 846         final String leafName = leaf.getQName().getLocalName();
 847         if (leafName == null) {
 848             return null;
 849         }
 850
 851         final Module parentModule = findParentModule(schemaContext, leaf);
 852         Type returnType = null;
 853
 854         final TypeDefinition<?> typeDef = leaf.getType();
 855         if (isInnerType(leaf, typeDef)) {
 856             if (typeDef instanceof EnumTypeDefinition) {
 857                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
 858                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
 859                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
 860                         genCtx, typeBuilder, module);
 861                 if (enumBuilder != null) {
 862                     returnType = enumBuilder.toInstance(typeBuilder);
 863                 }
 864                 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
 865             } else if (typeDef instanceof UnionTypeDefinition) {
 866                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
 867                         typeProvider, schemaContext);
 868                 if (genTOBuilder != null) {
 869                     //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
 870                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
 871                 }
 872             } else if (typeDef instanceof BitsTypeDefinition) {
 873                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
 874                         typeProvider, schemaContext);
 875                 if (genTOBuilder != null) {
 876                     returnType = genTOBuilder.toInstance();
 877                 }
 878             } else {
 879                 // It is constrained version of already declared type (inner declared type exists,
 880                 // onlyfor special cases (Enum, Union, Bits), which were already checked.
 881                 // In order to get proper class we need to look up closest derived type
 882                 // and apply restrictions from leaf type
 883                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 884                 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
 885                         restrictions);
 886             }
 887         } else {
 888             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 889             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
 890         }
 891
 892         if (returnType == null) {
 893             return null;
 894         }
 895
 896         if (typeDef instanceof EnumTypeDefinition) {
 897             ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
 898         }
 899
 900         String leafDesc = leaf.getDescription();
 901         if (leafDesc == null) {
 902             leafDesc = "";
 903         }
 904
 905         final String leafGetterName;
 906         if ("key".equals(leafName.toLowerCase())) {
 907             StringBuilder sb = new StringBuilder(leafName)
 908                 .append('_').append("RESERVED_WORD");
 909             leafGetterName = sb.toString();
 910         } else {
 911             leafGetterName = leafName;
 912         }
 913         constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
 914         return returnType;
 915     }
 916
 917     /**
 918      * Converts <code>node</code> leaf list schema node to getter method of
 919      * <code>typeBuilder</code>.
 920      *
 921      * @param typeBuilder
 922      *            generated type builder to which is <code>node</code> added as
 923      *            getter method
 924      * @param node
 925      *            leaf list schema node which is added to
 926      *            <code>typeBuilder</code> as getter method
 927      * @param module module
 928      * @param typeProvider type provider instance
 929      * @param genCtx actual generated context
 930      * @return boolean value
 931      *         <ul>
 932      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,
 933      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>
 934      *         <li>false - other cases</li>
 935      *         </ul>
 936      */
 937     private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
 938             typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
 939             final Map<Module, ModuleContext> genCtx) {
 940         if (node == null || typeBuilder == null) {
 941             return false;
 942         }
 943
 944         final QName nodeName = node.getQName();
 945
 946         final TypeDefinition<?> typeDef = node.getType();
 947         final Module parentModule = findParentModule(schemaContext, node);
 948
 949         Type returnType = null;
 950         if (typeDef.getBaseType() == null) {
 951             if (typeDef instanceof EnumTypeDefinition) {
 952                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
 953                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
 954                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
 955                         genCtx, typeBuilder, module);
 956                 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
 957                 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
 958             } else if (typeDef instanceof UnionTypeDefinition) {
 959                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
 960                         typeProvider, schemaContext);
 961                 if (genTOBuilder != null) {
 962                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
 963                 }
 964             } else if (typeDef instanceof BitsTypeDefinition) {
 965                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
 966                         typeProvider, schemaContext);
 967                 returnType = genTOBuilder.toInstance();
 968             } else {
 969                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 970                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
 971             }
 972         } else {
 973             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 974             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
 975         }
 976
 977         final ParameterizedType listType = Types.listTypeFor(returnType);
 978         constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
 979         return true;
 980     }
 981
 982     /**
 983      * Converts <code>caseNodes</code> set to list of corresponding generated
 984      * types.
 985      *
 986      * For every <i>case</i> which isn't added through augment or <i>uses</i> is
 987      * created generated type builder. The package names for the builder is
 988      * created as concatenation of the module package (
 989      * <code>basePackageName</code>) and names of all parents nodes of the
 990      * concrete <i>case</i>. There is also relation "<i>implements type</i>"
 991      * between every case builder and <i>choice</i> type
 992      *
 993      * @param module
 994      *            current module
 995      * @param schemaContext
 996      *            current schema context
 997      * @param genCtx
 998      *            actual generated context
 999      * @param basePackageName
1000      *            string with the module package name
1001      * @param refChoiceType
1002      *            type which represents superior <i>case</i>
1003      * @param choiceNode
1004      *            choice case node which is mapped to generated type
1005      * @param verboseClassComments
1006      *            Javadoc verbosity switch
1007      * @throws IllegalArgumentException
1008      *             <ul>
1009      *             <li>if <code>basePackageName</code> equals null</li>
1010      *             <li>if <code>refChoiceType</code> equals null</li>
1011      *             <li>if <code>caseNodes</code> equals null</li>
1012      *             </ul>
1013      */
1014     private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1015             final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1016             final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1017             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1018         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1019         checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1020         checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1021
1022         final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1023         if (caseNodes == null) {
1024             return;
1025         }
1026
1027         for (final ChoiceCaseNode caseNode : caseNodes) {
1028             if (caseNode != null && resolveDataSchemaNodesCheck(caseNode)) {
1029                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1030                     module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1031                 caseTypeBuilder.addImplementsType(refChoiceType);
1032                 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1033                 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1034                 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1035                 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1036                 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1037                 if (caseChildNodes != null) {
1038                     final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1039
1040                     if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1041                         SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1042
1043                         if (parent instanceof AugmentationSchema) {
1044                             final AugmentationSchema augSchema = (AugmentationSchema) parent;
1045                             final SchemaPath targetPath = augSchema.getTargetPath();
1046                             SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1047                             if (targetSchemaNode instanceof DataSchemaNode
1048                                     && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1049                                 if (targetSchemaNode instanceof DerivableSchemaNode) {
1050                                     targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1051                                 }
1052                                 if (targetSchemaNode == null) {
1053                                     throw new IllegalStateException(
1054                                             "Failed to find target node from grouping for augmentation " + augSchema
1055                                                     + " in module " + module.getName());
1056                                 }
1057                             }
1058                             parent = targetSchemaNode;
1059                         }
1060
1061                         Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1062                                 choiceNodeParentPath);
1063                         GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1064                         if (childOfType == null) {
1065                             childOfType = findGroupingByPath(parent.getPath(), genCtx);
1066                         }
1067                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1068                                 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1069                     } else {
1070                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
1071                                 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
1072                                 verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1073                     }
1074                 }
1075             }
1076         }
1077     }
1078
1079     private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1080             typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1081             final TypeProvider typeProvider) {
1082
1083         final String anyName = node.getQName().getLocalName();
1084         if (anyName == null) {
1085             return null;
1086         }
1087
1088         String anyDesc = node.getDescription();
1089         if (anyDesc == null) {
1090             anyDesc = "";
1091         }
1092
1093         Type returnType = Types.DOCUMENT;
1094
1095         constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1096         return returnType;
1097     }
1098
1099     /**
1100      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1101      * or to <code>genTOBuilder</code> as property.
1102      *
1103      * @param nodeName
1104      *            string contains the name of list
1105      * @param basePackageName
1106      *            string contains the module package name
1107      * @param schemaNode
1108      *            data schema node which should be added as getter method to
1109      *            <code>typeBuilder</code> or as a property to
1110      *            <code>genTOBuilder</code> if is part of the list key
1111      * @param typeBuilder
1112      *            generated type builder for the list schema node
1113      * @param genTOBuilder
1114      *            generated TO builder for the list keys
1115      * @param listKeys
1116      *            list of string which contains QNames of the list keys
1117      * @param module
1118      *            current module
1119      * @param typeProvider
1120      *            provider that defines contract for generated types
1121      * @param schemaContext
1122      *            schema context
1123      * @param genCtx
1124      *            map of generated entities in context of YANG modules
1125      * @param genTypeBuilders
1126      *            map of generated type builders
1127      * @param verboseClassComments
1128      *            generate verbose comments
1129      * @throws IllegalArgumentException
1130      *             <ul>
1131      *             <li>if <code>schemaNode</code> equals null</li>
1132      *             <li>if <code>typeBuilder</code> equals null</li>
1133      *             </ul>
1134      */
1135     private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1136             final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1137             final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1138             final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1139             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1140             final BindingNamespaceType namespaceType) {
1141         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1142         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1143
1144         if (schemaNode instanceof LeafSchemaNode) {
1145             final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1146             final QName leafQName = leaf.getQName();
1147
1148             final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1149                     typeProvider);
1150             if (listKeys.contains(leafQName)) {
1151                 if (type == null) {
1152                     resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1153                         module);
1154                 } else {
1155                     AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1156                 }
1157             }
1158         } else {
1159             if (schemaNode instanceof LeafListSchemaNode) {
1160                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1161                         typeProvider, genCtx);
1162             } else if (schemaNode instanceof ContainerSchemaNode) {
1163                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1164                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1165             } else if (schemaNode instanceof ListSchemaNode) {
1166                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1167                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1168             } else if (schemaNode instanceof ChoiceSchemaNode) {
1169                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1170                         (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1171             }
1172         }
1173     }
1174
1175     private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1176                                                     final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1177                                                     final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1178                                                     final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1179                                                     final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1180                                                     final BindingNamespaceType namespaceType) {
1181         checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1182         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1183
1184         if (schemaNode instanceof LeafSchemaNode) {
1185             final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1186             final QName leafQName = leaf.getQName();
1187             final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1188                     typeProvider);
1189             if (listKeys.contains(leafQName)) {
1190                 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1191                         typeProvider);
1192             }
1193         } else {
1194             if (schemaNode instanceof LeafListSchemaNode) {
1195                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1196                         typeProvider, genCtx);
1197             } else if (schemaNode instanceof ContainerSchemaNode) {
1198                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1199                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1200             } else if (schemaNode instanceof ListSchemaNode) {
1201                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1202                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1203             } else if (schemaNode instanceof ChoiceSchemaNode) {
1204                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1205                         (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1206             }
1207         }
1208     }
1209
1210     private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1211             typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1212             toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1213
1214         if (leaf != null && toBuilder != null) {
1215             Type returnType;
1216             final TypeDefinition<?> typeDef = leaf.getType();
1217             if (typeDef instanceof UnionTypeDefinition) {
1218                 // GeneratedType for this type definition should be already
1219                 // created
1220                 final QName qname = typeDef.getQName();
1221                 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1222                         qname.getRevision());
1223                 final ModuleContext mc = genCtx.get(unionModule);
1224                 returnType = mc.getTypedefs().get(typeDef.getPath());
1225             } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1226                 // Annonymous enumeration (already generated, since it is inherited via uses).
1227                 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1228                 QName qname = originalLeaf.getQName();
1229                 final Module enumModule =  schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1230                         qname.getRevision());
1231                 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1232             } else {
1233                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1234             }
1235             return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1236         }
1237         return false;
1238     }
1239
1240     private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1241         final TypeDefinition<?> baseType = typeDef.getBaseType();
1242         return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1243     }
1244
1245     @SuppressWarnings({ "rawtypes", "unchecked" })
1246     private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1247         final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1248         final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1249         GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1250
1251         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1252                 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1253         genType.addComment(node.getDescription());
1254         annotateDeprecatedIfNecessary(node.getStatus(), genType);
1255         genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1256                 verboseClassComments, namespaceType));
1257         genType.setModuleName(module.getName());
1258         genType.setReference(node.getReference());
1259         genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1260         genType.setParentTypeForBuilder(childOf);
1261         if (node instanceof DataNodeContainer) {
1262             genCtx.get(module).addChildNodeType(node, genType);
1263         }
1264         return genType;
1265     }
1266
1267     /**
1268      * Converts all <b>groupings</b> of the module to the list of
1269      * <code>Type</code> objects. Firstly are groupings sorted according mutual
1270      * dependencies. At least dependent (independent) groupings are in the list
1271      * saved at first positions. For every grouping the record is added to map
1272      * {@link ModuleContext#groupings allGroupings}
1273      *
1274      * @param module
1275      *            current module
1276      * @param groupings
1277      *            collection of groupings from which types will be generated
1278      * @param typeProvider
1279      *            provider that defines contract for generated types
1280      * @param schemaContext
1281      *            schema context
1282      * @param genCtx
1283      *            map of generated entities in context of YANG modules
1284      * @param genTypeBuilders
1285      *            map of generated type builders
1286      * @param verboseClassComments
1287      *            generate verbose comments
1288      *
1289      */
1290     static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1291             groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1292             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1293         final String basePackageName = BindingMapping.getRootPackageName(module);
1294         final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1295                 .sort(groupings);
1296         for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1297             genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1298                     verboseClassComments, genTypeBuilders, typeProvider);
1299         }
1300         return genCtx;
1301     }
1302
1303     /**
1304      * Converts individual grouping to GeneratedType. Firstly generated type
1305      * builder is created and every child node of grouping is resolved to the
1306      * method.
1307      *
1308      * @param basePackageName
1309      *            string contains the module package name
1310      * @param grouping
1311      *            GroupingDefinition which contains data about grouping
1312      * @param module
1313      *            current module
1314      * @param typeProvider
1315      *            provider that defines contract for generated types
1316      * @param schemaContext
1317      *            schema context
1318      * @param genCtx
1319      *            map of generated entities in context of YANG modules
1320      * @param genTypeBuilders
1321      *            map of generated type builders
1322      * @param verboseClassComments
1323      *            generate verbose comments
1324      *
1325      * @return GeneratedType which is generated from grouping (object of type
1326      *         <code>GroupingDefinition</code>)
1327      */
1328     private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1329             module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1330             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1331         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1332                 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1333         annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1334         genCtx.get(module).addGroupingType(grouping, genType);
1335         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1336                 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1337         genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1338         return genCtx;
1339     }
1340
1341     /**
1342      * //TODO: add information about multiple base identities in YANG 1.1
1343      * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1344      * created transport object builder. If identity contains base identity then
1345      * reference to base identity is added to superior identity as its extend.
1346      * If identity doesn't contain base identity then only reference to abstract
1347      * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1348      * BaseIdentity} is added
1349      *
1350      * @param module
1351      *            current module
1352      * @param basePackageName
1353      *            string contains the module package name
1354      * @param identity
1355      *            IdentitySchemaNode which contains data about identity
1356      * @param schemaContext
1357      *            SchemaContext which is used to get package and name
1358      *            information about base of identity
1359      * @param genCtx generated context
1360      * @return returns generated context
1361      */
1362     static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1363             final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1364             boolean verboseClassComments) {
1365
1366         resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1367         return genCtx;
1368     }
1369
1370     private static GeneratedTOBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1371             final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1372             final Map<Module, ModuleContext> genCtx) {
1373         Preconditions.checkNotNull(identity,"Identity can not be null!");
1374
1375         //check first if identity has been resolved as base identity of some other one
1376         GeneratedTOBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1377         if (newType == null) {
1378             final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1379             Preconditions.checkState(module.equals(parentModule),
1380                     "If the type is null ,it must be in the same module, otherwise it must has been"
1381                             + "resolved by an imported module.");
1382
1383             final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1384                     BindingNamespaceType.Identity);
1385             newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false);
1386
1387             final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1388             if (baseIdentities.size() == 0) {
1389                 //no base - abstract
1390                 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1391                         BaseIdentity.class.getSimpleName());
1392                 newType.setExtendsType(gto.toInstance());
1393             } else {
1394                 //one base - inheritance
1395                 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1396                 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1397                     baseIdentity, module, verboseClassComments, genCtx);
1398                 newType.setExtendsType(baseType.toInstance());
1399             }
1400
1401             newType.setAbstract(true);
1402             newType.addComment(identity.getDescription());
1403             newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1404                     verboseClassComments, BindingNamespaceType.Identity));
1405             newType.setReference(identity.getReference());
1406             newType.setModuleName(module.getName());
1407             newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1408
1409             qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1410
1411             genCtx.get(module).addIdentityType(identity.getQName(), newType);
1412         }
1413         return newType;
1414     }
1415 }