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