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