binding2/mdsal-binding2-generator-impl/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/impl/GenHelperUtil.java

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