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

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