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

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