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