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.NOTIFICATION;
27 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
28 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
29 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
31 import com.google.common.annotations.Beta;
32 import com.google.common.base.Preconditions;
33 import com.google.common.collect.Iterables;
34 import java.util.Collection;
35 import java.util.HashMap;
36 import java.util.List;
39 import java.util.stream.Collectors;
40 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
41 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
42 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
43 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
50 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
51 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
52 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
53 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
54 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
55 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
56 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
57 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
58 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
59 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
60 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
63 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
64 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
65 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
66 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
67 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
68 import org.opendaylight.yangtools.yang.common.QName;
69 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
70 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
72 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
73 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
74 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
77 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
79 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
80 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.Module;
85 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
86 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
87 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
89 import org.opendaylight.yangtools.yang.model.api.Status;
90 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
91 import org.opendaylight.yangtools.yang.model.api.UsesNode;
92 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
93 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
94 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
96 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
99 * Helper util class used for generation of types in Binding spec v2.
102 final class GenHelperUtil {
104 private GenHelperUtil() {
105 throw new UnsupportedOperationException("Util class");
109 * Create GeneratedTypeBuilder object from module argument.
112 * Module object from which builder will be created
113 * @param genCtx generated context
114 * @param verboseClassComments verbosity switch
116 * @return <code>GeneratedTypeBuilder</code> which is internal
117 * representation of the module
118 * @throws IllegalArgumentException
121 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
122 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
124 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments);
125 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
126 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
127 moduleDataTypeBuilder.addComment(module.getDescription());
128 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
129 moduleDataTypeBuilder.setReference(module.getReference());
130 return moduleDataTypeBuilder;
134 * Generates type builder for <code>module</code>.
137 * Module which is source of package name for generated type
140 * string which is added to the module class name representation
142 * @param verboseClassComments verbosity switch
143 * @return instance of GeneratedTypeBuilder which represents
144 * <code>module</code>.
145 * @throws IllegalArgumentException
146 * if <code>module</code> is null
148 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
149 verboseClassComments) {
150 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
151 final String packageName = BindingMapping.getRootPackageName(module);
152 // underscore used as separator for distinction of module name parts
153 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
155 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
156 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
157 moduleBuilder.setReference(module.getReference());
158 moduleBuilder.setModuleName(moduleName);
159 return moduleBuilder;
163 * Adds the implemented types to type builder.
165 * The method passes through the list of <i>uses</i> in
166 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
167 * generated type from all groupings
168 * allGroupings} which is added as <i>implements type</i> to
169 * <code>builder</code>
171 * @param dataNodeContainer
172 * element which contains the list of used YANG groupings
174 * builder to which are added implemented types according to
175 * <code>dataNodeContainer</code>
176 * @param genCtx generated context
177 * @return generated type builder with all implemented types
179 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
180 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
181 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
182 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
183 if (genType == null) {
184 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
185 + builder.getName());
187 builder.addImplementsType(genType);
192 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
193 for (final ModuleContext ctx : genCtx.values()) {
194 final GeneratedTypeBuilder result = ctx.getGrouping(path);
195 if (result != null) {
203 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
204 * node for which <code>typeBuilder</code> was created.
206 * The subnodes aren't mapped to the methods if they are part of grouping or
207 * augment (in this case are already part of them).
211 * @param basePackageName
212 * string contains the module package name
214 * generated type builder which represents any node. The subnodes
215 * of this node are added to the <code>typeBuilder</code> as
216 * methods. The subnode can be of type leaf, leaf-list, list,
221 * set of data schema nodes which are the children of the node
222 * for which <code>typeBuilder</code> was created
223 * @return generated type builder which is the same builder as input
224 * parameter. The getter methods (representing child nodes) could be
227 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
228 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
229 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
230 final SchemaContext schemaContext, final boolean verboseClassComments,
231 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
232 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
234 if (schemaNodes != null && parent != null) {
235 for (final DataSchemaNode schemaNode : schemaNodes) {
236 if (!schemaNode.isAugmenting()) {
237 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
238 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
245 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
246 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
247 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
248 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
249 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
250 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
253 static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
254 DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
255 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
256 final boolean verboseClassComments, final TypeProvider typeProvider,
257 final BindingNamespaceType namespaceType) {
258 final String basePackageName = BindingMapping.getRootPackageName(module);
259 for (final UsesNode usesNode : node.getUses()) {
260 Map<SchemaPath, List<AugmentationSchema>> augmentationsGrouped =
261 usesNode.getAugmentations().stream().collect(Collectors.groupingBy(AugmentationSchema::getTargetPath));
262 for (Map.Entry<SchemaPath, List<AugmentationSchema>> schemaPathAugmentListEntry : augmentationsGrouped.entrySet()) {
263 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName,
264 schemaPathAugmentListEntry.getValue(), module,
265 usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider, namespaceType);
266 for (AugmentationSchema augSchema : schemaPathAugmentListEntry.getValue()) {
267 genCtx = processUsesAugments(schemaContext, augSchema, module, genCtx, genTypeBuilders,
268 verboseClassComments, typeProvider, namespaceType);
276 static void addUsesImplements(final DataNodeContainer superNode, final Module superModule,
277 final DataNodeContainer node, final Module module,
278 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType ) {
279 for (SchemaNode superChildNode : superNode.getChildNodes()) {
280 if (superChildNode instanceof DataNodeContainer) {
281 final QName childQName = QName.create(((SchemaNode)node).getQName(), superChildNode.getQName().getLocalName());
282 DataSchemaNode childNode = node.getDataChildByName(childQName);
283 Preconditions.checkNotNull(childNode, ((SchemaNode) node).getPath() + "->" + childQName.toString());
285 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
286 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
288 //TODO:delete this after supporting uses augment
289 if (type == null || superType == null) {
292 Preconditions.checkNotNull(type, module.toString() + "->" + childNode.getPath().toString());
293 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superChildNode.getPath().toString());
294 type.addImplementsType(superType);
295 addUsesImplements((DataNodeContainer)superChildNode, superModule, (DataNodeContainer)childNode, module, schemaContext, genCtx, namespaceType);
300 static Map<Module, ModuleContext> processUsesImplements(final DataNodeContainer node, final Module module,
301 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
303 for (final UsesNode usesNode : node.getUses()) {
304 final SchemaNode groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
305 Preconditions.checkNotNull(groupingNode, module.toString() + "->"
306 + usesNode.getGroupingPath().toString());
307 Preconditions.checkState(groupingNode instanceof GroupingDefinition,
308 module.toString() + "->" + usesNode.getGroupingPath().toString());
309 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, groupingNode);
310 GroupingDefinition grouping = (GroupingDefinition)groupingNode;
311 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
316 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
317 for (final ModuleContext ctx : genCtx.values()) {
318 final GeneratedTypeBuilder result = ctx.getChildNode(path);
319 if (result != null) {
326 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
327 for (final ModuleContext ctx : genCtx.values()) {
328 final GeneratedTypeBuilder result = ctx.getCase(path);
329 if (result != null) {
336 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
337 final Type targetTypeRef, final List<AugmentationSchema> schemaPathAugmentListEntry,
338 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
339 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
340 final BindingNamespaceType namespaceType) {
342 //pick augmentation grouped by augmentation target, there is always at least one
343 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
345 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
346 augmentPackageName, k -> new HashMap<>());
348 //this requires valid semantics in YANG model
349 String augIdentifier = null;
350 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
351 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
355 boolean isTypeNormalized = false;
356 if (augIdentifier == null) {
357 augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
358 isTypeNormalized = true;
361 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
362 false, isTypeNormalized);
364 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
365 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
366 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
367 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
368 augTypeBuilder.setWithBuilder(true);
369 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
371 //produces getters for augTypeBuilder eventually
372 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
374 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
375 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
376 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
379 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
381 if(!augSchema.getChildNodes().isEmpty()) {
382 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
383 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
385 genCtx.get(module).addAugmentType(augTypeBuilder);
390 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
391 * node for which <code>typeBuilder</code> was created.
395 * @param basePackageName
396 * string contains the module package name
398 * generated type builder which represents any node. The subnodes
399 * of this node are added to the <code>typeBuilder</code> as
400 * methods. The subnode can be of type leaf, leaf-list, list,
405 * set of data schema nodes which are the children of the node
406 * for which <code>typeBuilder</code> was created
407 * @return generated type builder which is the same object as the input
408 * parameter <code>typeBuilder</code>. The getter method could be
411 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
412 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
413 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
414 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
415 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
416 if (schemaNodes != null && typeBuilder != null) {
417 for (final DataSchemaNode schemaNode : schemaNodes) {
418 if (!schemaNode.isAugmenting()) {
419 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
420 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
428 * Instantiates generated type builder with <code>packageName</code> and
429 * <code>schemaNode</code>.
431 * The new builder always implements
432 * {@link TreeNode TreeNode}.<br>
433 * If <code>schemaNode</code> is instance of GroupingDefinition it also
434 * implements {@link Augmentable
436 * If <code>schemaNode</code> is instance of
437 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
438 * DataNodeContainer} it can also implement nodes which are specified in
441 * @param basePackageName
442 * string contains the module package name
444 * schema node for which is created generated type builder
446 * parent type (can be null)
447 * @param schemaContext schema context
448 * @return generated type builder <code>schemaNode</code>
450 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
451 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
452 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
453 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
456 if (schemaNode instanceof GroupingDefinition) {
458 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
462 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
463 verboseClassComments, genTypeBuilders, namespaceType);
464 if (namespaceType.equals(BindingNamespaceType.Data)) {
465 if (parent == null) {
466 it.addImplementsType(BindingTypes.TREE_NODE);
468 if (parent instanceof ListSchemaNode) {
469 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
470 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
472 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
473 (BindingTypes.ITEM, parent)));
474 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
478 if (!(schemaNode instanceof GroupingDefinition)) {
479 it.addImplementsType(BindingTypes.augmentable(it));
482 it.addImplementsType(BindingTypes.TREE_NODE);
485 if (schemaNode instanceof DataNodeContainer) {
486 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
487 verboseClassComments, genTypeBuilders, typeProvider);
488 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
494 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
495 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
496 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
497 genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
499 processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
500 verboseClassComments, typeProvider, BindingNamespaceType.Data);
502 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
503 (basePackageName, notification, null, module, genCtx, schemaContext,
504 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
505 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
506 notificationInterface.addImplementsType(NOTIFICATION);
507 genCtx.get(module).addChildNodeType(notification, notificationInterface);
509 // Notification object
510 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
511 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
512 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
514 //in case of tied notification, incorporate parent's localName
515 final StringBuilder sb = new StringBuilder("on_");
516 if (parentName != null) {
517 sb.append(parentName).append('_');
519 sb.append(notificationInterface.getName());
521 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
522 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
523 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
524 return listenerInterface;
528 * Returns reference to generated type builder for specified
529 * <code>schemaNode</code> with <code>packageName</code>.
531 * Firstly the generated type builder is searched in
532 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
533 * found it is created and added to <code>genTypeBuilders</code>.
535 * @param basePackageName
536 * string contains the module package name
538 * schema node which provide data about the schema node name
539 * @param schemaContext schema context
541 * return type name prefix
542 * @return generated type builder for <code>schemaNode</code>
543 * @throws IllegalArgumentException
545 * <li>if <code>schemaNode</code> is null</li>
546 * <li>if <code>packageName</code> is null</li>
547 * <li>if QName of schema node is null</li>
548 * <li>if schemaNode name is null</li>
552 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
553 final SchemaContext schemaContext, final String prefix, final String suffix,
554 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
555 final BindingNamespaceType namespaceType) {
557 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
558 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
559 String schemaNodeName = schemaNode.getQName().getLocalName();
560 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
562 if (prefix != null && !prefix.isEmpty()) {
563 // underscore used as separator for distinction of class name parts
564 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
567 if (suffix != null && !suffix.isEmpty()) {
568 // underscore used as separator for distinction of class name parts
569 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
572 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
573 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
574 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
575 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
576 newType.addComment(schemaNode.getDescription());
577 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
578 verboseClassComments, namespaceType));
579 newType.setReference(schemaNode.getReference());
580 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
581 newType.setModuleName(module.getName());
582 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
583 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
585 if (!genTypeBuilders.containsKey(packageName)) {
586 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
587 builders.put(newType.getName(), newType);
588 genTypeBuilders.put(packageName, builders);
590 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
591 if (!builders.containsKey(newType.getName())) {
592 builders.put(newType.getName(), newType);
599 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
600 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
601 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
602 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
603 final BindingNamespaceType namespaceType) {
605 if (node != null && typeBuilder != null) {
606 if (node instanceof ContainerSchemaNode) {
607 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
608 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
609 } else if (node instanceof LeafListSchemaNode) {
610 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
611 typeProvider, genCtx);
612 } else if (node instanceof LeafSchemaNode) {
613 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
615 } else if (node instanceof ListSchemaNode) {
616 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
617 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
618 } else if (node instanceof ChoiceSchemaNode) {
619 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
620 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
621 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
622 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
628 * Converts <code>choiceNode</code> to the list of generated types for
629 * choice and its cases.
631 * The package names for choice and for its cases are created as
632 * concatenation of the module package (<code>basePackageName</code>) and
633 * names of all parents node.
637 * @param basePackageName
638 * string with the module package name
642 * choice node which is mapped to generated type. Also child
643 * nodes - cases are mapped to generated types.
644 * @throws IllegalArgumentException
646 * <li>if <code>basePackageName</code> is null</li>
647 * <li>if <code>choiceNode</code> is null</li>
650 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
651 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
652 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
653 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
654 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
655 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
657 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
658 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType);
659 constructGetter(parent, choiceNode.getQName().getLocalName(),
660 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
661 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
662 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
663 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
664 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
665 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
668 private static void containerToGenType(final Module module, final String basePackageName,
669 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
670 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
671 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
672 final BindingNamespaceType namespaceType) {
674 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
675 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
676 if (genType != null) {
677 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
678 if (!namespaceType.equals(BindingNamespaceType.Data)) {
679 getterName.append('_').append(BindingNamespaceType.Data);
681 final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
682 if (!namespaceType.equals(BindingNamespaceType.Data)) {
683 getter.setAccessModifier(AccessModifier.DEFAULT);
685 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
686 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
687 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
691 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
692 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
693 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
694 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
695 final BindingNamespaceType namespaceType) {
697 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
698 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
699 if (genType != null) {
700 final String nodeName = node.getQName().getLocalName();
701 constructGetter(parent, nodeName, node.getDescription(), Types.listTypeFor(genType), node.getStatus());
702 final List<QName> listKeys = node.getKeyDefinition();
703 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
704 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
706 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
708 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
709 if (!schemaNode.isAugmenting()) {
710 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
711 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
716 if (genTOBuilder != null) {
717 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
718 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
719 genTOBuilder.setSUID(prop);
722 typeBuildersToGenTypes(module, genType, genTOBuilder, genCtx);
726 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
727 final GeneratedTOBuilder genTOBuilder, final Map<Module, ModuleContext> genCtx) {
728 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
729 if (genTOBuilder != null) {
730 final GeneratedTransferObject genTO = genTOBuilder.toInstance();
731 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
732 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
737 * Converts <code>leaf</code> to the getter method which is added to
738 * <code>typeBuilder</code>.
741 * generated type builder to which is added getter method as
742 * <code>leaf</code> mapping
744 * leaf schema node which is mapped as getter method which is
745 * added to <code>typeBuilder</code>
747 * Module in which type was defined
748 * @return boolean value
750 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
752 * <li>true - in other cases</li>
755 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
756 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
757 final Module module, final TypeProvider typeProvider) {
758 if (leaf == null || typeBuilder == null) {
762 final String leafName = leaf.getQName().getLocalName();
763 if (leafName == null) {
767 final Module parentModule = findParentModule(schemaContext, leaf);
768 Type returnType = null;
770 final TypeDefinition<?> typeDef = leaf.getType();
771 if (isInnerType(leaf, typeDef)) {
772 if (typeDef instanceof EnumTypeDefinition) {
773 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
774 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
775 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
776 genCtx, typeBuilder, module);
777 if (enumBuilder != null) {
778 returnType = enumBuilder.toInstance(typeBuilder);
780 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
781 } else if (typeDef instanceof UnionTypeDefinition) {
782 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
783 typeProvider, schemaContext);
784 if (genTOBuilder != null) {
785 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
786 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
788 } else if (typeDef instanceof BitsTypeDefinition) {
789 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
790 typeProvider, schemaContext);
791 if (genTOBuilder != null) {
792 returnType = genTOBuilder.toInstance();
795 // It is constrained version of already declared type (inner declared type exists,
796 // onlyfor special cases (Enum, Union, Bits), which were already checked.
797 // In order to get proper class we need to look up closest derived type
798 // and apply restrictions from leaf type
799 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
800 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
804 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
805 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
808 if (returnType == null) {
812 if (typeDef instanceof EnumTypeDefinition) {
813 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
816 String leafDesc = leaf.getDescription();
817 if (leafDesc == null) {
821 final String leafGetterName;
822 if (!"".equals(nodeName)) {
823 StringBuilder sb = new StringBuilder(nodeName)
826 leafGetterName = sb.toString();
828 leafGetterName = leafName;
831 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
836 * Converts <code>node</code> leaf list schema node to getter method of
837 * <code>typeBuilder</code>.
840 * generated type builder to which is <code>node</code> added as
843 * leaf list schema node which is added to
844 * <code>typeBuilder</code> as getter method
845 * @param module module
846 * @param typeProvider type provider instance
847 * @param genCtx actual generated context
848 * @return boolean value
850 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
851 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
852 * <li>false - other cases</li>
855 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
856 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
857 final Map<Module, ModuleContext> genCtx) {
858 if (node == null || typeBuilder == null) {
862 final QName nodeName = node.getQName();
864 final TypeDefinition<?> typeDef = node.getType();
865 final Module parentModule = findParentModule(schemaContext, node);
867 Type returnType = null;
868 if (typeDef.getBaseType() == null) {
869 if (typeDef instanceof EnumTypeDefinition) {
870 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
871 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
872 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
873 genCtx, typeBuilder, module);
874 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
875 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
876 } else if (typeDef instanceof UnionTypeDefinition) {
877 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
878 typeProvider, schemaContext);
879 if (genTOBuilder != null) {
880 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
882 } else if (typeDef instanceof BitsTypeDefinition) {
883 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
884 typeProvider, schemaContext);
885 returnType = genTOBuilder.toInstance();
887 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
888 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
891 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
892 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
895 final ParameterizedType listType = Types.listTypeFor(returnType);
896 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
901 * Converts <code>caseNodes</code> set to list of corresponding generated
904 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
905 * created generated type builder. The package names for the builder is
906 * created as concatenation of the module package (
907 * <code>basePackageName</code>) and names of all parents nodes of the
908 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
909 * between every case builder and <i>choice</i> type
913 * @param schemaContext
914 * current schema context
916 * actual generated context
917 * @param basePackageName
918 * string with the module package name
919 * @param refChoiceType
920 * type which represents superior <i>case</i>
922 * choice case node which is mapped to generated type
923 * @param verboseClassComments
924 * Javadoc verbosity switch
925 * @throws IllegalArgumentException
927 * <li>if <code>basePackageName</code> equals null</li>
928 * <li>if <code>refChoiceType</code> equals null</li>
929 * <li>if <code>caseNodes</code> equals null</li>
932 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
933 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
934 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
935 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
936 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
937 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
938 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
940 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
941 if (caseNodes == null) {
945 for (final ChoiceCaseNode caseNode : caseNodes) {
946 if (caseNode != null && !caseNode.isAugmenting()) {
947 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
948 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
949 caseTypeBuilder.addImplementsType(refChoiceType);
950 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
951 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
952 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
953 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
954 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
955 if (caseChildNodes != null) {
956 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
958 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
959 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
961 if (parent instanceof AugmentationSchema) {
962 final AugmentationSchema augSchema = (AugmentationSchema) parent;
963 final SchemaPath targetPath = augSchema.getTargetPath();
964 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
965 if (targetSchemaNode instanceof DataSchemaNode
966 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
967 if (targetSchemaNode instanceof DerivableSchemaNode) {
968 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
970 if (targetSchemaNode == null) {
971 throw new IllegalStateException(
972 "Failed to find target node from grouping for augmentation " + augSchema
973 + " in module " + module.getName());
976 parent = targetSchemaNode;
979 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
980 choiceNodeParentPath);
981 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
982 if (childOfType == null) {
983 childOfType = findGroupingByPath(parent.getPath(), genCtx);
985 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
986 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
988 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
989 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
990 verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
994 processUsesAugments(schemaContext, caseNode, module, genCtx, genTypeBuilders, verboseClassComments,
995 typeProvider, namespaceType);
999 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1000 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1001 final TypeProvider typeProvider) {
1003 final String anyName = node.getQName().getLocalName();
1004 if (anyName == null) {
1008 String anyDesc = node.getDescription();
1009 if (anyDesc == null) {
1013 Type returnType = Types.DOCUMENT;
1015 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1020 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1021 * or to <code>genTOBuilder</code> as property.
1024 * string contains the name of list
1025 * @param basePackageName
1026 * string contains the module package name
1028 * data schema node which should be added as getter method to
1029 * <code>typeBuilder</code> or as a property to
1030 * <code>genTOBuilder</code> if is part of the list key
1031 * @param typeBuilder
1032 * generated type builder for the list schema node
1033 * @param genTOBuilder
1034 * generated TO builder for the list keys
1036 * list of string which contains QNames of the list keys
1039 * @param typeProvider
1040 * provider that defines contract for generated types
1041 * @param schemaContext
1044 * map of generated entities in context of YANG modules
1045 * @param genTypeBuilders
1046 * map of generated type builders
1047 * @param verboseClassComments
1048 * generate verbose comments
1049 * @throws IllegalArgumentException
1051 * <li>if <code>schemaNode</code> equals null</li>
1052 * <li>if <code>typeBuilder</code> equals null</li>
1055 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1056 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1057 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1058 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1059 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1060 final BindingNamespaceType namespaceType) {
1061 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1062 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1064 if (schemaNode instanceof LeafSchemaNode) {
1065 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1066 final QName leafQName = leaf.getQName();
1068 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1070 if (listKeys.contains(leafQName)) {
1072 resolveLeafSchemaNodeAsProperty(schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1075 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1078 } else if (!schemaNode.isAddedByUses()) {
1079 if (schemaNode instanceof LeafListSchemaNode) {
1080 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1081 typeProvider, genCtx);
1082 } else if (schemaNode instanceof ContainerSchemaNode) {
1083 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1084 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1085 } else if (schemaNode instanceof ListSchemaNode) {
1086 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1087 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1088 } else if (schemaNode instanceof ChoiceSchemaNode) {
1089 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1090 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1095 private static boolean resolveLeafSchemaNodeAsProperty(final SchemaContext schemaContext, final TypeProvider
1096 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1097 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1099 if (leaf != null && toBuilder != null) {
1101 final TypeDefinition<?> typeDef = leaf.getType();
1102 if (typeDef instanceof UnionTypeDefinition) {
1103 // GeneratedType for this type definition should be already
1105 final QName qname = typeDef.getQName();
1106 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1107 qname.getRevision());
1108 final ModuleContext mc = genCtx.get(unionModule);
1109 returnType = mc.getTypedefs().get(typeDef.getPath());
1110 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1111 // Annonymous enumeration (already generated, since it is inherited via uses).
1112 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1113 QName qname = originalLeaf.getQName();
1114 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1115 qname.getRevision());
1116 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1118 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1120 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1125 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1126 final TypeDefinition<?> baseType = typeDef.getBaseType();
1127 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1130 @SuppressWarnings({ "rawtypes", "unchecked" })
1131 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1132 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1133 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1134 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1136 if (node.isAugmenting()) {
1140 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1141 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1142 genType.addComment(node.getDescription());
1143 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1144 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1145 verboseClassComments, namespaceType));
1146 genType.setModuleName(module.getName());
1147 genType.setReference(node.getReference());
1148 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1149 genType.setParentTypeForBuilder(childOf);
1150 if (node instanceof DataNodeContainer) {
1151 genCtx.get(module).addChildNodeType(node, genType);
1152 processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
1153 verboseClassComments, typeProvider, namespaceType);
1159 * Converts all <b>groupings</b> of the module to the list of
1160 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1161 * dependencies. At least dependent (independent) groupings are in the list
1162 * saved at first positions. For every grouping the record is added to map
1163 * {@link ModuleContext#groupings allGroupings}
1168 * collection of groupings from which types will be generated
1169 * @param typeProvider
1170 * provider that defines contract for generated types
1171 * @param schemaContext
1174 * map of generated entities in context of YANG modules
1175 * @param genTypeBuilders
1176 * map of generated type builders
1177 * @param verboseClassComments
1178 * generate verbose comments
1181 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1182 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1183 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1184 final String basePackageName = BindingMapping.getRootPackageName(module);
1185 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1187 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1188 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1189 verboseClassComments, genTypeBuilders, typeProvider);
1195 * Converts individual grouping to GeneratedType. Firstly generated type
1196 * builder is created and every child node of grouping is resolved to the
1199 * @param basePackageName
1200 * string contains the module package name
1202 * GroupingDefinition which contains data about grouping
1205 * @param typeProvider
1206 * provider that defines contract for generated types
1207 * @param schemaContext
1210 * map of generated entities in context of YANG modules
1211 * @param genTypeBuilders
1212 * map of generated type builders
1213 * @param verboseClassComments
1214 * generate verbose comments
1216 * @return GeneratedType which is generated from grouping (object of type
1217 * <code>GroupingDefinition</code>)
1219 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1220 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1221 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1222 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1223 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1224 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1225 genCtx.get(module).addGroupingType(grouping, genType);
1226 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1227 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1228 genCtx = processUsesAugments(schemaContext, grouping, module, genCtx, genTypeBuilders, verboseClassComments,
1229 typeProvider, BindingNamespaceType.Grouping);
1230 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1235 * //TODO: add information about multiple base identities in YANG 1.1
1236 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1237 * created transport object builder. If identity contains base identity then
1238 * reference to base identity is added to superior identity as its extend.
1239 * If identity doesn't contain base identity then only reference to abstract
1240 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1241 * BaseIdentity} is added
1245 * @param basePackageName
1246 * string contains the module package name
1248 * IdentitySchemaNode which contains data about identity
1249 * @param schemaContext
1250 * SchemaContext which is used to get package and name
1251 * information about base of identity
1252 * @param genCtx generated context
1253 * @return returns generated context
1255 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1256 final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1257 boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
1258 final TypeProvider typeProvider, Map<QName, GeneratedTOBuilderImpl> generatedIdentities) {
1260 //check first if identity has been resolved as base identity of some other one
1261 GeneratedTOBuilderImpl newType = generatedIdentities.get(identity.getQName());
1263 if (newType == null) {
1264 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1265 BindingNamespaceType.Identity);
1266 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false);
1269 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1270 if (baseIdentities.size() == 0) {
1271 //no base - abstract
1272 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1273 BaseIdentity.class.getSimpleName());
1274 newType.setExtendsType(gto.toInstance());
1275 generatedIdentities.put(identity.getQName(), newType);
1277 //one base - inheritance
1278 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1279 final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(schemaContext, baseIdentity);
1280 final String returnTypePkgName = new StringBuilder(BindingMapping.getRootPackageName
1281 (baseIdentityParentModule))
1283 .append(BindingNamespaceType.Identity.getPackagePrefix())
1286 final GeneratedTOBuilderImpl existingIdentityGto = generatedIdentities.get(baseIdentity.getQName());
1287 if (existingIdentityGto != null) {
1288 newType.setExtendsType(existingIdentityGto.toInstance());
1290 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(returnTypePkgName,
1291 baseIdentity.getQName().getLocalName());
1292 newType.setExtendsType(gto.toInstance());
1293 generatedIdentities.put(baseIdentity.getQName(), gto);
1296 //FIXME: more bases - possible composition, multiple inheritance not possible
1298 generatedIdentities.put(identity.getQName(), newType);
1300 newType.setAbstract(true);
1301 newType.addComment(identity.getDescription());
1302 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1303 verboseClassComments, BindingNamespaceType.Identity));
1304 newType.setReference(identity.getReference());
1305 newType.setModuleName(module.getName());
1306 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1308 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1310 genCtx.get(module).addIdentityType(identity.getQName(), newType);