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.impl.AuxiliaryGenUtils.resolveListKeyTypeBuilder;
24 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.computeDefaultSUID;
25 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
26 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
27 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION;
28 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
29 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.wildcardTypeFor;
30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
31 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
33 import com.google.common.annotations.Beta;
34 import com.google.common.base.Preconditions;
35 import com.google.common.collect.Iterables;
36 import java.util.Collection;
37 import java.util.HashMap;
38 import java.util.List;
41 import java.util.stream.Collectors;
42 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
43 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
50 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
51 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
52 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
53 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
54 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
55 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
56 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
57 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
58 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
59 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
60 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
63 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
64 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
65 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
66 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
67 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
68 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
69 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
70 import org.opendaylight.yangtools.yang.common.QName;
71 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
72 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
73 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
75 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
76 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
79 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
82 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.Module;
87 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
88 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
89 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
90 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
91 import org.opendaylight.yangtools.yang.model.api.Status;
92 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
93 import org.opendaylight.yangtools.yang.model.api.UsesNode;
94 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
96 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
97 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
98 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
101 * Helper util class used for generation of types in Binding spec v2.
104 final class GenHelperUtil {
106 private GenHelperUtil() {
107 throw new UnsupportedOperationException("Util class");
111 * Create GeneratedTypeBuilder object from module argument.
114 * Module object from which builder will be created
115 * @param genCtx generated context
116 * @param verboseClassComments verbosity switch
118 * @return <code>GeneratedTypeBuilder</code> which is internal
119 * representation of the module
120 * @throws IllegalArgumentException
123 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
124 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
126 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments);
127 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
128 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
129 moduleDataTypeBuilder.addComment(module.getDescription());
130 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
131 moduleDataTypeBuilder.setReference(module.getReference());
132 return moduleDataTypeBuilder;
136 * Generates type builder for <code>module</code>.
139 * Module which is source of package name for generated type
142 * string which is added to the module class name representation
144 * @param verboseClassComments verbosity switch
145 * @return instance of GeneratedTypeBuilder which represents
146 * <code>module</code>.
147 * @throws IllegalArgumentException
148 * if <code>module</code> is null
150 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
151 verboseClassComments) {
152 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
153 final String packageName = BindingMapping.getRootPackageName(module);
154 // underscore used as separator for distinction of module name parts
155 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
157 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
158 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
159 moduleBuilder.setReference(module.getReference());
160 moduleBuilder.setModuleName(moduleName);
161 return moduleBuilder;
165 * Adds the implemented types to type builder.
167 * The method passes through the list of <i>uses</i> in
168 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
169 * generated type from all groupings
170 * allGroupings} which is added as <i>implements type</i> to
171 * <code>builder</code>
173 * @param dataNodeContainer
174 * element which contains the list of used YANG groupings
176 * builder to which are added implemented types according to
177 * <code>dataNodeContainer</code>
178 * @param genCtx generated context
179 * @return generated type builder with all implemented types
181 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
182 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
183 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
184 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
185 if (genType == null) {
186 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
187 + builder.getName());
189 builder.addImplementsType(genType);
194 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
195 for (final ModuleContext ctx : genCtx.values()) {
196 final GeneratedTypeBuilder result = ctx.getGrouping(path);
197 if (result != null) {
204 static GeneratedTOBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
205 for (final ModuleContext ctx : genCtx.values()) {
206 final GeneratedTOBuilder result = ctx.getIdentities().get(qname);
207 if (result != null) {
215 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
216 * node for which <code>typeBuilder</code> was created.
218 * The subnodes aren't mapped to the methods if they are part of grouping or
219 * augment (in this case are already part of them).
223 * @param basePackageName
224 * string contains the module package name
226 * generated type builder which represents any node. The subnodes
227 * of this node are added to the <code>typeBuilder</code> as
228 * methods. The subnode can be of type leaf, leaf-list, list,
233 * set of data schema nodes which are the children of the node
234 * for which <code>typeBuilder</code> was created
235 * @return generated type builder which is the same builder as input
236 * parameter. The getter methods (representing child nodes) could be
239 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
240 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
241 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
242 final SchemaContext schemaContext, final boolean verboseClassComments,
243 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
244 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
246 if (schemaNodes != null && parent != null) {
247 for (final DataSchemaNode schemaNode : schemaNodes) {
248 if (!schemaNode.isAugmenting()) {
249 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
250 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
257 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
258 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
259 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
260 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
261 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
262 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
265 static Map<Module, ModuleContext> processUsesAugments(final SchemaContext schemaContext, final
266 DataNodeContainer node, final Module module, Map<Module, ModuleContext> genCtx,
267 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
268 final boolean verboseClassComments, final TypeProvider typeProvider,
269 final BindingNamespaceType namespaceType) {
270 final String basePackageName = BindingMapping.getRootPackageName(module);
271 for (final UsesNode usesNode : node.getUses()) {
272 Map<SchemaPath, List<AugmentationSchema>> augmentationsGrouped =
273 usesNode.getAugmentations().stream().collect(Collectors.groupingBy(AugmentationSchema::getTargetPath));
274 for (Map.Entry<SchemaPath, List<AugmentationSchema>> schemaPathAugmentListEntry : augmentationsGrouped.entrySet()) {
275 genCtx = AugmentToGenType.usesAugmentationToGenTypes(schemaContext, basePackageName,
276 schemaPathAugmentListEntry.getValue(), module,
277 usesNode, node, genCtx, genTypeBuilders, verboseClassComments, typeProvider, namespaceType);
278 for (AugmentationSchema augSchema : schemaPathAugmentListEntry.getValue()) {
279 genCtx = processUsesAugments(schemaContext, augSchema, module, genCtx, genTypeBuilders,
280 verboseClassComments, typeProvider, namespaceType);
287 static void addUsesImplements(final DataNodeContainer superNode, final Module superModule,
288 final DataNodeContainer node, final Module module,
289 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType ) {
290 for (SchemaNode superChildNode : superNode.getChildNodes()) {
291 if (superChildNode instanceof DataNodeContainer) {
292 final QName childQName = QName.create(((SchemaNode)node).getQName(), superChildNode.getQName().getLocalName());
293 DataSchemaNode childNode = node.getDataChildByName(childQName);
294 Preconditions.checkNotNull(childNode, ((SchemaNode) node).getPath() + "->" + childQName.toString());
296 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
297 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
299 //TODO:delete this after supporting uses augment
300 if (type == null || superType == null) {
303 Preconditions.checkNotNull(type, module.toString() + "->" + childNode.getPath().toString());
304 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superChildNode.getPath().toString());
305 type.addImplementsType(superType);
306 if (superChildNode instanceof ListSchemaNode
307 && !((ListSchemaNode)superChildNode).getKeyDefinition().isEmpty()) {
308 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
309 genCtx.get(module).getKeyType(childNode.getPath())
310 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
311 } else if (namespaceType.equals(BindingNamespaceType.Data)){
312 genCtx.get(module).getKeyGenTO(childNode.getPath())
313 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
316 addUsesImplements((DataNodeContainer)superChildNode, superModule, (DataNodeContainer)childNode, module, schemaContext, genCtx, namespaceType);
321 static Map<Module, ModuleContext> processUsesImplements(final DataNodeContainer node, final Module module,
322 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
324 for (final UsesNode usesNode : node.getUses()) {
325 final SchemaNode groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
326 Preconditions.checkNotNull(groupingNode, module.toString() + "->"
327 + usesNode.getGroupingPath().toString());
328 Preconditions.checkState(groupingNode instanceof GroupingDefinition,
329 module.toString() + "->" + usesNode.getGroupingPath().toString());
330 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, groupingNode);
331 GroupingDefinition grouping = (GroupingDefinition)groupingNode;
332 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
337 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
338 for (final ModuleContext ctx : genCtx.values()) {
339 final GeneratedTypeBuilder result = ctx.getChildNode(path);
340 if (result != null) {
347 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
348 for (final ModuleContext ctx : genCtx.values()) {
349 final GeneratedTypeBuilder result = ctx.getCase(path);
350 if (result != null) {
357 static GeneratedTypeBuilder findKeyByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
358 for (final ModuleContext ctx : genCtx.values()) {
359 final GeneratedTypeBuilder result = ctx.getKeyType(path);
360 if (result != null) {
367 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
368 final Type targetTypeRef, final List<AugmentationSchema> schemaPathAugmentListEntry,
369 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
370 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
371 final BindingNamespaceType namespaceType) {
373 //pick augmentation grouped by augmentation target, there is always at least one
374 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
376 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
377 augmentPackageName, k -> new HashMap<>());
379 //this requires valid semantics in YANG model
380 String augIdentifier = null;
381 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
382 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
386 boolean isTypeNormalized = false;
387 if (augIdentifier == null) {
388 augIdentifier = augGenTypeName(augmentBuilders, targetTypeRef.getName());
389 isTypeNormalized = true;
392 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
393 false, isTypeNormalized);
395 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
396 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
397 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
398 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
399 augTypeBuilder.setWithBuilder(true);
400 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
402 //produces getters for augTypeBuilder eventually
403 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
405 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
406 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
407 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
410 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
412 if(!augSchema.getChildNodes().isEmpty()) {
413 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
414 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
416 genCtx.get(module).addAugmentType(augTypeBuilder);
421 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
422 * node for which <code>typeBuilder</code> was created.
426 * @param basePackageName
427 * string contains the module package name
429 * generated type builder which represents any node. The subnodes
430 * of this node are added to the <code>typeBuilder</code> as
431 * methods. The subnode can be of type leaf, leaf-list, list,
436 * set of data schema nodes which are the children of the node
437 * for which <code>typeBuilder</code> was created
438 * @return generated type builder which is the same object as the input
439 * parameter <code>typeBuilder</code>. The getter method could be
442 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
443 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
444 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
445 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
446 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
447 if (schemaNodes != null && typeBuilder != null) {
448 for (final DataSchemaNode schemaNode : schemaNodes) {
449 if (!schemaNode.isAugmenting()) {
450 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
451 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
459 * Instantiates generated type builder with <code>packageName</code> and
460 * <code>schemaNode</code>.
462 * The new builder always implements
463 * {@link TreeNode TreeNode}.<br>
464 * If <code>schemaNode</code> is instance of GroupingDefinition it also
465 * implements {@link Augmentable
467 * If <code>schemaNode</code> is instance of
468 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
469 * DataNodeContainer} it can also implement nodes which are specified in
472 * @param basePackageName
473 * string contains the module package name
475 * schema node for which is created generated type builder
477 * parent type (can be null)
478 * @param schemaContext schema context
479 * @return generated type builder <code>schemaNode</code>
481 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
482 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
483 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
484 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
487 if (schemaNode instanceof GroupingDefinition) {
489 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
493 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
494 verboseClassComments, genTypeBuilders, namespaceType);
495 if (namespaceType.equals(BindingNamespaceType.Data)) {
496 if (parent == null) {
497 it.addImplementsType(BindingTypes.TREE_NODE);
499 if (parent instanceof ListSchemaNode) {
500 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
501 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
503 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
504 (BindingTypes.ITEM, parent)));
505 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
509 if (!(schemaNode instanceof GroupingDefinition)) {
510 it.addImplementsType(BindingTypes.augmentable(it));
513 it.addImplementsType(BindingTypes.TREE_NODE);
516 if (schemaNode instanceof DataNodeContainer) {
517 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
518 verboseClassComments, genTypeBuilders, typeProvider);
519 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
525 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
526 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
527 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
528 genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
530 processUsesAugments(schemaContext, notification, module, genCtx, genTypeBuilders,
531 verboseClassComments, typeProvider, BindingNamespaceType.Data);
533 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
534 (basePackageName, notification, null, module, genCtx, schemaContext,
535 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
536 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
537 notificationInterface.addImplementsType(NOTIFICATION);
538 genCtx.get(module).addChildNodeType(notification, notificationInterface);
540 // Notification object
541 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
542 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
543 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
545 //in case of tied notification, incorporate parent's localName
546 final StringBuilder sb = new StringBuilder("on_");
547 if (parentName != null) {
548 sb.append(parentName).append('_');
550 sb.append(notificationInterface.getName());
552 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
553 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
554 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
555 return listenerInterface;
559 * Returns reference to generated type builder for specified
560 * <code>schemaNode</code> with <code>packageName</code>.
562 * Firstly the generated type builder is searched in
563 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
564 * found it is created and added to <code>genTypeBuilders</code>.
566 * @param basePackageName
567 * string contains the module package name
569 * schema node which provide data about the schema node name
570 * @param schemaContext schema context
572 * return type name prefix
573 * @return generated type builder for <code>schemaNode</code>
574 * @throws IllegalArgumentException
576 * <li>if <code>schemaNode</code> is null</li>
577 * <li>if <code>packageName</code> is null</li>
578 * <li>if QName of schema node is null</li>
579 * <li>if schemaNode name is null</li>
583 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
584 final SchemaContext schemaContext, final String prefix, final String suffix,
585 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
586 final BindingNamespaceType namespaceType) {
588 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
589 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
590 String schemaNodeName = schemaNode.getQName().getLocalName();
591 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
593 if (prefix != null && !prefix.isEmpty()) {
594 // underscore used as separator for distinction of class name parts
595 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
598 if (suffix != null && !suffix.isEmpty()) {
599 // underscore used as separator for distinction of class name parts
600 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
603 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
604 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName);
605 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
606 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
607 newType.addComment(schemaNode.getDescription());
608 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
609 verboseClassComments, namespaceType));
610 newType.setReference(schemaNode.getReference());
611 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
612 newType.setModuleName(module.getName());
613 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
614 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
616 if (!genTypeBuilders.containsKey(packageName)) {
617 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
618 builders.put(newType.getName(), newType);
619 genTypeBuilders.put(packageName, builders);
621 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
622 if (!builders.containsKey(newType.getName())) {
623 builders.put(newType.getName(), newType);
630 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
631 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
632 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
633 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
634 final BindingNamespaceType namespaceType) {
636 if (node != null && typeBuilder != null) {
637 if (node instanceof ContainerSchemaNode) {
638 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
639 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
640 } else if (node instanceof LeafListSchemaNode) {
641 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
642 typeProvider, genCtx);
643 } else if (node instanceof LeafSchemaNode) {
644 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
646 } else if (node instanceof ListSchemaNode) {
647 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
648 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
649 } else if (node instanceof ChoiceSchemaNode) {
650 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
651 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
652 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
653 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
659 * Converts <code>choiceNode</code> to the list of generated types for
660 * choice and its cases.
662 * The package names for choice and for its cases are created as
663 * concatenation of the module package (<code>basePackageName</code>) and
664 * names of all parents node.
668 * @param basePackageName
669 * string with the module package name
673 * choice node which is mapped to generated type. Also child
674 * nodes - cases are mapped to generated types.
675 * @throws IllegalArgumentException
677 * <li>if <code>basePackageName</code> is null</li>
678 * <li>if <code>choiceNode</code> is null</li>
681 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
682 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
683 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
684 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
685 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
686 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
688 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
689 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType);
690 constructGetter(parent, choiceNode.getQName().getLocalName(),
691 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
692 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
693 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
694 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
695 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
696 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
699 private static void containerToGenType(final Module module, final String basePackageName,
700 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
701 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
702 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
703 final BindingNamespaceType namespaceType) {
705 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
706 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
707 if (genType != null) {
708 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
709 final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
710 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
711 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
712 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
716 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
717 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
718 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
719 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
720 final BindingNamespaceType namespaceType) {
722 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
723 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
724 if (genType != null) {
725 final String nodeName = node.getQName().getLocalName();
727 Type getterReturnType = Types.listTypeFor(genType);
728 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
729 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
732 constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
734 final List<QName> listKeys = node.getKeyDefinition();
735 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
736 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
737 //FIXME: Is it neccessary to generate interface of key and implemented by class?
738 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
739 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node);
740 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
741 if (!schemaNode.isAugmenting()) {
742 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
743 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
746 if (genTypeBuilder != null) {
747 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
748 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
751 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
752 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
753 if (!schemaNode.isAugmenting()) {
754 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
755 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
760 if (genTOBuilder != null) {
761 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
762 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
763 genTOBuilder.setSUID(prop);
765 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
766 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
772 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
773 final Type keyType, final Map<Module, ModuleContext> genCtx,
774 final BindingNamespaceType namespaceType) {
775 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
776 if (keyType != null) {
777 Type returnKeyType = keyType;
778 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
779 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
782 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
788 * Converts <code>leaf</code> to the getter method which is added to
789 * <code>typeBuilder</code>.
792 * generated type builder to which is added getter method as
793 * <code>leaf</code> mapping
795 * leaf schema node which is mapped as getter method which is
796 * added to <code>typeBuilder</code>
798 * Module in which type was defined
799 * @return boolean value
801 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
803 * <li>true - in other cases</li>
806 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
807 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
808 final Module module, final TypeProvider typeProvider) {
809 if (leaf == null || typeBuilder == null) {
813 final String leafName = leaf.getQName().getLocalName();
814 if (leafName == null) {
818 final Module parentModule = findParentModule(schemaContext, leaf);
819 Type returnType = null;
821 final TypeDefinition<?> typeDef = leaf.getType();
822 if (isInnerType(leaf, typeDef)) {
823 if (typeDef instanceof EnumTypeDefinition) {
824 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
825 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
826 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
827 genCtx, typeBuilder, module);
828 if (enumBuilder != null) {
829 returnType = enumBuilder.toInstance(typeBuilder);
831 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
832 } else if (typeDef instanceof UnionTypeDefinition) {
833 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
834 typeProvider, schemaContext);
835 if (genTOBuilder != null) {
836 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
837 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
839 } else if (typeDef instanceof BitsTypeDefinition) {
840 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
841 typeProvider, schemaContext);
842 if (genTOBuilder != null) {
843 returnType = genTOBuilder.toInstance();
846 // It is constrained version of already declared type (inner declared type exists,
847 // onlyfor special cases (Enum, Union, Bits), which were already checked.
848 // In order to get proper class we need to look up closest derived type
849 // and apply restrictions from leaf type
850 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
851 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
855 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
856 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
859 if (returnType == null) {
863 if (typeDef instanceof EnumTypeDefinition) {
864 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
867 String leafDesc = leaf.getDescription();
868 if (leafDesc == null) {
872 final String leafGetterName;
873 if (!"".equals(nodeName)) {
874 StringBuilder sb = new StringBuilder(nodeName)
877 leafGetterName = sb.toString();
879 leafGetterName = leafName;
882 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
887 * Converts <code>node</code> leaf list schema node to getter method of
888 * <code>typeBuilder</code>.
891 * generated type builder to which is <code>node</code> added as
894 * leaf list schema node which is added to
895 * <code>typeBuilder</code> as getter method
896 * @param module module
897 * @param typeProvider type provider instance
898 * @param genCtx actual generated context
899 * @return boolean value
901 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
902 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
903 * <li>false - other cases</li>
906 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
907 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
908 final Map<Module, ModuleContext> genCtx) {
909 if (node == null || typeBuilder == null) {
913 final QName nodeName = node.getQName();
915 final TypeDefinition<?> typeDef = node.getType();
916 final Module parentModule = findParentModule(schemaContext, node);
918 Type returnType = null;
919 if (typeDef.getBaseType() == null) {
920 if (typeDef instanceof EnumTypeDefinition) {
921 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
922 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
923 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
924 genCtx, typeBuilder, module);
925 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
926 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
927 } else if (typeDef instanceof UnionTypeDefinition) {
928 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
929 typeProvider, schemaContext);
930 if (genTOBuilder != null) {
931 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
933 } else if (typeDef instanceof BitsTypeDefinition) {
934 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
935 typeProvider, schemaContext);
936 returnType = genTOBuilder.toInstance();
938 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
939 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
942 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
943 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
946 final ParameterizedType listType = Types.listTypeFor(returnType);
947 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
952 * Converts <code>caseNodes</code> set to list of corresponding generated
955 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
956 * created generated type builder. The package names for the builder is
957 * created as concatenation of the module package (
958 * <code>basePackageName</code>) and names of all parents nodes of the
959 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
960 * between every case builder and <i>choice</i> type
964 * @param schemaContext
965 * current schema context
967 * actual generated context
968 * @param basePackageName
969 * string with the module package name
970 * @param refChoiceType
971 * type which represents superior <i>case</i>
973 * choice case node which is mapped to generated type
974 * @param verboseClassComments
975 * Javadoc verbosity switch
976 * @throws IllegalArgumentException
978 * <li>if <code>basePackageName</code> equals null</li>
979 * <li>if <code>refChoiceType</code> equals null</li>
980 * <li>if <code>caseNodes</code> equals null</li>
983 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
984 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
985 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
986 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
987 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
988 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
989 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
991 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
992 if (caseNodes == null) {
996 for (final ChoiceCaseNode caseNode : caseNodes) {
997 if (caseNode != null && !caseNode.isAugmenting()) {
998 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
999 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1000 caseTypeBuilder.addImplementsType(refChoiceType);
1001 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1002 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1003 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1004 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1005 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1006 if (caseChildNodes != null) {
1007 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1009 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1010 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1012 if (parent instanceof AugmentationSchema) {
1013 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1014 final SchemaPath targetPath = augSchema.getTargetPath();
1015 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1016 if (targetSchemaNode instanceof DataSchemaNode
1017 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1018 if (targetSchemaNode instanceof DerivableSchemaNode) {
1019 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1021 if (targetSchemaNode == null) {
1022 throw new IllegalStateException(
1023 "Failed to find target node from grouping for augmentation " + augSchema
1024 + " in module " + module.getName());
1027 parent = targetSchemaNode;
1030 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1031 choiceNodeParentPath);
1032 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1033 if (childOfType == null) {
1034 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1036 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1037 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1039 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
1040 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
1041 verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1045 processUsesAugments(schemaContext, caseNode, module, genCtx, genTypeBuilders, verboseClassComments,
1046 typeProvider, namespaceType);
1050 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1051 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1052 final TypeProvider typeProvider) {
1054 final String anyName = node.getQName().getLocalName();
1055 if (anyName == null) {
1059 String anyDesc = node.getDescription();
1060 if (anyDesc == null) {
1064 Type returnType = Types.DOCUMENT;
1066 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1071 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1072 * or to <code>genTOBuilder</code> as property.
1075 * string contains the name of list
1076 * @param basePackageName
1077 * string contains the module package name
1079 * data schema node which should be added as getter method to
1080 * <code>typeBuilder</code> or as a property to
1081 * <code>genTOBuilder</code> if is part of the list key
1082 * @param typeBuilder
1083 * generated type builder for the list schema node
1084 * @param genTOBuilder
1085 * generated TO builder for the list keys
1087 * list of string which contains QNames of the list keys
1090 * @param typeProvider
1091 * provider that defines contract for generated types
1092 * @param schemaContext
1095 * map of generated entities in context of YANG modules
1096 * @param genTypeBuilders
1097 * map of generated type builders
1098 * @param verboseClassComments
1099 * generate verbose comments
1100 * @throws IllegalArgumentException
1102 * <li>if <code>schemaNode</code> equals null</li>
1103 * <li>if <code>typeBuilder</code> equals null</li>
1106 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1107 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1108 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1109 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1110 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1111 final BindingNamespaceType namespaceType) {
1112 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1113 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1115 if (schemaNode instanceof LeafSchemaNode) {
1116 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1117 final QName leafQName = leaf.getQName();
1119 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1121 if (listKeys.contains(leafQName)) {
1123 resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1126 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1130 if (schemaNode instanceof LeafListSchemaNode) {
1131 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1132 typeProvider, genCtx);
1133 } else if (schemaNode instanceof ContainerSchemaNode) {
1134 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1135 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1136 } else if (schemaNode instanceof ListSchemaNode) {
1137 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1138 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1139 } else if (schemaNode instanceof ChoiceSchemaNode) {
1140 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1141 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1146 private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1147 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1148 final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1149 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1150 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1151 final BindingNamespaceType namespaceType) {
1152 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1153 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1155 if (schemaNode instanceof LeafSchemaNode) {
1156 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1157 final QName leafQName = leaf.getQName();
1158 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1160 if (listKeys.contains(leafQName)) {
1161 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1165 if (schemaNode instanceof LeafListSchemaNode) {
1166 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1167 typeProvider, genCtx);
1168 } else if (schemaNode instanceof ContainerSchemaNode) {
1169 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1170 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1171 } else if (schemaNode instanceof ListSchemaNode) {
1172 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1173 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1174 } else if (schemaNode instanceof ChoiceSchemaNode) {
1175 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1176 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1181 private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1182 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1183 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1185 if (leaf != null && toBuilder != null) {
1187 final TypeDefinition<?> typeDef = leaf.getType();
1188 if (typeDef instanceof UnionTypeDefinition) {
1189 // GeneratedType for this type definition should be already
1191 final QName qname = typeDef.getQName();
1192 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1193 qname.getRevision());
1194 final ModuleContext mc = genCtx.get(unionModule);
1195 returnType = mc.getTypedefs().get(typeDef.getPath());
1196 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1197 // Annonymous enumeration (already generated, since it is inherited via uses).
1198 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1199 QName qname = originalLeaf.getQName();
1200 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1201 qname.getRevision());
1202 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1204 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1206 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1211 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1212 final TypeDefinition<?> baseType = typeDef.getBaseType();
1213 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1216 @SuppressWarnings({ "rawtypes", "unchecked" })
1217 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1218 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1219 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1220 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1222 if (node.isAugmenting()) {
1226 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1227 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1228 genType.addComment(node.getDescription());
1229 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1230 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1231 verboseClassComments, namespaceType));
1232 genType.setModuleName(module.getName());
1233 genType.setReference(node.getReference());
1234 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1235 genType.setParentTypeForBuilder(childOf);
1236 if (node instanceof DataNodeContainer) {
1237 genCtx.get(module).addChildNodeType(node, genType);
1238 processUsesAugments(schemaContext, (DataNodeContainer) node, module, genCtx, genTypeBuilders,
1239 verboseClassComments, typeProvider, namespaceType);
1245 * Converts all <b>groupings</b> of the module to the list of
1246 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1247 * dependencies. At least dependent (independent) groupings are in the list
1248 * saved at first positions. For every grouping the record is added to map
1249 * {@link ModuleContext#groupings allGroupings}
1254 * collection of groupings from which types will be generated
1255 * @param typeProvider
1256 * provider that defines contract for generated types
1257 * @param schemaContext
1260 * map of generated entities in context of YANG modules
1261 * @param genTypeBuilders
1262 * map of generated type builders
1263 * @param verboseClassComments
1264 * generate verbose comments
1267 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1268 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1269 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1270 final String basePackageName = BindingMapping.getRootPackageName(module);
1271 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1273 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1274 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1275 verboseClassComments, genTypeBuilders, typeProvider);
1281 * Converts individual grouping to GeneratedType. Firstly generated type
1282 * builder is created and every child node of grouping is resolved to the
1285 * @param basePackageName
1286 * string contains the module package name
1288 * GroupingDefinition which contains data about grouping
1291 * @param typeProvider
1292 * provider that defines contract for generated types
1293 * @param schemaContext
1296 * map of generated entities in context of YANG modules
1297 * @param genTypeBuilders
1298 * map of generated type builders
1299 * @param verboseClassComments
1300 * generate verbose comments
1302 * @return GeneratedType which is generated from grouping (object of type
1303 * <code>GroupingDefinition</code>)
1305 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1306 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1307 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1308 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1309 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1310 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1311 genCtx.get(module).addGroupingType(grouping, genType);
1312 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1313 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1314 genCtx = processUsesAugments(schemaContext, grouping, module, genCtx, genTypeBuilders, verboseClassComments,
1315 typeProvider, BindingNamespaceType.Grouping);
1316 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1321 * //TODO: add information about multiple base identities in YANG 1.1
1322 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1323 * created transport object builder. If identity contains base identity then
1324 * reference to base identity is added to superior identity as its extend.
1325 * If identity doesn't contain base identity then only reference to abstract
1326 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1327 * BaseIdentity} is added
1331 * @param basePackageName
1332 * string contains the module package name
1334 * IdentitySchemaNode which contains data about identity
1335 * @param schemaContext
1336 * SchemaContext which is used to get package and name
1337 * information about base of identity
1338 * @param genCtx generated context
1339 * @return returns generated context
1341 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1342 final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1343 boolean verboseClassComments) {
1345 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1349 private static GeneratedTOBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1350 final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1351 final Map<Module, ModuleContext> genCtx) {
1352 Preconditions.checkNotNull(identity,"Identity can not be null!");
1354 //check first if identity has been resolved as base identity of some other one
1355 GeneratedTOBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1356 if (newType == null) {
1357 final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1358 Preconditions.checkState(module.equals(parentModule),
1359 "If the type is null ,it must be in the same module, otherwise it must has been"
1360 + "resolved by an imported module.");
1362 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1363 BindingNamespaceType.Identity);
1364 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false);
1366 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1367 if (baseIdentities.size() == 0) {
1368 //no base - abstract
1369 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1370 BaseIdentity.class.getSimpleName());
1371 newType.setExtendsType(gto.toInstance());
1373 //one base - inheritance
1374 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1375 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1376 baseIdentity, module, verboseClassComments, genCtx);
1377 newType.setExtendsType(baseType.toInstance());
1380 newType.setAbstract(true);
1381 newType.addComment(identity.getDescription());
1382 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1383 verboseClassComments, BindingNamespaceType.Identity));
1384 newType.setReference(identity.getReference());
1385 newType.setModuleName(module.getName());
1386 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1388 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1390 genCtx.get(module).addIdentityType(identity.getQName(), newType);