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

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