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