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