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