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