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