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