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