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