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         moduleBuilder.setBasePackageName(packageName);
 159         return moduleBuilder;
 160     }
 161
 162     /**
 163      * Adds the implemented types to type builder.
 164      *
 165      * The method passes through the list of <i>uses</i> in
 166      * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
 167      * generated type from all groupings
 168      * allGroupings} which is added as <i>implements type</i> to
 169      * <code>builder</code>
 170      *
 171      * @param dataNodeContainer
 172      *            element which contains the list of used YANG groupings
 173      * @param builder
 174      *            builder to which are added implemented types according to
 175      *            <code>dataNodeContainer</code>
 176      * @param genCtx generated context
 177      * @return generated type builder with all implemented types
 178      */
 179     static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
 180                           final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
 181         for (final UsesNode usesNode : dataNodeContainer.getUses()) {
 182             final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
 183             if (genType == null) {
 184                 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
 185                     + builder.getName());
 186             }
 187             builder.addImplementsType(genType);
 188         }
 189         return builder;
 190     }
 191
 192      static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 193         for (final ModuleContext ctx : genCtx.values()) {
 194             final GeneratedTypeBuilder result = ctx.getGrouping(path);
 195             if (result != null) {
 196                 return result;
 197             }
 198         }
 199         return null;
 200      }
 201
 202     /**
 203      * Adds the methods to <code>typeBuilder</code> which represent subnodes of
 204      * node for which <code>typeBuilder</code> was created.
 205      *
 206      * The subnodes aren't mapped to the methods if they are part of grouping or
 207      * augment (in this case are already part of them).
 208      *
 209      * @param module
 210      *            current module
 211      * @param basePackageName
 212      *            string contains the module package name
 213      * @param parent
 214      *            generated type builder which represents any node. The subnodes
 215      *            of this node are added to the <code>typeBuilder</code> as
 216      *            methods. The subnode can be of type leaf, leaf-list, list,
 217      *            container, choice.
 218      * @param childOf
 219      *            parent type
 220      * @param schemaNodes
 221      *            set of data schema nodes which are the children of the node
 222      *            for which <code>typeBuilder</code> was created
 223      * @return generated type builder which is the same builder as input
 224      *         parameter. The getter methods (representing child nodes) could be
 225      *         added to it.
 226      */
 227     static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
 228                           final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
 229                           final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
 230                           final SchemaContext schemaContext, final boolean verboseClassComments,
 231                           final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 232                           final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
 233
 234         if (schemaNodes != null && parent != null) {
 235             for (final DataSchemaNode schemaNode : schemaNodes) {
 236                 if (!schemaNode.isAugmenting()) {
 237                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
 238                             schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
 239                 }
 240             }
 241         }
 242         return parent;
 243     }
 244
 245     static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
 246             schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
 247             final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 248             final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
 249         return addDefaultInterfaceDefinition(packageName, schemaNode, null, module, genCtx, schemaContext,
 250                 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
 251     }
 252
 253     static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
 254                         DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
 255                         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 256                         final boolean verboseClassComments, final TypeProvider typeProvider,
 257                         final BindingNamespaceType namespaceType) {
 258         final String basePackageName = BindingMapping.getRootPackageName(module);
 259         for (final UsesNode usesNode : node.getUses()) {
 260             Map<SchemaPath, List<AugmentationSchema>> augmentationsGrouped =
 261                     usesNode.getAugmentations().stream().collect(Collectors.groupingBy(AugmentationSchema::getTargetPath));
 262             for (Map.Entry<SchemaPath, List<AugmentationSchema>> schemaPathAugmentListEntry : augmentationsGrouped.entrySet()) {
 263                 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName,
 264                         schemaPathAugmentListEntry.getValue(), module,
 265                         usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider, namespaceType);
 266                 for (AugmentationSchema augSchema : schemaPathAugmentListEntry.getValue()) {
 267                     genCtx = processUsesAugments(schemaContext, augSchema, module, genCtx, genTypeBuilders,
 268                             verboseClassComments, typeProvider, namespaceType);
 269                 }
 270             }
 271         }
 272         return genCtx;
 273     }
 274
 275     static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 276         for (final ModuleContext ctx : genCtx.values()) {
 277             final GeneratedTypeBuilder result = ctx.getChildNode(path);
 278             if (result != null) {
 279                 return result;
 280             }
 281         }
 282         return null;
 283     }
 284
 285     static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
 286         for (final ModuleContext ctx : genCtx.values()) {
 287             final GeneratedTypeBuilder result = ctx.getCase(path);
 288             if (result != null) {
 289                 return result;
 290             }
 291         }
 292         return null;
 293     }
 294
 295     static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
 296             final Type targetTypeRef, final List<AugmentationSchema> schemaPathAugmentListEntry,
 297             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
 298             final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
 299             final BindingNamespaceType namespaceType) {
 300
 301         //pick augmentation grouped by augmentation target, there is always at least one
 302         final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
 303
 304         Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
 305                 augmentPackageName, k -> new HashMap<>());
 306
 307         //this requires valid semantics in YANG model
 308         String augIdentifier = null;
 309         for (AugmentationSchema aug : schemaPathAugmentListEntry) {
 310             augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
 311             break;
 312         }
 313
 314         boolean isTypeNormalized = false;
 315         if (augIdentifier == null) {
 316             augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
 317             isTypeNormalized = true;
 318         }
 319
 320         GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
 321                 false, isTypeNormalized);
 322
 323         augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
 324         augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
 325         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 326         augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
 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 packageName
 400      *            string with the name of the package to which
 401      *            <code>schemaNode</code> belongs.
 402      * @param schemaNode
 403      *            schema node for which is created generated type builder
 404      * @param parent
 405      *            parent type (can be null)
 406      * @param schemaContext schema context
 407      * @return generated type builder <code>schemaNode</code>
 408      */
 409     private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
 410             schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
 411             final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
 412             GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
 413
 414         String suffix = "";
 415         if (schemaNode instanceof GroupingDefinition) {
 416             suffix = "grouping";
 417         } else if (namespaceType.equals(BindingNamespaceType.Grouping)){
 418             suffix = "data";
 419         }
 420
 421         GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, schemaContext, "", suffix,
 422                 verboseClassComments, genTypeBuilders);
 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         //TODO: it's not correct for some special cases
 437         if (namespaceType.equals(BindingNamespaceType.Data) && !(schemaNode instanceof GroupingDefinition)) {
 438             it.addImplementsType(BindingTypes.augmentable(it));
 439         }
 440
 441         if (schemaNode instanceof DataNodeContainer) {
 442             groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
 443                     verboseClassComments, genTypeBuilders, typeProvider);
 444             it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
 445         }
 446
 447         return it;
 448     }
 449
 450     static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
 451             parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
 452             final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
 453             genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
 454
 455         processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
 456                 verboseClassComments, typeProvider, BindingNamespaceType.Data);
 457
 458         final String packageName = packageNameForGeneratedType(basePackageName, notification.getPath(), BindingNamespaceType.Data);
 459         final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
 460                 (packageName, notification, null, module, genCtx, schemaContext,
 461                         verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
 462         annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
 463         notificationInterface.addImplementsType(NOTIFICATION);
 464         genCtx.get(module).addChildNodeType(notification, notificationInterface);
 465
 466         // Notification object
 467         resolveDataSchemaNodes(module, basePackageName, notificationInterface,
 468                 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
 469                 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
 470
 471         //in case of tied notification, incorporate parent's localName
 472         final StringBuilder sb = new StringBuilder("on_");
 473         if (parentName != null) {
 474             sb.append(parentName).append('_');
 475         }
 476         sb.append(notificationInterface.getName());
 477
 478         listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
 479                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
 480                 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
 481         return listenerInterface;
 482     }
 483
 484     /**
 485      * Returns reference to generated type builder for specified
 486      * <code>schemaNode</code> with <code>packageName</code>.
 487      *
 488      * Firstly the generated type builder is searched in
 489      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
 490      * found it is created and added to <code>genTypeBuilders</code>.
 491      *
 492      * @param packageName
 493      *            string with the package name to which returning generated type
 494      *            builder belongs
 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 packageName, 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
 514         Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
 515         Preconditions.checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
 516         String schemaNodeName = schemaNode.getQName().getLocalName();
 517         Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
 518
 519         if (prefix != null && !prefix.isEmpty()) {
 520             // underscore used as separator for distinction of class name parts
 521             schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
 522         }
 523
 524         if (suffix != null && !suffix.isEmpty()) {
 525             // underscore used as separator for distinction of class name parts
 526             schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
 527         }
 528
 529         final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
 530         final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
 531         qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
 532         newType.addComment(schemaNode.getDescription());
 533         newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext, verboseClassComments));
 534         newType.setReference(schemaNode.getReference());
 535         newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
 536         newType.setModuleName(module.getName());
 537         newType.setBasePackageName(BindingMapping.getRootPackageName(module));
 538
 539         if (!genTypeBuilders.containsKey(packageName)) {
 540             final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
 541             builders.put(newType.getName(), newType);
 542             genTypeBuilders.put(packageName, builders);
 543         } else {
 544             final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
 545             if (!builders.containsKey(newType.getName())) {
 546                 builders.put(newType.getName(), newType);
 547             }
 548         }
 549         return newType;
 550
 551     }
 552
 553     private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
 554         final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
 555         final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
 556         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
 557         final BindingNamespaceType namespaceType) {
 558
 559         if (node != null && typeBuilder != null) {
 560             if (node instanceof ContainerSchemaNode) {
 561                 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
 562                         schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 563             } else if (node instanceof LeafListSchemaNode) {
 564                 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
 565                             typeProvider, genCtx);
 566             } else if (node instanceof LeafSchemaNode) {
 567                 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
 568                         typeProvider);
 569             } else if (node instanceof ListSchemaNode) {
 570                 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
 571                         verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 572             } else if (node instanceof ChoiceSchemaNode) {
 573                 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
 574                         (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
 575             } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
 576                 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
 577             }
 578         }
 579     }
 580
 581     /**
 582      * Converts <code>choiceNode</code> to the list of generated types for
 583      * choice and its cases.
 584      *
 585      * The package names for choice and for its cases are created as
 586      * concatenation of the module package (<code>basePackageName</code>) and
 587      * names of all parents node.
 588      *
 589      * @param module
 590      *            current module
 591      * @param basePackageName
 592      *            string with the module package name
 593      * @param parent
 594      *            parent type
 595      * @param choiceNode
 596      *            choice node which is mapped to generated type. Also child
 597      *            nodes - cases are mapped to generated types.
 598      * @throws IllegalArgumentException
 599      *             <ul>
 600      *             <li>if <code>basePackageName</code> is null</li>
 601      *             <li>if <code>choiceNode</code> is null</li>
 602      *             </ul>
 603      */
 604     private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
 605             verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
 606             ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 607             final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
 608         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
 609         checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
 610
 611         if (!choiceNode.isAddedByUses()) {
 612             final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath(),
 613                     BindingNamespaceType.Data);
 614             final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode,
 615                     schemaContext, "", "", verboseClasssComments, genTypeBuilders);
 616             constructGetter(parent, choiceNode.getQName().getLocalName(),
 617                     choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
 618             choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
 619             annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
 620             genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
 621             generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
 622                 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
 623         }
 624     }
 625
 626     private static void containerToGenType(final Module module, final String basePackageName,
 627         final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
 628         final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
 629         final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
 630         final BindingNamespaceType namespaceType) {
 631
 632         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
 633                 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 634         if (genType != null) {
 635             StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
 636             if (!namespaceType.equals(BindingNamespaceType.Data)) {
 637                 getterName.append('_').append(BindingNamespaceType.Data);
 638             }
 639             final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
 640             if (!namespaceType.equals(BindingNamespaceType.Data)) {
 641                 getter.setAccessModifier(AccessModifier.DEFAULT);
 642             }
 643             resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
 644                     schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
 645         }
 646     }
 647
 648     private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
 649             parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
 650             final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
 651             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
 652             final BindingNamespaceType namespaceType) {
 653
 654         final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
 655                 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
 656         if (genType != null) {
 657             final String nodeName = node.getQName().getLocalName();
 658             constructGetter(parent, nodeName, node.getDescription(), Types.listTypeFor(genType), node.getStatus());
 659             final List<QName> listKeys = node.getKeyDefinition();
 660             final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
 661                     BindingNamespaceType.Key)).append('.').append(nodeName).toString();
 662
 663             final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
 664
 665             for (final DataSchemaNode schemaNode : node.getChildNodes()) {
 666                 if (!schemaNode.isAugmenting()) {
 667                     addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
 668                             module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
 669                 }
 670             }
 671
 672             // serialVersionUID
 673             if (genTOBuilder != null) {
 674                 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
 675                 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
 676                 genTOBuilder.setSUID(prop);
 677             }
 678
 679             typeBuildersToGenTypes(module, genType, genTOBuilder, genCtx);
 680         }
 681     }
 682
 683     private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
 684             final GeneratedTOBuilder genTOBuilder, final Map<Module, ModuleContext> genCtx) {
 685         checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
 686         if (genTOBuilder != null) {
 687             final GeneratedTransferObject genTO = genTOBuilder.toInstance();
 688             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
 689             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
 690         }
 691     }
 692
 693     /**
 694      * Converts <code>leaf</code> to the getter method which is added to
 695      * <code>typeBuilder</code>.
 696      *
 697      * @param typeBuilder
 698      *            generated type builder to which is added getter method as
 699      *            <code>leaf</code> mapping
 700      * @param leaf
 701      *            leaf schema node which is mapped as getter method which is
 702      *            added to <code>typeBuilder</code>
 703      * @param module
 704      *            Module in which type was defined
 705      * @return boolean value
 706      *         <ul>
 707      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
 708      *         null</li>
 709      *         <li>true - in other cases</li>
 710      *         </ul>
 711      */
 712     private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
 713             final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
 714             final Module module, final TypeProvider typeProvider) {
 715         if (leaf == null || typeBuilder == null) {
 716             return null;
 717         }
 718
 719         final String leafName = leaf.getQName().getLocalName();
 720         if (leafName == null) {
 721             return null;
 722         }
 723
 724         final Module parentModule = findParentModule(schemaContext, leaf);
 725         Type returnType = null;
 726
 727         final TypeDefinition<?> typeDef = leaf.getType();
 728         if (isInnerType(leaf, typeDef)) {
 729             if (typeDef instanceof EnumTypeDefinition) {
 730                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
 731                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
 732                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
 733                         genCtx, typeBuilder, module);
 734                 if (enumBuilder != null) {
 735                     returnType = enumBuilder.toInstance(typeBuilder);
 736                 }
 737                 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
 738             } else if (typeDef instanceof UnionTypeDefinition) {
 739                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
 740                         typeProvider, schemaContext);
 741                 if (genTOBuilder != null) {
 742                     //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
 743                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
 744                 }
 745             } else if (typeDef instanceof BitsTypeDefinition) {
 746                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
 747                         typeProvider, schemaContext);
 748                 if (genTOBuilder != null) {
 749                     returnType = genTOBuilder.toInstance();
 750                 }
 751             } else {
 752                 // It is constrained version of already declared type (inner declared type exists,
 753                 // onlyfor special cases (Enum, Union, Bits), which were already checked.
 754                 // In order to get proper class we need to look up closest derived type
 755                 // and apply restrictions from leaf type
 756                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 757                 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
 758                         restrictions);
 759             }
 760         } else {
 761             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 762             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
 763         }
 764
 765         if (returnType == null) {
 766             return null;
 767         }
 768
 769         if (typeDef instanceof EnumTypeDefinition) {
 770             ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
 771         }
 772
 773         String leafDesc = leaf.getDescription();
 774         if (leafDesc == null) {
 775             leafDesc = "";
 776         }
 777
 778         final String leafGetterName;
 779         if (!"".equals(nodeName)) {
 780             StringBuilder sb = new StringBuilder(nodeName)
 781                 .append('_')
 782                 .append(leafName);
 783             leafGetterName = sb.toString();
 784         } else {
 785             leafGetterName = leafName;
 786         }
 787
 788         constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
 789         return returnType;
 790     }
 791
 792     /**
 793      * Converts <code>node</code> leaf list schema node to getter method of
 794      * <code>typeBuilder</code>.
 795      *
 796      * @param typeBuilder
 797      *            generated type builder to which is <code>node</code> added as
 798      *            getter method
 799      * @param node
 800      *            leaf list schema node which is added to
 801      *            <code>typeBuilder</code> as getter method
 802      * @param module module
 803      * @param typeProvider type provider instance
 804      * @param genCtx actual generated context
 805      * @return boolean value
 806      *         <ul>
 807      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,
 808      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>
 809      *         <li>false - other cases</li>
 810      *         </ul>
 811      */
 812     private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
 813             typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
 814             final Map<Module, ModuleContext> genCtx) {
 815         if (node == null || typeBuilder == null || node.isAddedByUses()) {
 816             return false;
 817         }
 818
 819         final QName nodeName = node.getQName();
 820
 821         final TypeDefinition<?> typeDef = node.getType();
 822         final Module parentModule = findParentModule(schemaContext, node);
 823
 824         Type returnType = null;
 825         if (typeDef.getBaseType() == null) {
 826             if (typeDef instanceof EnumTypeDefinition) {
 827                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
 828                 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
 829                 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
 830                         genCtx, typeBuilder, module);
 831                 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
 832                 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
 833             } else if (typeDef instanceof UnionTypeDefinition) {
 834                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
 835                         typeProvider, schemaContext);
 836                 if (genTOBuilder != null) {
 837                     returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
 838                 }
 839             } else if (typeDef instanceof BitsTypeDefinition) {
 840                 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
 841                         typeProvider, schemaContext);
 842                 returnType = genTOBuilder.toInstance();
 843             } else {
 844                 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 845                 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
 846             }
 847         } else {
 848             final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
 849             returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
 850         }
 851
 852         final ParameterizedType listType = Types.listTypeFor(returnType);
 853         constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
 854         return true;
 855     }
 856
 857     /**
 858      * Converts <code>caseNodes</code> set to list of corresponding generated
 859      * types.
 860      *
 861      * For every <i>case</i> which isn't added through augment or <i>uses</i> is
 862      * created generated type builder. The package names for the builder is
 863      * created as concatenation of the module package (
 864      * <code>basePackageName</code>) and names of all parents nodes of the
 865      * concrete <i>case</i>. There is also relation "<i>implements type</i>"
 866      * between every case builder and <i>choice</i> type
 867      *
 868      * @param module
 869      *            current module
 870      * @param schemaContext
 871      *            current schema context
 872      * @param genCtx
 873      *            actual generated context
 874      * @param basePackageName
 875      *            string with the module package name
 876      * @param refChoiceType
 877      *            type which represents superior <i>case</i>
 878      * @param choiceNode
 879      *            choice case node which is mapped to generated type
 880      * @param verboseClassComments
 881      *            Javadoc verbosity switch
 882      * @throws IllegalArgumentException
 883      *             <ul>
 884      *             <li>if <code>basePackageName</code> equals null</li>
 885      *             <li>if <code>refChoiceType</code> equals null</li>
 886      *             <li>if <code>caseNodes</code> equals null</li>
 887      *             </ul>
 888      */
 889     private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
 890             final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
 891             final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
 892             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
 893         checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
 894         checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
 895         checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
 896
 897         final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
 898         if (caseNodes == null) {
 899             return;
 900         }
 901
 902         for (final ChoiceCaseNode caseNode : caseNodes) {
 903             if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
 904                 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath(),
 905                     BindingNamespaceType.Data);
 906                 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, 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         final String packageName = packageNameForGeneratedType(basePackageName, node.getPath(), namespaceType);
