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

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