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