1099         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, 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, verboseClassComments));
1104         genType.setModuleName(module.getName());
1105         genType.setReference(node.getReference());
1106         genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1107         genType.setParentTypeForBuilder(childOf);
1108         if (node instanceof DataNodeContainer) {
1109             genCtx.get(module).addChildNodeType(node, genType);
1110             genCtx = groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings(), genCtx, schemaContext,
1111                     verboseClassComments, genTypeBuilders, typeProvider);
1112             processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
1113                     verboseClassComments, typeProvider, namespaceType);
1114         }
1115         return genType;
1116     }
1117
1118     /**
1119      * Converts all <b>groupings</b> of the module to the list of
1120      * <code>Type</code> objects. Firstly are groupings sorted according mutual
1121      * dependencies. At least dependent (independent) groupings are in the list
1122      * saved at first positions. For every grouping the record is added to map
1123      * {@link ModuleContext#groupings allGroupings}
1124      *
1125      * @param module
1126      *            current module
1127      * @param groupings
1128      *            collection of groupings from which types will be generated
1129      * @param typeProvider
1130      *            provider that defines contract for generated types
1131      * @param schemaContext
1132      *            schema context
1133      * @param genCtx
1134      *            map of generated entities in context of YANG modules
1135      * @param genTypeBuilders
1136      *            map of generated type builders
1137      * @param verboseClassComments
1138      *            generate verbose comments
1139      *
1140      */
1141     static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1142             groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1143             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1144         final String basePackageName = BindingMapping.getRootPackageName(module);
1145         final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1146                 .sort(groupings);
1147         for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1148             genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1149                     verboseClassComments, genTypeBuilders, typeProvider);
1150         }
1151         return genCtx;
1152     }
1153
1154     /**
1155      * Converts individual grouping to GeneratedType. Firstly generated type
1156      * builder is created and every child node of grouping is resolved to the
1157      * method.
1158      *
1159      * @param basePackageName
1160      *            string contains the module package name
1161      * @param grouping
1162      *            GroupingDefinition which contains data about grouping
1163      * @param module
1164      *            current module
1165      * @param typeProvider
1166      *            provider that defines contract for generated types
1167      * @param schemaContext
1168      *            schema context
1169      * @param genCtx
1170      *            map of generated entities in context of YANG modules
1171      * @param genTypeBuilders
1172      *            map of generated type builders
1173      * @param verboseClassComments
1174      *            generate verbose comments
1175      *
1176      * @return GeneratedType which is generated from grouping (object of type
1177      *         <code>GroupingDefinition</code>)
1178      */
1179     private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1180             module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1181             verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1182         final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath(), BindingNamespaceType.Grouping);
1183         final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, 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));
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 }