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

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