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

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