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