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.model.api.AnyDataSchemaNode;
70 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
72 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
73 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
76 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
79 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.Module;
84 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
85 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
86 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
88 import org.opendaylight.yangtools.yang.model.api.Status;
89 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
90 import org.opendaylight.yangtools.yang.model.api.UsesNode;
91 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
92 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
93 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
94 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
95 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
98 * Helper util class used for generation of types in Binding spec v2.
101 final class GenHelperUtil {
103 private GenHelperUtil() {
104 throw new UnsupportedOperationException("Util class");
108 * Create GeneratedTypeBuilder object from module argument.
111 * Module object from which builder will be created
112 * @param genCtx generated context
113 * @param verboseClassComments verbosity switch
115 * @return <code>GeneratedTypeBuilder</code> which is internal
116 * representation of the module
117 * @throws IllegalArgumentException
120 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
121 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
123 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments);
124 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
125 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
126 moduleDataTypeBuilder.addComment(module.getDescription());
127 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
128 moduleDataTypeBuilder.setReference(module.getReference());
129 return moduleDataTypeBuilder;
133 * Generates type builder for <code>module</code>.
136 * Module which is source of package name for generated type
139 * string which is added to the module class name representation
141 * @param verboseClassComments verbosity switch
142 * @return instance of GeneratedTypeBuilder which represents
143 * <code>module</code>.
144 * @throws IllegalArgumentException
145 * if <code>module</code> is null
147 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
148 verboseClassComments) {
149 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
150 final String packageName = BindingMapping.getRootPackageName(module);
151 // underscore used as separator for distinction of module name parts
152 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
154 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
155 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
156 moduleBuilder.setReference(module.getReference());
157 moduleBuilder.setModuleName(moduleName);
158 return moduleBuilder;
162 * Adds the implemented types to type builder.
164 * The method passes through the list of <i>uses</i> in
165 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
166 * generated type from all groupings
167 * allGroupings} which is added as <i>implements type</i> to
168 * <code>builder</code>
170 * @param dataNodeContainer
171 * element which contains the list of used YANG groupings
173 * builder to which are added implemented types according to
174 * <code>dataNodeContainer</code>
175 * @param genCtx generated context
176 * @return generated type builder with all implemented types
178 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
179 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
180 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
181 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
182 if (genType == null) {
183 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
184 + builder.getName());
186 builder.addImplementsType(genType);
191 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
192 for (final ModuleContext ctx : genCtx.values()) {
193 final GeneratedTypeBuilder result = ctx.getGrouping(path);
194 if (result != null) {
202 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
203 * node for which <code>typeBuilder</code> was created.
205 * The subnodes aren't mapped to the methods if they are part of grouping or
206 * augment (in this case are already part of them).
210 * @param basePackageName
211 * string contains the module package name
213 * generated type builder which represents any node. The subnodes
214 * of this node are added to the <code>typeBuilder</code> as
215 * methods. The subnode can be of type leaf, leaf-list, list,
220 * set of data schema nodes which are the children of the node
221 * for which <code>typeBuilder</code> was created
222 * @return generated type builder which is the same builder as input
223 * parameter. The getter methods (representing child nodes) could be
226 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
227 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
228 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
229 final SchemaContext schemaContext, final boolean verboseClassComments,
230 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
231 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
233 if (schemaNodes != null && parent != null) {
234 for (final DataSchemaNode schemaNode : schemaNodes) {
235 if (!schemaNode.isAugmenting()) {
236 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
237 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
244 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
245 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
246 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
247 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
248 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
249 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
252 static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
253 DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
254 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
255 final boolean verboseClassComments, final TypeProvider typeProvider,
256 final BindingNamespaceType namespaceType) {
257 final String basePackageName = BindingMapping.getRootPackageName(module);
258 for (final UsesNode usesNode : node.getUses()) {
259 Map<SchemaPath, List<AugmentationSchema>> augmentationsGrouped =
260 usesNode.getAugmentations().stream().collect(Collectors.groupingBy(AugmentationSchema::getTargetPath));
261 for (Map.Entry<SchemaPath, List<AugmentationSchema>> schemaPathAugmentListEntry : augmentationsGrouped.entrySet()) {
262 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName,
263 schemaPathAugmentListEntry.getValue(), module,
264 usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider, namespaceType);
265 for (AugmentationSchema augSchema : schemaPathAugmentListEntry.getValue()) {
266 genCtx = processUsesAugments(schemaContext, augSchema, module, genCtx, genTypeBuilders,
267 verboseClassComments, typeProvider, namespaceType);
274 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
275 for (final ModuleContext ctx : genCtx.values()) {
276 final GeneratedTypeBuilder result = ctx.getChildNode(path);
277 if (result != null) {
284 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
285 for (final ModuleContext ctx : genCtx.values()) {
286 final GeneratedTypeBuilder result = ctx.getCase(path);
287 if (result != null) {
294 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
295 final Type targetTypeRef, final List<AugmentationSchema> schemaPathAugmentListEntry,
296 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
297 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
298 final BindingNamespaceType namespaceType) {
300 //pick augmentation grouped by augmentation target, there is always at least one
301 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
303 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
304 augmentPackageName, k -> new HashMap<>());
306 //this requires valid semantics in YANG model
307 String augIdentifier = null;
308 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
309 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
313 boolean isTypeNormalized = false;
314 if (augIdentifier == null) {
315 augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
316 isTypeNormalized = true;
319 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
320 false, isTypeNormalized);
322 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
323 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
324 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
325 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
326 if (namespaceType.equals(BindingNamespaceType.Data)) {
327 augTypeBuilder.setWithBuilder(true);
329 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
331 //produces getters for augTypeBuilder eventually
332 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
334 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
335 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
336 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
339 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
341 if(!augSchema.getChildNodes().isEmpty()) {
342 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
343 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
345 genCtx.get(module).addAugmentType(augTypeBuilder);
350 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
351 * node for which <code>typeBuilder</code> was created.
355 * @param basePackageName
356 * string contains the module package name
358 * generated type builder which represents any node. The subnodes
359 * of this node are added to the <code>typeBuilder</code> as
360 * methods. The subnode can be of type leaf, leaf-list, list,
365 * set of data schema nodes which are the children of the node
366 * for which <code>typeBuilder</code> was created
367 * @return generated type builder which is the same object as the input
368 * parameter <code>typeBuilder</code>. The getter method could be
371 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
372 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
373 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
374 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
375 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
376 if (schemaNodes != null && typeBuilder != null) {
377 for (final DataSchemaNode schemaNode : schemaNodes) {
378 if (!schemaNode.isAugmenting()) {
379 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
380 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
388 * Instantiates generated type builder with <code>packageName</code> and
389 * <code>schemaNode</code>.
391 * The new builder always implements
392 * {@link TreeNode TreeNode}.<br>
393 * If <code>schemaNode</code> is instance of GroupingDefinition it also
394 * implements {@link Augmentable
396 * If <code>schemaNode</code> is instance of
397 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
398 * DataNodeContainer} it can also implement nodes which are specified in
401 * @param basePackageName
402 * string contains the module package name
404 * schema node for which is created generated type builder
406 * parent type (can be null)
407 * @param schemaContext schema context
408 * @return generated type builder <code>schemaNode</code>
410 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
411 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
412 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
413 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
416 if (schemaNode instanceof GroupingDefinition) {
418 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
422 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
423 verboseClassComments, genTypeBuilders, namespaceType);
424 if (namespaceType.equals(BindingNamespaceType.Data)) {
425 if (parent == null) {
426 it.addImplementsType(BindingTypes.TREE_NODE);
428 if (parent instanceof ListSchemaNode) {
429 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
430 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
432 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
433 (BindingTypes.ITEM, parent)));
434 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
438 if (!(schemaNode instanceof GroupingDefinition)) {
439 it.addImplementsType(BindingTypes.augmentable(it));
442 if (schemaNode instanceof DerivableSchemaNode
443 && ((DerivableSchemaNode) schemaNode).isAddedByUses()) {
444 //TODO: The schema path of child node is not unique for YANG 1.1
445 final GeneratedTypeBuilder originalType =
446 findChildNodeByPath(((DerivableSchemaNode) schemaNode).getOriginal().get().getPath(), genCtx);
447 Preconditions.checkState(originalType != null, "Original type can not be null!");
448 it.addImplementsType(originalType.toInstance());
452 it.addImplementsType(BindingTypes.TREE_NODE);
455 if (schemaNode instanceof DataNodeContainer) {
456 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
457 verboseClassComments, genTypeBuilders, typeProvider);
458 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
464 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
465 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
466 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
467 genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
469 processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
470 verboseClassComments, typeProvider, BindingNamespaceType.Data);
472 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
473 (basePackageName, notification, null, module, genCtx, schemaContext,
474 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
475 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
476 notificationInterface.addImplementsType(NOTIFICATION);
477 genCtx.get(module).addChildNodeType(notification, notificationInterface);
479 // Notification object
480 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
481 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
482 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
484 //in case of tied notification, incorporate parent's localName
485 final StringBuilder sb = new StringBuilder("on_");
486 if (parentName != null) {
487 sb.append(parentName).append('_');
489 sb.append(notificationInterface.getName());
491 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
492 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
493 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
494 return listenerInterface;
498 * Returns reference to generated type builder for specified
499 * <code>schemaNode</code> with <code>packageName</code>.
501 * Firstly the generated type builder is searched in
502 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
503 * found it is created and added to <code>genTypeBuilders</code>.
505 * @param basePackageName
506 * string contains the module package name
508 * schema node which provide data about the schema node name
509 * @param schemaContext schema context
511 * return type name prefix
512 * @return generated type builder for <code>schemaNode</code>
513 * @throws IllegalArgumentException
515 * <li>if <code>schemaNode</code> is null</li>
516 * <li>if <code>packageName</code> is null</li>
517 * <li>if QName of schema node is null</li>
518 * <li>if schemaNode name is null</li>
522 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
523 final SchemaContext schemaContext, final String prefix, final String suffix,
524 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
525 final BindingNamespaceType namespaceType) {
527 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
528 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
529 String schemaNodeName = schemaNode.getQName().getLocalName();
530 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
532 if (prefix != null && !prefix.isEmpty()) {
533 // underscore used as separator for distinction of class name parts
534 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
537 if (suffix != null && !suffix.isEmpty()) {
538 // underscore used as separator for distinction of class name parts
539 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
542 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
543 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
544 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
545 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
546 newType.addComment(schemaNode.getDescription());
547 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
548 verboseClassComments, namespaceType));
549 newType.setReference(schemaNode.getReference());
550 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
551 newType.setModuleName(module.getName());
552 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
553 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
555 if (!genTypeBuilders.containsKey(packageName)) {
556 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
557 builders.put(newType.getName(), newType);
558 genTypeBuilders.put(packageName, builders);
560 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
561 if (!builders.containsKey(newType.getName())) {
562 builders.put(newType.getName(), newType);
569 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
570 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
571 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
572 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
573 final BindingNamespaceType namespaceType) {
575 if (node != null && typeBuilder != null) {
576 if (node instanceof ContainerSchemaNode) {
577 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
578 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
579 } else if (node instanceof LeafListSchemaNode) {
580 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
581 typeProvider, genCtx);
582 } else if (node instanceof LeafSchemaNode) {
583 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
585 } else if (node instanceof ListSchemaNode) {
586 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
587 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
588 } else if (node instanceof ChoiceSchemaNode) {
589 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
590 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
591 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
592 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
598 * Converts <code>choiceNode</code> to the list of generated types for
599 * choice and its cases.
601 * The package names for choice and for its cases are created as
602 * concatenation of the module package (<code>basePackageName</code>) and
603 * names of all parents node.
607 * @param basePackageName
608 * string with the module package name
612 * choice node which is mapped to generated type. Also child
613 * nodes - cases are mapped to generated types.
614 * @throws IllegalArgumentException
616 * <li>if <code>basePackageName</code> is null</li>
617 * <li>if <code>choiceNode</code> is null</li>
620 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
621 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
622 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
623 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
624 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
625 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
627 if (!choiceNode.isAddedByUses()) {
628 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
629 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType);
630 constructGetter(parent, choiceNode.getQName().getLocalName(),
631 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
632 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
633 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
634 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
635 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
636 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
640 private static void containerToGenType(final Module module, final String basePackageName,
641 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
642 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
643 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
644 final BindingNamespaceType namespaceType) {
646 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
647 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
648 if (genType != null) {
649 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
650 if (!namespaceType.equals(BindingNamespaceType.Data)) {
651 getterName.append('_').append(BindingNamespaceType.Data);
653 final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
654 if (!namespaceType.equals(BindingNamespaceType.Data)) {
655 getter.setAccessModifier(AccessModifier.DEFAULT);
657 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
658 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
662 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
663 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
664 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
665 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
666 final BindingNamespaceType namespaceType) {
668 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
669 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
670 if (genType != null) {
671 final String nodeName = node.getQName().getLocalName();
672 constructGetter(parent, nodeName, node.getDescription(), Types.listTypeFor(genType), node.getStatus());
673 final List<QName> listKeys = node.getKeyDefinition();
674 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
675 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
677 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
679 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
680 if (!schemaNode.isAugmenting()) {
681 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
682 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
687 if (genTOBuilder != null) {
688 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
689 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
690 genTOBuilder.setSUID(prop);
693 typeBuildersToGenTypes(module, genType, genTOBuilder, genCtx);
697 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
698 final GeneratedTOBuilder genTOBuilder, final Map<Module, ModuleContext> genCtx) {
699 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
700 if (genTOBuilder != null) {
701 final GeneratedTransferObject genTO = genTOBuilder.toInstance();
702 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
703 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
708 * Converts <code>leaf</code> to the getter method which is added to
709 * <code>typeBuilder</code>.
712 * generated type builder to which is added getter method as
713 * <code>leaf</code> mapping
715 * leaf schema node which is mapped as getter method which is
716 * added to <code>typeBuilder</code>
718 * Module in which type was defined
719 * @return boolean value
721 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
723 * <li>true - in other cases</li>
726 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
727 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
728 final Module module, final TypeProvider typeProvider) {
729 if (leaf == null || typeBuilder == null) {
733 final String leafName = leaf.getQName().getLocalName();
734 if (leafName == null) {
738 final Module parentModule = findParentModule(schemaContext, leaf);
739 Type returnType = null;
741 final TypeDefinition<?> typeDef = leaf.getType();
742 if (isInnerType(leaf, typeDef)) {
743 if (typeDef instanceof EnumTypeDefinition) {
744 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
745 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
746 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
747 genCtx, typeBuilder, module);
748 if (enumBuilder != null) {
749 returnType = enumBuilder.toInstance(typeBuilder);
751 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
752 } else if (typeDef instanceof UnionTypeDefinition) {
753 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
754 typeProvider, schemaContext);
755 if (genTOBuilder != null) {
756 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
757 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
759 } else if (typeDef instanceof BitsTypeDefinition) {
760 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
761 typeProvider, schemaContext);
762 if (genTOBuilder != null) {
763 returnType = genTOBuilder.toInstance();
766 // It is constrained version of already declared type (inner declared type exists,
767 // onlyfor special cases (Enum, Union, Bits), which were already checked.
768 // In order to get proper class we need to look up closest derived type
769 // and apply restrictions from leaf type
770 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
771 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
775 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
776 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
779 if (returnType == null) {
783 if (typeDef instanceof EnumTypeDefinition) {
784 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
787 String leafDesc = leaf.getDescription();
788 if (leafDesc == null) {
792 final String leafGetterName;
793 if (!"".equals(nodeName)) {
794 StringBuilder sb = new StringBuilder(nodeName)
797 leafGetterName = sb.toString();
799 leafGetterName = leafName;
802 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
807 * Converts <code>node</code> leaf list schema node to getter method of
808 * <code>typeBuilder</code>.
811 * generated type builder to which is <code>node</code> added as
814 * leaf list schema node which is added to
815 * <code>typeBuilder</code> as getter method
816 * @param module module
817 * @param typeProvider type provider instance
818 * @param genCtx actual generated context
819 * @return boolean value
821 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
822 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
823 * <li>false - other cases</li>
826 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
827 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
828 final Map<Module, ModuleContext> genCtx) {
829 if (node == null || typeBuilder == null || node.isAddedByUses()) {
833 final QName nodeName = node.getQName();
835 final TypeDefinition<?> typeDef = node.getType();
836 final Module parentModule = findParentModule(schemaContext, node);
838 Type returnType = null;
839 if (typeDef.getBaseType() == null) {
840 if (typeDef instanceof EnumTypeDefinition) {
841 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
842 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
843 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
844 genCtx, typeBuilder, module);
845 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
846 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
847 } else if (typeDef instanceof UnionTypeDefinition) {
848 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
849 typeProvider, schemaContext);
850 if (genTOBuilder != null) {
851 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
853 } else if (typeDef instanceof BitsTypeDefinition) {
854 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
855 typeProvider, schemaContext);
856 returnType = genTOBuilder.toInstance();
858 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
859 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
862 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
863 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
866 final ParameterizedType listType = Types.listTypeFor(returnType);
867 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
872 * Converts <code>caseNodes</code> set to list of corresponding generated
875 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
876 * created generated type builder. The package names for the builder is
877 * created as concatenation of the module package (
878 * <code>basePackageName</code>) and names of all parents nodes of the
879 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
880 * between every case builder and <i>choice</i> type
884 * @param schemaContext
885 * current schema context
887 * actual generated context
888 * @param basePackageName
889 * string with the module package name
890 * @param refChoiceType
891 * type which represents superior <i>case</i>
893 * choice case node which is mapped to generated type
894 * @param verboseClassComments
895 * Javadoc verbosity switch
896 * @throws IllegalArgumentException
898 * <li>if <code>basePackageName</code> equals null</li>
899 * <li>if <code>refChoiceType</code> equals null</li>
900 * <li>if <code>caseNodes</code> equals null</li>
903 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
904 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
905 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
906 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
907 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
908 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
909 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
911 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
912 if (caseNodes == null) {
916 for (final ChoiceCaseNode caseNode : caseNodes) {
917 if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
918 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
919 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
920 caseTypeBuilder.addImplementsType(refChoiceType);
921 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
922 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
923 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
924 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
925 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
926 if (caseChildNodes != null) {
927 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
929 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
930 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
932 if (parent instanceof AugmentationSchema) {
933 final AugmentationSchema augSchema = (AugmentationSchema) parent;
934 final SchemaPath targetPath = augSchema.getTargetPath();
935 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
936 if (targetSchemaNode instanceof DataSchemaNode
937 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
938 if (targetSchemaNode instanceof DerivableSchemaNode) {
939 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
941 if (targetSchemaNode == null) {
942 throw new IllegalStateException(
943 "Failed to find target node from grouping for augmentation " + augSchema
944 + " in module " + module.getName());
947 parent = targetSchemaNode;
950 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
951 choiceNodeParentPath);
952 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
953 if (childOfType == null) {
954 childOfType = findGroupingByPath(parent.getPath(), genCtx);
956 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
957 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
959 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
960 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
961 verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
965 processUsesAugments(schemaContext, caseNode, module, genCtx, genTypeBuilders, verboseClassComments,
966 typeProvider, namespaceType);
970 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
971 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
972 final TypeProvider typeProvider) {
974 final String anyName = node.getQName().getLocalName();
975 if (anyName == null) {
979 String anyDesc = node.getDescription();
980 if (anyDesc == null) {
984 Type returnType = Types.DOCUMENT;
986 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
991 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
992 * or to <code>genTOBuilder</code> as property.
995 * string contains the name of list
996 * @param basePackageName
997 * string contains the module package name
999 * data schema node which should be added as getter method to
1000 * <code>typeBuilder</code> or as a property to
1001 * <code>genTOBuilder</code> if is part of the list key
1002 * @param typeBuilder
1003 * generated type builder for the list schema node
1004 * @param genTOBuilder
1005 * generated TO builder for the list keys
1007 * list of string which contains QNames of the list keys
1010 * @param typeProvider
1011 * provider that defines contract for generated types
1012 * @param schemaContext
1015 * map of generated entities in context of YANG modules
1016 * @param genTypeBuilders
1017 * map of generated type builders
1018 * @param verboseClassComments
1019 * generate verbose comments
1020 * @throws IllegalArgumentException
1022 * <li>if <code>schemaNode</code> equals null</li>
1023 * <li>if <code>typeBuilder</code> equals null</li>
1026 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1027 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1028 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1029 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1030 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1031 final BindingNamespaceType namespaceType) {
1032 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1033 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1035 if (schemaNode instanceof LeafSchemaNode) {
1036 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1037 final QName leafQName = leaf.getQName();
1039 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1041 if (listKeys.contains(leafQName)) {
1043 resolveLeafSchemaNodeAsProperty(schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1046 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1049 } else if (!schemaNode.isAddedByUses()) {
1050 if (schemaNode instanceof LeafListSchemaNode) {
1051 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1052 typeProvider, genCtx);
1053 } else if (schemaNode instanceof ContainerSchemaNode) {
1054 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1055 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1056 } else if (schemaNode instanceof ListSchemaNode) {
1057 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1058 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1059 } else if (schemaNode instanceof ChoiceSchemaNode) {
1060 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1061 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1066 private static boolean resolveLeafSchemaNodeAsProperty(final SchemaContext schemaContext, final TypeProvider
1067 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1068 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1070 if (leaf != null && toBuilder != null) {
1072 final TypeDefinition<?> typeDef = leaf.getType();
1073 if (typeDef instanceof UnionTypeDefinition) {
1074 // GeneratedType for this type definition should be already
1076 final QName qname = typeDef.getQName();
1077 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1078 qname.getRevision());
1079 final ModuleContext mc = genCtx.get(unionModule);
1080 returnType = mc.getTypedefs().get(typeDef.getPath());
1081 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1082 // Annonymous enumeration (already generated, since it is inherited via uses).
1083 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1084 QName qname = originalLeaf.getQName();
1085 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1086 qname.getRevision());
1087 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1089 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1091 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1096 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1097 final TypeDefinition<?> baseType = typeDef.getBaseType();
1098 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1101 @SuppressWarnings({ "rawtypes", "unchecked" })
1102 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1103 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1104 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1105 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1107 if (node.isAugmenting()) {
1111 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1112 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1113 genType.addComment(node.getDescription());
1114 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1115 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1116 verboseClassComments, namespaceType));
1117 genType.setModuleName(module.getName());
1118 genType.setReference(node.getReference());
1119 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1120 genType.setParentTypeForBuilder(childOf);
1121 if (node instanceof DataNodeContainer) {
1122 genCtx.get(module).addChildNodeType(node, genType);
1123 genCtx = groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings(), genCtx, schemaContext,
1124 verboseClassComments, genTypeBuilders, typeProvider);
1125 processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
1126 verboseClassComments, typeProvider, namespaceType);
1132 * Converts all <b>groupings</b> of the module to the list of
1133 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1134 * dependencies. At least dependent (independent) groupings are in the list
1135 * saved at first positions. For every grouping the record is added to map
1136 * {@link ModuleContext#groupings allGroupings}
1141 * collection of groupings from which types will be generated
1142 * @param typeProvider
1143 * provider that defines contract for generated types
1144 * @param schemaContext
1147 * map of generated entities in context of YANG modules
1148 * @param genTypeBuilders
1149 * map of generated type builders
1150 * @param verboseClassComments
1151 * generate verbose comments
1154 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1155 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1156 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1157 final String basePackageName = BindingMapping.getRootPackageName(module);
1158 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1160 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1161 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1162 verboseClassComments, genTypeBuilders, typeProvider);
1168 * Converts individual grouping to GeneratedType. Firstly generated type
1169 * builder is created and every child node of grouping is resolved to the
1172 * @param basePackageName
1173 * string contains the module package name
1175 * GroupingDefinition which contains data about grouping
1178 * @param typeProvider
1179 * provider that defines contract for generated types
1180 * @param schemaContext
1183 * map of generated entities in context of YANG modules
1184 * @param genTypeBuilders
1185 * map of generated type builders
1186 * @param verboseClassComments
1187 * generate verbose comments
1189 * @return GeneratedType which is generated from grouping (object of type
1190 * <code>GroupingDefinition</code>)
1192 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1193 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1194 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1195 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1196 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1197 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1198 genCtx.get(module).addGroupingType(grouping, genType);
1199 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1200 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1201 genCtx = groupingsToGenTypes(module, grouping.getGroupings(), genCtx, schemaContext, verboseClassComments,
1202 genTypeBuilders, typeProvider);
1203 genCtx = processUsesAugments(schemaContext, grouping, module, genCtx, genTypeBuilders, verboseClassComments,
1204 typeProvider, BindingNamespaceType.Grouping);
1209 * //TODO: add information about multiple base identities in YANG 1.1
1210 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1211 * created transport object builder. If identity contains base identity then
1212 * reference to base identity is added to superior identity as its extend.
1213 * If identity doesn't contain base identity then only reference to abstract
1214 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1215 * BaseIdentity} is added
1219 * @param basePackageName
1220 * string contains the module package name
1222 * IdentitySchemaNode which contains data about identity
1223 * @param schemaContext
1224 * SchemaContext which is used to get package and name
1225 * information about base of identity
1226 * @param genCtx generated context
1227 * @return returns generated context
1229 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1230 final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1231 boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
1232 final TypeProvider typeProvider, Map<QName, GeneratedTOBuilderImpl> generatedIdentities) {
1234 //check first if identity has been resolved as base identity of some other one
1235 GeneratedTOBuilderImpl newType = generatedIdentities.get(identity.getQName());
1237 if (newType == null) {
1238 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1239 BindingNamespaceType.Identity);
1240 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false);
1243 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1244 if (baseIdentities.size() == 0) {
1245 //no base - abstract
1246 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1247 BaseIdentity.class.getSimpleName());
1248 newType.setExtendsType(gto.toInstance());
1249 generatedIdentities.put(identity.getQName(), newType);
1251 //one base - inheritance
1252 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1253 final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(schemaContext, baseIdentity);
1254 final String returnTypePkgName = new StringBuilder(BindingMapping.getRootPackageName
1255 (baseIdentityParentModule))
1257 .append(BindingNamespaceType.Identity.getPackagePrefix())
1260 final GeneratedTOBuilderImpl existingIdentityGto = generatedIdentities.get(baseIdentity.getQName());
1261 if (existingIdentityGto != null) {
1262 newType.setExtendsType(existingIdentityGto.toInstance());
1264 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(returnTypePkgName,
1265 baseIdentity.getQName().getLocalName());
1266 newType.setExtendsType(gto.toInstance());
1267 generatedIdentities.put(baseIdentity.getQName(), gto);
1270 //FIXME: more bases - possible composition, multiple inheritance not possible
1272 generatedIdentities.put(identity.getQName(), newType);
1274 newType.setAbstract(true);
1275 newType.addComment(identity.getDescription());
1276 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1277 verboseClassComments, BindingNamespaceType.Identity));
1278 newType.setReference(identity.getReference());
1279 newType.setModuleName(module.getName());
1280 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1282 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1284 genCtx.get(module).addIdentityType(identity.getQName(), newType);