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

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