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