2 * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.mdsal.binding.javav2.generator.impl;
11 import static com.google.common.base.Preconditions.checkArgument;
12 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.addTOToTypeBuilder;
13 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.annotateDeprecatedIfNecessary;
14 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.augGenTypeName;
15 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.constructGetter;
16 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createDescription;
17 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createReturnTypeForUnion;
18 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.getAugmentIdentifier;
19 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.isInnerType;
20 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.qNameConstant;
21 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveInnerEnumFromTypeDefinition;
22 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTOBuilder;
23 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.computeDefaultSUID;
24 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
25 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
26 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.INSTANTIABLE;
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.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
32 import com.google.common.annotations.Beta;
33 import com.google.common.base.Preconditions;
34 import com.google.common.collect.Iterables;
35 import java.util.Collection;
36 import java.util.HashMap;
37 import java.util.List;
40 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
41 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
42 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
43 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
49 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
50 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
51 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
52 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
53 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
54 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
55 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
56 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
57 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
58 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
59 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
60 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
61 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
62 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
63 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
64 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
65 import org.opendaylight.yangtools.yang.common.QName;
66 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
67 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
68 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
69 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
70 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
72 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
73 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
75 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.Module;
79 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
80 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
81 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
83 import org.opendaylight.yangtools.yang.model.api.Status;
84 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
85 import org.opendaylight.yangtools.yang.model.api.UsesNode;
86 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
87 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
88 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
89 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
92 * Helper util class used for generation of types in Binding spec v2.
95 final class GenHelperUtil {
97 private GenHelperUtil() {
98 throw new UnsupportedOperationException("Util class");
102 * Create GeneratedTypeBuilder object from module argument.
105 * Module object from which builder will be created
107 * @param verboseClassComments
109 * @return <code>GeneratedTypeBuilder</code> which is internal
110 * representation of the module
111 * @throws IllegalArgumentException
114 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
115 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
117 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments);
118 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
119 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
120 moduleDataTypeBuilder.addComment(module.getDescription());
121 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
122 moduleDataTypeBuilder.setReference(module.getReference());
123 return moduleDataTypeBuilder;
127 * Generates type builder for <code>module</code>.
130 * Module which is source of package name for generated type
133 * string which is added to the module class name representation
135 * @param verboseClassComments
136 * @return instance of GeneratedTypeBuilder which represents
137 * <code>module</code>.
138 * @throws IllegalArgumentException
139 * if <code>module</code> is null
141 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
142 verboseClassComments) {
143 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
144 final String packageName = BindingMapping.getRootPackageName(module);
145 // underscore used as separator for distinction of module name parts
146 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
148 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
149 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
150 moduleBuilder.setReference(module.getReference());
151 moduleBuilder.setModuleName(moduleName);
153 return moduleBuilder;
157 * Adds the implemented types to type builder.
159 * The method passes through the list of <i>uses</i> in
160 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
161 * generated type from all groupings
162 * allGroupings} which is added as <i>implements type</i> to
163 * <code>builder</code>
165 * @param dataNodeContainer
166 * element which contains the list of used YANG groupings
168 * builder to which are added implemented types according to
169 * <code>dataNodeContainer</code>
170 * @param genCtx generated context
171 * @return generated type builder with all implemented types
173 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
174 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
175 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
176 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
177 if (genType == null) {
178 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
179 + builder.getName());
181 builder.addImplementsType(genType);
186 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
187 for (final ModuleContext ctx : genCtx.values()) {
188 final GeneratedTypeBuilder result = ctx.getGrouping(path);
189 if (result != null) {
197 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
198 * node for which <code>typeBuilder</code> was created.
200 * The subnodes aren't mapped to the methods if they are part of grouping or
201 * augment (in this case are already part of them).
205 * @param basePackageName
206 * string contains the module package name
208 * generated type builder which represents any node. The subnodes
209 * of this node are added to the <code>typeBuilder</code> as
210 * methods. The subnode can be of type leaf, leaf-list, list,
215 * set of data schema nodes which are the children of the node
216 * for which <code>typeBuilder</code> was created
217 * @return generated type builder which is the same builder as input
218 * parameter. The getter methods (representing child nodes) could be
221 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
222 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
223 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
224 final SchemaContext schemaContext, final boolean verboseClassComments,
225 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
226 final TypeProvider typeProvider) {
228 if (schemaNodes != null && parent != null) {
229 for (final DataSchemaNode schemaNode : schemaNodes) {
230 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
231 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
232 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
239 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
240 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
241 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
242 final TypeProvider typeProvider) {
243 return addDefaultInterfaceDefinition(packageName, schemaNode, null, module, genCtx, schemaContext,
244 verboseClassComments, genTypeBuilders, typeProvider);
247 static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
248 DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
249 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
250 final boolean verboseClassComments, final TypeProvider typeProvider) {
251 final String basePackageName = BindingMapping.getRootPackageName(module);
252 for (final UsesNode usesNode : node.getUses()) {
253 for (final AugmentationSchema augment : usesNode.getAugmentations()) {
254 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName, augment, module,
255 usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider);
256 genCtx = processUsesAugments(schemaContext, augment, module, genCtx, genTypeBuilders,
257 verboseClassComments, typeProvider);
263 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
264 for (final ModuleContext ctx : genCtx.values()) {
265 final GeneratedTypeBuilder result = ctx.getChildNode(path);
266 if (result != null) {
273 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
274 for (final ModuleContext ctx : genCtx.values()) {
275 final GeneratedTypeBuilder result = ctx.getCase(path);
276 if (result != null) {
284 * Returns a generated type builder for an augmentation.
286 * The name of the type builder is equal to the name of augmented node with
287 * serial number as suffix.
291 * @param augmentPackageName
292 * string with contains the package name to which the augment
294 * @param basePackageName
295 * string with the package name to which the augmented node
297 * @param targetTypeRef
300 * augmentation schema which contains data about the child nodes
301 * and uses of augment
302 * @return generated type builder for augment in genCtx
304 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
305 final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema,
306 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module,
307 ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments, final
308 TypeProvider typeProvider) {
310 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(augmentPackageName, k -> new HashMap<>());
311 String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
313 if (augIdentifier == null) {
314 augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
317 GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier);
319 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
320 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
321 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
322 augTypeBuilder = addImplementedInterfaceFromUses(augSchema, augTypeBuilder, genCtx);
324 augTypeBuilder = augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema
325 .getChildNodes(), genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders);
326 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
328 if(!augSchema.getChildNodes().isEmpty()) {
329 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
332 genCtx.get(module).addAugmentType(augTypeBuilder);
337 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
338 * node for which <code>typeBuilder</code> was created.
342 * @param basePackageName
343 * string contains the module package name
345 * generated type builder which represents any node. The subnodes
346 * of this node are added to the <code>typeBuilder</code> as
347 * methods. The subnode can be of type leaf, leaf-list, list,
352 * set of data schema nodes which are the children of the node
353 * for which <code>typeBuilder</code> was created
354 * @return generated type builder which is the same object as the input
355 * parameter <code>typeBuilder</code>. The getter method could be
358 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
359 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
360 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
361 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
362 GeneratedTypeBuilder>> genTypeBuilders) {
363 if (schemaNodes != null && typeBuilder != null) {
364 for (final DataSchemaNode schemaNode : schemaNodes) {
365 if (!schemaNode.isAugmenting()) {
366 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
367 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
375 * Instantiates generated type builder with <code>packageName</code> and
376 * <code>schemaNode</code>.
378 * The new builder always implements
379 * {@link TreeNode TreeNode}.<br>
380 * If <code>schemaNode</code> is instance of GroupingDefinition it also
381 * implements {@link Augmentable
383 * If <code>schemaNode</code> is instance of
384 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
385 * DataNodeContainer} it can also implement nodes which are specified in
389 * string with the name of the package to which
390 * <code>schemaNode</code> belongs.
392 * schema node for which is created generated type builder
394 * parent type (can be null)
395 * @param schemaContext schema context
396 * @return generated type builder <code>schemaNode</code>
398 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode
399 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
400 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
401 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
403 GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, schemaContext, "",
404 verboseClassComments, genTypeBuilders);
405 if (parent == null) {
406 it.addImplementsType(BindingTypes.TREE_NODE);
408 if (parent instanceof ListSchemaNode) {
409 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
410 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
412 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
413 (BindingTypes.ITEM, parent)));
414 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
418 if (!(schemaNode instanceof GroupingDefinition)) {
419 it.addImplementsType(BindingTypes.augmentable(it));
422 if (schemaNode instanceof DataNodeContainer) {
423 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
424 verboseClassComments, genTypeBuilders, typeProvider);
425 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
431 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
432 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
433 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
434 genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
436 processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
437 verboseClassComments, typeProvider);
439 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
440 (basePackageName, notification, null, module, genCtx, schemaContext,
441 verboseClassComments, genTypeBuilders, typeProvider);
442 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
443 notificationInterface.addImplementsType(NOTIFICATION);
444 genCtx.get(module).addChildNodeType(notification, notificationInterface);
446 // Notification object
447 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
448 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
449 verboseClassComments, genTypeBuilders, typeProvider);
451 //in case of tied notification, incorporate parent's localName
452 final StringBuilder sb = new StringBuilder("on_");
453 if (parentName != null) {
454 sb.append(parentName).append('_');
456 sb.append(notificationInterface.getName());
458 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
459 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
460 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
461 return listenerInterface;
465 * Returns reference to generated type builder for specified
466 * <code>schemaNode</code> with <code>packageName</code>.
468 * Firstly the generated type builder is searched in
469 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
470 * found it is created and added to <code>genTypeBuilders</code>.
473 * string with the package name to which returning generated type
476 * schema node which provide data about the schema node name
477 * @param schemaContext schema context
479 * return type name prefix
480 * @return generated type builder for <code>schemaNode</code>
481 * @throws IllegalArgumentException
483 * <li>if <code>schemaNode</code> is null</li>
484 * <li>if <code>packageName</code> is null</li>
485 * <li>if QName of schema node is null</li>
486 * <li>if schemaNode name is null</li>
490 static GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
491 final SchemaContext schemaContext, final String prefix, final boolean verboseClassComments,
492 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders) {
494 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
495 Preconditions.checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
496 String schemaNodeName = schemaNode.getQName().getLocalName();
497 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
499 if (prefix != null && !prefix.isEmpty()) {
500 // underscore used as separator for distinction of class name parts
501 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
504 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
505 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
506 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
507 newType.addComment(schemaNode.getDescription());
508 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext, verboseClassComments));
509 newType.setReference(schemaNode.getReference());
510 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
511 newType.setModuleName(module.getName());
513 if (!genTypeBuilders.containsKey(packageName)) {
514 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
515 builders.put(newType.getName(), newType);
516 genTypeBuilders.put(packageName, builders);
518 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
519 if (!builders.containsKey(newType.getName())) {
520 builders.put(newType.getName(), newType);
527 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
528 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
529 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
530 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
531 //TODO: implement rest of schema nodes GTO building
532 if (node != null && typeBuilder != null) {
533 if (node instanceof ContainerSchemaNode) {
534 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
535 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
536 } else if (node instanceof LeafSchemaNode) {
537 resolveLeafSchemaNodeAsMethod(schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
539 } else if (node instanceof ListSchemaNode) {
540 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
541 verboseClassComments, genCtx, genTypeBuilders, typeProvider);
542 } else if (node instanceof AnyXmlSchemaNode) {
543 resolveAnyxmlNodeAsMethod(schemaContext, typeBuilder, genCtx, (AnyXmlSchemaNode) node, module,
545 } else if (node instanceof ChoiceSchemaNode) {
546 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
547 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider);
554 * Converts <code>choiceNode</code> to the list of generated types for
555 * choice and its cases.
557 * The package names for choice and for its cases are created as
558 * concatenation of the module package (<code>basePackageName</code>) and
559 * names of all parents node.
563 * @param basePackageName
564 * string with the module package name
568 * choice node which is mapped to generated type. Also child
569 * nodes - cases are mapped to generated types.
570 * @throws IllegalArgumentException
572 * <li>if <code>basePackageName</code> is null</li>
573 * <li>if <code>choiceNode</code> is null</li>
576 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
577 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
578 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
579 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider) {
580 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
581 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
583 if (!choiceNode.isAddedByUses()) {
584 final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath(),
585 BindingNamespaceType.Data);
586 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode,
587 schemaContext, "", verboseClasssComments, genTypeBuilders);
588 constructGetter(parent, choiceNode.getQName().getLocalName(),
589 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
590 choiceTypeBuilder.addImplementsType(INSTANTIABLE);
591 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
592 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
593 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
594 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders);
598 private static void containerToGenType(final Module module, final String basePackageName,
599 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
600 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
601 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
603 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
604 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
605 if (genType != null) {
606 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType, node.getStatus());
607 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
608 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
612 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
613 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
614 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
615 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
616 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
617 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
618 if (genType != null) {
619 final String nodeName = node.getQName().getLocalName();
620 constructGetter(parent, nodeName, node.getDescription(),
621 Types.listTypeFor(genType), node.getStatus());
622 final List<QName> listKeys = node.getKeyDefinition();
623 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
624 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
626 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
628 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
629 if (!schemaNode.isAugmenting()) {
630 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
631 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments);
636 if (genTOBuilder != null) {
637 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
638 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
639 genTOBuilder.setSUID(prop);
642 typeBuildersToGenTypes(module, genType, genTOBuilder, genCtx);
646 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
647 final GeneratedTOBuilder genTOBuilder, final Map<Module, ModuleContext> genCtx) {
648 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
649 if (genTOBuilder != null) {
650 final GeneratedTransferObject genTO = genTOBuilder.toInstance();
651 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
652 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
657 * Converts <code>leaf</code> to the getter method which is added to
658 * <code>typeBuilder</code>.
661 * generated type builder to which is added getter method as
662 * <code>leaf</code> mapping
664 * leaf schema node which is mapped as getter method which is
665 * added to <code>typeBuilder</code>
667 * Module in which type was defined
668 * @return boolean value
670 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
672 * <li>true - in other cases</li>
675 private static Type resolveLeafSchemaNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
676 typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf, final Module module,
677 final TypeProvider typeProvider) {
678 if (leaf == null || typeBuilder == null || leaf.isAddedByUses()) {
682 final String leafName = leaf.getQName().getLocalName();
683 if (leafName == null) {
687 final Module parentModule = findParentModule(schemaContext, leaf);
688 Type returnType = null;
690 final TypeDefinition<?> typeDef = leaf.getType();
691 if (isInnerType(leaf, typeDef)) {
692 if (typeDef instanceof EnumTypeDefinition) {
693 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
694 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
695 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
696 genCtx, typeBuilder, module);
697 if (enumBuilder != null) {
698 returnType = enumBuilder.toInstance(typeBuilder);
700 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
701 } else if (typeDef instanceof UnionTypeDefinition) {
702 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
703 typeProvider, schemaContext);
704 if (genTOBuilder != null) {
705 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
706 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
708 } else if (typeDef instanceof BitsTypeDefinition) {
709 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
710 typeProvider, schemaContext);
711 if (genTOBuilder != null) {
712 returnType = genTOBuilder.toInstance();
715 // It is constrained version of already declared type (inner declared type exists,
716 // onlyfor special cases (Enum, Union, Bits), which were already checked.
717 // In order to get proper class we need to look up closest derived type
718 // and apply restrictions from leaf type
719 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
720 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
724 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
725 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
728 if (returnType == null) {
732 if (typeDef instanceof EnumTypeDefinition) {
733 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
736 String leafDesc = leaf.getDescription();
737 if (leafDesc == null) {
741 constructGetter(typeBuilder, leafName, leafDesc, returnType, leaf.getStatus());
746 * Converts <code>caseNodes</code> set to list of corresponding generated
749 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
750 * created generated type builder. The package names for the builder is
751 * created as concatenation of the module package (
752 * <code>basePackageName</code>) and names of all parents nodes of the
753 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
754 * between every case builder and <i>choice</i> type
758 * @param schemaContext
759 * current schema context
761 * actual generated context
762 * @param basePackageName
763 * string with the module package name
764 * @param refChoiceType
765 * type which represents superior <i>case</i>
767 * choice case node which is mapped to generated type
768 * @param verboseClassComments
769 * Javadoc verbosity switch
770 * @throws IllegalArgumentException
772 * <li>if <code>basePackageName</code> equals null</li>
773 * <li>if <code>refChoiceType</code> equals null</li>
774 * <li>if <code>caseNodes</code> equals null</li>
777 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
778 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
779 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
780 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders) {
781 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
782 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
783 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
785 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
786 if (caseNodes == null) {
790 for (final ChoiceCaseNode caseNode : caseNodes) {
791 if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
792 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath(),
793 BindingNamespaceType.Data);
794 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode,
795 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
796 caseTypeBuilder.addImplementsType(refChoiceType);
797 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
798 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
799 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
800 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
801 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
802 if (caseChildNodes != null) {
803 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
805 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
806 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
808 if (parent instanceof AugmentationSchema) {
809 final AugmentationSchema augSchema = (AugmentationSchema) parent;
810 final SchemaPath targetPath = augSchema.getTargetPath();
811 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
812 if (targetSchemaNode instanceof DataSchemaNode
813 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
814 if (targetSchemaNode instanceof DerivableSchemaNode) {
815 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
817 if (targetSchemaNode == null) {
818 throw new IllegalStateException(
819 "Failed to find target node from grouping for augmentation " + augSchema
820 + " in module " + module.getName());
823 parent = targetSchemaNode;
826 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
827 choiceNodeParentPath);
828 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
829 if (childOfType == null) {
830 childOfType = findGroupingByPath(parent.getPath(), genCtx);
832 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
833 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
835 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
836 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
837 verboseClassComments, genTypeBuilders, typeProvider);
841 processUsesAugments(schemaContext, caseNode, module, genCtx, genTypeBuilders, verboseClassComments,
846 private static Type resolveAnyxmlNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
847 typeBuilder, final Map<Module, ModuleContext> genCtx, final AnyXmlSchemaNode anyxml, final Module module,
848 final TypeProvider typeProvider) {
850 final String anyxmlName = anyxml.getQName().getLocalName();
851 if (anyxmlName == null) {
855 String anyxmlDesc = anyxml.getDescription();
856 if (anyxmlDesc == null) {
860 Type returnType = Types.DOCUMENT;
862 constructGetter(typeBuilder, anyxmlName, anyxmlDesc, returnType, anyxml.getStatus());
868 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
869 * or to <code>genTOBuilder</code> as property.
872 * string contains the name of list
873 * @param basePackageName
874 * string contains the module package name
876 * data schema node which should be added as getter method to
877 * <code>typeBuilder</code> or as a property to
878 * <code>genTOBuilder</code> if is part of the list key
880 * generated type builder for the list schema node
881 * @param genTOBuilder
882 * generated TO builder for the list keys
884 * list of string which contains QNames of the list keys
887 * @param typeProvider
888 * provider that defines contract for generated types
889 * @param schemaContext
892 * map of generated entities in context of YANG modules
893 * @param genTypeBuilders
894 * map of generated type builders
895 * @param verboseClassComments
896 * generate verbose comments
897 * @throws IllegalArgumentException
899 * <li>if <code>schemaNode</code> equals null</li>
900 * <li>if <code>typeBuilder</code> equals null</li>
903 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
904 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
905 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
906 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
907 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments) {
908 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
909 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
911 if (schemaNode instanceof LeafSchemaNode) {
912 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
913 final QName leafQName = leaf.getQName();
914 final String leafName = leafQName.getLocalName();
915 String leafPckgName = basePackageName;
916 boolean isKeyPart = false;
917 if (listKeys.contains(leafQName)) {
918 leafPckgName = new StringBuilder(leafPckgName).append('.').append(BindingNamespaceType.Key).append('.')
919 .append(nodeName).toString();
922 leafPckgName = new StringBuilder(leafPckgName).append('.').append(BindingNamespaceType.Data).append('.')
923 .append(nodeName).toString();
926 final String leafGTOName = new StringBuilder(nodeName).append('_').append(leafName).toString();
927 final GeneratedTypeBuilder leafGTp = new GeneratedTypeBuilderImpl(leafPckgName, leafGTOName);
928 resolveLeafSchemaNodeAsMethod(schemaContext, leafGTp, genCtx, leaf, module,
931 constructGetter(typeBuilder, leafGTOName, schemaNode.getDescription(), leafGTp, Status.CURRENT);
934 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, leafGTp, true);
936 } else if (!schemaNode.isAddedByUses()) {
937 //TODO: implement leaf list to generated type
938 if (schemaNode instanceof ContainerSchemaNode) {
939 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
940 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
941 } else if (schemaNode instanceof ListSchemaNode) {
942 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
943 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider);
944 } else if (schemaNode instanceof ChoiceSchemaNode) {
945 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
946 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider);
951 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
952 final TypeDefinition<?> baseType = typeDef.getBaseType();
953 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
956 @SuppressWarnings({ "rawtypes", "unchecked" })
957 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
958 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
959 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
960 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
962 if (node.isAugmenting() || node.isAddedByUses()) {
965 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath(), BindingNamespaceType.Data);
966 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module,
967 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
968 genType.addComment(node.getDescription());
969 annotateDeprecatedIfNecessary(node.getStatus(), genType);
970 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext, verboseClassComments));
971 genType.setModuleName(module.getName());
972 genType.setReference(node.getReference());
973 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
974 genType.setParentTypeForBuilder(childOf);
975 if (node instanceof DataNodeContainer) {
976 genCtx.get(module).addChildNodeType(node, genType);
977 genCtx = groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings(), genCtx, schemaContext,
978 verboseClassComments, genTypeBuilders, typeProvider);
979 processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
980 verboseClassComments, typeProvider);
986 * Converts all <b>groupings</b> of the module to the list of
987 * <code>Type</code> objects. Firstly are groupings sorted according mutual
988 * dependencies. At least dependent (independent) groupings are in the list
989 * saved at first positions. For every grouping the record is added to map
990 * {@link ModuleContext#groupings allGroupings}
995 * collection of groupings from which types will be generated
996 * @param typeProvider
997 * provider that defines contract for generated types
998 * @param schemaContext
1001 * map of generated entities in context of YANG modules
1002 * @param genTypeBuilders
1003 * map of generated type builders
1004 * @param verboseClassComments
1005 * generate verbose comments
1008 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1009 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1010 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1011 final String basePackageName = BindingMapping.getRootPackageName(module);
1012 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1014 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1015 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1016 verboseClassComments, genTypeBuilders, typeProvider);
1022 * Converts individual grouping to GeneratedType. Firstly generated type
1023 * builder is created and every child node of grouping is resolved to the
1026 * @param basePackageName
1027 * string contains the module package name
1029 * GroupingDefinition which contains data about grouping
1032 * @param typeProvider
1033 * provider that defines contract for generated types
1034 * @param schemaContext
1037 * map of generated entities in context of YANG modules
1038 * @param genTypeBuilders
1039 * map of generated type builders
1040 * @param verboseClassComments
1041 * generate verbose comments
1043 * @return GeneratedType which is generated from grouping (object of type
1044 * <code>GroupingDefinition</code>)
1046 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1047 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1048 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1049 final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath(), BindingNamespaceType.Grouping);
1050 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module, genCtx,
1051 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1052 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1053 genCtx.get(module).addGroupingType(grouping.getPath(), genType);
1054 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1055 schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
1056 genCtx = groupingsToGenTypes(module, grouping.getGroupings(), genCtx, schemaContext, verboseClassComments,
1057 genTypeBuilders, typeProvider);
1058 genCtx = processUsesAugments(schemaContext, grouping, module, genCtx, genTypeBuilders, verboseClassComments,
1064 * //TODO: add information about multiple base identities in YANG 1.1
1065 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1066 * created transport object builder. If identity contains base identity then
1067 * reference to base identity is added to superior identity as its extend.
1068 * If identity doesn't contain base identity then only reference to abstract
1069 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1070 * BaseIdentity} is added
1074 * @param basePackageName
1075 * string contains the module package name
1077 * IdentitySchemaNode which contains data about identity
1078 * @param schemaContext
1079 * SchemaContext which is used to get package and name
1080 * information about base of identity
1081 * @param genCtx generated context
1082 * @return returns generated context
1084 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1085 final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1086 boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
1087 final TypeProvider typeProvider, Map<QName, GeneratedTOBuilderImpl> generatedIdentities) {
1089 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1090 BindingNamespaceType.Identity);
1091 final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName,
1092 identity.getQName().getLocalName());
1094 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1095 if (baseIdentities.size() == 0) {
1096 //no base - abstract
1097 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1098 BaseIdentity.class.getSimpleName());
1099 newType.setExtendsType(gto.toInstance());
1100 generatedIdentities.put(identity.getQName(), newType);
1102 //one base - inheritance
1103 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1104 final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(schemaContext, baseIdentity);
1105 final String returnTypePkgName = new StringBuilder(BindingMapping.getRootPackageName
1106 (baseIdentityParentModule))
1108 .append(BindingNamespaceType.Identity.getPackagePrefix())
1111 final GeneratedTOBuilderImpl existingIdentityGto = generatedIdentities.get(baseIdentity.getQName());
1112 if (existingIdentityGto != null) {
1113 newType.setExtendsType(existingIdentityGto.toInstance());
1115 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(returnTypePkgName,
1116 baseIdentity.getQName().getLocalName());
1117 newType.setExtendsType(gto.toInstance());
1118 generatedIdentities.put(baseIdentity.getQName(), gto);
1121 //FIXME: more bases - possible composition, multiple inheritance not possible
1123 generatedIdentities.put(identity.getQName(), newType);
1125 newType.setAbstract(true);
1126 newType.addComment(identity.getDescription());
1127 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1128 verboseClassComments));
1129 newType.setReference(identity.getReference());
1130 newType.setModuleName(module.getName());
1131 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1133 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1135 genCtx.get(module).addIdentityType(identity.getQName(), newType);