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.constructGetter;
15 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createDescription;
16 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createReturnTypeForUnion;
17 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.getAugmentIdentifier;
18 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.isInnerType;
19 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.qNameConstant;
20 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveInnerEnumFromTypeDefinition;
21 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTOBuilder;
22 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTypeBuilder;
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.mdsal.binding.javav2.generator.util.Types.wildcardTypeFor;
29 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
32 import com.google.common.annotations.Beta;
33 import com.google.common.base.Preconditions;
34 import com.google.common.collect.Iterables;
35 import java.util.Collection;
36 import java.util.HashMap;
37 import java.util.List;
40 import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
41 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
42 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
43 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
50 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
51 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
52 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
53 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
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.spec.base.BaseIdentity;
63 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
64 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
65 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
66 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
67 import org.opendaylight.yangtools.yang.common.QName;
68 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
69 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
70 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
71 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
72 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
73 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
75 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
78 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
79 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.Module;
83 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
84 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
85 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
87 import org.opendaylight.yangtools.yang.model.api.Status;
88 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
89 import org.opendaylight.yangtools.yang.model.api.UsesNode;
90 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
91 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
92 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
93 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
94 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
97 * Helper util class used for generation of types in Binding spec v2.
100 final class GenHelperUtil {
102 private GenHelperUtil() {
103 throw new UnsupportedOperationException("Util class");
107 * Create GeneratedTypeBuilder object from module argument.
110 * Module object from which builder will be created
111 * @param genCtx generated context
112 * @param verboseClassComments verbosity switch
114 * @return <code>GeneratedTypeBuilder</code> which is internal
115 * representation of the module
116 * @throws IllegalArgumentException
119 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
120 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
122 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, final ModuleContext context) {
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, context);
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) {
201 static GeneratedTOBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
202 for (final ModuleContext ctx : genCtx.values()) {
203 final GeneratedTOBuilder result = ctx.getIdentities().get(qname);
204 if (result != null) {
212 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
213 * node for which <code>typeBuilder</code> was created.
215 * The subnodes aren't mapped to the methods if they are part of grouping or
216 * augment (in this case are already part of them).
220 * @param basePackageName
221 * string contains the module package name
223 * generated type builder which represents any node. The subnodes
224 * of this node are added to the <code>typeBuilder</code> as
225 * methods. The subnode can be of type leaf, leaf-list, list,
230 * set of data schema nodes which are the children of the node
231 * for which <code>typeBuilder</code> was created
232 * @return generated type builder which is the same builder as input
233 * parameter. The getter methods (representing child nodes) could be
236 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
237 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
238 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
239 final SchemaContext schemaContext, final boolean verboseClassComments,
240 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
241 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
243 if (schemaNodes != null && parent != null) {
244 for (final DataSchemaNode schemaNode : schemaNodes) {
245 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
246 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
247 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
254 static boolean resolveDataSchemaNodesCheck(final Module module, final SchemaContext schemaContext,
255 final DataSchemaNode schemaNode) {
256 if (!schemaNode.isAugmenting()) {
258 } else if (schemaNode.isAugmenting()) {
259 final QName qname = schemaNode.getPath().getLastComponent();
260 final Module originalModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
261 qname.getRevision());
262 if (module.equals(originalModule)) {
270 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
271 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
272 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
273 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
274 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
275 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
278 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
279 QName childNodeQName = null;
280 if (node instanceof Module) {
281 childNodeQName = QName.create(((Module) node).getNamespace(), ((Module) node).getRevision(),
282 superChildNode.getQName().getLocalName());
283 } else if (node instanceof SchemaNode) {
284 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
285 } else if (node instanceof AugmentationSchema) {
286 childNodeQName = QName.create(module.getNamespace(), module.getRevision(), superChildNode.getQName().getLocalName());
288 throw new IllegalArgumentException("Not support node type:" + node.toString());
291 return childNodeQName;
294 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
295 final Object node, final Module module, final SchemaContext schemaContext,
296 final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
297 if (superNode instanceof DataNodeContainer) {
298 for (final DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
299 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
300 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
301 final DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
302 Preconditions.checkNotNull(childNode, node.toString() + "->" + childQName.toString());
304 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
305 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
307 Preconditions.checkNotNull(type, module.toString() + "->" + childNode.getPath().toString());
308 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superChildNode.getPath().toString());
309 type.addImplementsType(superType);
310 if (superChildNode instanceof ListSchemaNode
311 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
312 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
313 genCtx.get(module).getKeyType(childNode.getPath())
314 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
315 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
316 genCtx.get(module).getKeyGenTO(childNode.getPath())
317 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
320 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
323 } else if (superNode instanceof ChoiceSchemaNode) {
324 for (final ChoiceCaseNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases()) {
325 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
326 final ChoiceCaseNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
327 Preconditions.checkNotNull(caseNode, node.toString() + "->" + childQName.toString());
329 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
330 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
331 Preconditions.checkNotNull(type, module.toString() + "->" + caseNode.getPath().toString());
332 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superCaseNode.getPath().toString());
333 type.addImplementsType(superType);
334 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
337 throw new IllegalArgumentException("Not support super node :" + superNode.toString());
341 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
342 final Object parentNode, final UsesNode usesNode) {
343 SchemaNode groupingNode;
344 if (parentNode instanceof Module) {
345 final Module superModule = schemaContext.findModuleByNamespaceAndRevision(
346 usesNode.getGroupingPath().getLastComponent().getModule().getNamespace(),
347 usesNode.getGroupingPath().getLastComponent().getModule().getRevision());
348 groupingNode = superModule.getGroupings()
349 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
350 .findFirst().orElse(null);
352 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
353 final Iterable<QName> prefixedPath = usesNode.getGroupingPath().getPathFromRoot();
354 final QName current = prefixedPath.iterator().next();
355 final Module targetModule = schemaContext.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
356 Preconditions.checkArgument(targetModule != null, "Cannot find target module for %s and %s.",
357 current.getNamespace(), current.getRevision());
358 groupingNode = targetModule.getGroupings().stream()
359 .filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath())).findFirst().orElse(null);
360 if (groupingNode == null) {
361 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
364 Preconditions.checkNotNull(groupingNode, module.toString() + "->"
365 + usesNode.getGroupingPath().toString());
366 Preconditions.checkState(groupingNode instanceof GroupingDefinition,
367 module.toString() + "->" + usesNode.getGroupingPath().toString());
368 return (GroupingDefinition) groupingNode;
371 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
372 final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
373 if (node instanceof DataNodeContainer) {
374 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
375 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
376 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
377 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
383 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
384 for (final ModuleContext ctx : genCtx.values()) {
385 final GeneratedTypeBuilder result = ctx.getChildNode(path);
386 if (result != null) {
393 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
394 for (final ModuleContext ctx : genCtx.values()) {
395 final GeneratedTypeBuilder result = ctx.getCase(path);
396 if (result != null) {
403 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
404 final Type targetTypeRef, final SchemaNode targetNode, final List<AugmentationSchema> schemaPathAugmentListEntry,
405 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
406 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
407 final BindingNamespaceType namespaceType) {
409 //pick augmentation grouped by augmentation target, there is always at least one
410 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
412 final Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
413 augmentPackageName, k -> new HashMap<>());
415 //this requires valid semantics in YANG model
416 String augIdentifier = null;
417 for (final AugmentationSchema aug : schemaPathAugmentListEntry) {
418 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
422 if (augIdentifier == null) {
423 augIdentifier = new StringBuilder(module.getName())
424 .append('_').append(targetNode.getQName().getLocalName()).toString();
427 final GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
428 true, false, genCtx.get(module));
430 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
431 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
432 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
433 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
434 augTypeBuilder.setWithBuilder(true);
435 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
437 //produces getters for augTypeBuilder eventually
438 for (final AugmentationSchema aug : schemaPathAugmentListEntry) {
440 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
441 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
442 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
445 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
447 if(!augSchema.getChildNodes().isEmpty()) {
448 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
449 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
451 genCtx.get(module).addAugmentType(augTypeBuilder);
456 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
457 * node for which <code>typeBuilder</code> was created.
461 * @param basePackageName
462 * string contains the module package name
464 * generated type builder which represents any node. The subnodes
465 * of this node are added to the <code>typeBuilder</code> as
466 * methods. The subnode can be of type leaf, leaf-list, list,
471 * set of data schema nodes which are the children of the node
472 * for which <code>typeBuilder</code> was created
473 * @return generated type builder which is the same object as the input
474 * parameter <code>typeBuilder</code>. The getter method could be
477 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
478 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
479 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
480 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
481 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
482 if (schemaNodes != null && typeBuilder != null) {
483 for (final DataSchemaNode schemaNode : schemaNodes) {
484 if (!schemaNode.isAugmenting()) {
485 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
486 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
494 * Instantiates generated type builder with <code>packageName</code> and
495 * <code>schemaNode</code>.
497 * The new builder always implements
498 * {@link TreeNode TreeNode}.<br>
499 * If <code>schemaNode</code> is instance of GroupingDefinition it also
500 * implements {@link Augmentable
502 * If <code>schemaNode</code> is instance of
503 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
504 * DataNodeContainer} it can also implement nodes which are specified in
507 * @param basePackageName
508 * string contains the module package name
510 * schema node for which is created generated type builder
512 * parent type (can be null)
513 * @param schemaContext schema context
514 * @return generated type builder <code>schemaNode</code>
516 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
517 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
518 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
519 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
522 if (schemaNode instanceof GroupingDefinition) {
524 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
528 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
529 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
530 if (namespaceType.equals(BindingNamespaceType.Data)) {
531 if (parent == null) {
532 it.addImplementsType(BindingTypes.TREE_NODE);
534 if (parent instanceof ListSchemaNode) {
535 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
536 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
538 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
539 (BindingTypes.ITEM, parent)));
540 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
544 if (!(schemaNode instanceof GroupingDefinition)) {
545 it.addImplementsType(BindingTypes.augmentable(it));
548 it.addImplementsType(BindingTypes.TREE_NODE);
551 if (schemaNode instanceof DataNodeContainer) {
552 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
553 verboseClassComments, genTypeBuilders, typeProvider);
554 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
560 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, final String
561 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
562 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>>
563 genTypeBuilders, final TypeProvider typeProvider, final Map<Module, ModuleContext> genCtx) {
564 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
565 (basePackageName, notification, null, module, genCtx, schemaContext,
566 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
567 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
568 notificationInterface.addImplementsType(NOTIFICATION);
569 genCtx.get(module).addChildNodeType(notification, notificationInterface);
571 // Notification object
572 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
573 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
574 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
576 //in case of tied notification, incorporate parent's localName
577 final StringBuilder sb = new StringBuilder("on_");
578 if (parentName != null) {
579 sb.append(parentName).append('_');
581 sb.append(notificationInterface.getName());
583 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
584 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
585 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
586 return listenerInterface;
590 * Returns reference to generated type builder for specified
591 * <code>schemaNode</code> with <code>packageName</code>.
593 * Firstly the generated type builder is searched in
594 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
595 * found it is created and added to <code>genTypeBuilders</code>.
597 * @param basePackageName
598 * string contains the module package name
600 * schema node which provide data about the schema node name
601 * @param schemaContext schema context
603 * return type name prefix
604 * @return generated type builder for <code>schemaNode</code>
605 * @throws IllegalArgumentException
607 * <li>if <code>schemaNode</code> is null</li>
608 * <li>if <code>packageName</code> is null</li>
609 * <li>if QName of schema node is null</li>
610 * <li>if schemaNode name is null</li>
614 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
615 final SchemaContext schemaContext, final String prefix, final String suffix,
616 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
617 final BindingNamespaceType namespaceType, final ModuleContext context) {
619 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
620 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
621 String schemaNodeName = schemaNode.getQName().getLocalName();
622 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
624 if (prefix != null && !prefix.isEmpty()) {
625 // underscore used as separator for distinction of class name parts
626 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
629 if (suffix != null && !suffix.isEmpty()) {
630 // underscore used as separator for distinction of class name parts
631 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
634 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
635 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
636 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
637 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
638 newType.addComment(schemaNode.getDescription());
639 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
640 verboseClassComments, namespaceType));
641 newType.setReference(schemaNode.getReference());
642 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
643 newType.setModuleName(module.getName());
644 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
645 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
647 if (!genTypeBuilders.containsKey(packageName)) {
648 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
649 builders.put(newType.getName(), newType);
650 genTypeBuilders.put(packageName, builders);
652 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
653 if (!builders.containsKey(newType.getName())) {
654 builders.put(newType.getName(), newType);
661 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
662 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
663 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
664 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
665 final BindingNamespaceType namespaceType) {
667 if (node != null && typeBuilder != null) {
668 if (node instanceof ContainerSchemaNode) {
669 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
670 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
671 } else if (node instanceof LeafListSchemaNode) {
672 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
673 typeProvider, genCtx);
674 } else if (node instanceof LeafSchemaNode) {
675 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
677 } else if (node instanceof ListSchemaNode) {
678 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
679 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
680 } else if (node instanceof ChoiceSchemaNode) {
681 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
682 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
683 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
684 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
690 * Converts <code>choiceNode</code> to the list of generated types for
691 * choice and its cases.
693 * The package names for choice and for its cases are created as
694 * concatenation of the module package (<code>basePackageName</code>) and
695 * names of all parents node.
699 * @param basePackageName
700 * string with the module package name
704 * choice node which is mapped to generated type. Also child
705 * nodes - cases are mapped to generated types.
706 * @throws IllegalArgumentException
708 * <li>if <code>basePackageName</code> is null</li>
709 * <li>if <code>choiceNode</code> is null</li>
712 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
713 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
714 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
715 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
716 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
717 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
719 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
720 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType, genCtx.get(module));
721 constructGetter(parent, choiceNode.getQName().getLocalName(),
722 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
723 if (namespaceType.equals(BindingNamespaceType.Data)) {
724 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
726 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
727 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
728 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
729 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
732 private static void containerToGenType(final Module module, final String basePackageName,
733 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
734 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
735 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
736 final BindingNamespaceType namespaceType) {
738 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
739 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
740 if (genType != null) {
741 final StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
742 constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
743 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
744 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
745 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
749 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
750 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
751 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
752 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
753 final BindingNamespaceType namespaceType) {
755 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
756 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
757 if (genType != null) {
758 final String nodeName = node.getQName().getLocalName();
760 Type getterReturnType = Types.listTypeFor(genType);
761 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
762 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
765 constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
767 final List<QName> listKeys = node.getKeyDefinition();
768 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
769 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
770 //FIXME: Is it neccessary to generate interface of key and implemented by class?
771 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
772 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
773 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
774 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
775 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
776 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
779 if (genTypeBuilder != null) {
780 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
781 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
783 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
785 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
786 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
787 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
788 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
789 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
792 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
795 if (genTOBuilder != null) {
796 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
797 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
798 genTOBuilder.setSUID(prop);
800 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
801 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
807 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
808 final Type keyType, final Map<Module, ModuleContext> genCtx,
809 final BindingNamespaceType namespaceType) {
810 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
811 if (keyType != null) {
812 Type returnKeyType = keyType;
813 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
814 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
817 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
823 * Converts <code>leaf</code> to the getter method which is added to
824 * <code>typeBuilder</code>.
827 * generated type builder to which is added getter method as
828 * <code>leaf</code> mapping
830 * leaf schema node which is mapped as getter method which is
831 * added to <code>typeBuilder</code>
833 * Module in which type was defined
834 * @return boolean value
836 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
838 * <li>true - in other cases</li>
841 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
842 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
843 final Module module, final TypeProvider typeProvider) {
844 if (leaf == null || typeBuilder == null) {
848 final String leafName = leaf.getQName().getLocalName();
849 if (leafName == null) {
853 final Module parentModule = findParentModule(schemaContext, leaf);
854 Type returnType = null;
856 final TypeDefinition<?> typeDef = leaf.getType();
858 if (leaf.isAddedByUses()) {
859 Preconditions.checkState(leaf instanceof DerivableSchemaNode);
860 if (isInnerType(leaf, typeDef)) {
861 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
862 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
863 restrictions, genCtx.get(module));
865 if (typeDef.getBaseType() == null && (typeDef instanceof EnumTypeDefinition
866 || typeDef instanceof UnionTypeDefinition || typeDef instanceof BitsTypeDefinition)) {
867 final LeafSchemaNode originalLeaf = (LeafSchemaNode) ((DerivableSchemaNode) leaf).getOriginal().orNull();
868 Preconditions.checkNotNull(originalLeaf);
869 returnType = genCtx.get(findParentModule(schemaContext, originalLeaf)).getInnerType(typeDef.getPath());
871 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
872 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
875 } else if (isInnerType(leaf, typeDef)) {
876 if (typeDef instanceof EnumTypeDefinition) {
877 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
878 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
879 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
880 genCtx, typeBuilder, module);
881 if (enumBuilder != null) {
882 returnType = enumBuilder.toInstance(typeBuilder);
884 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
885 } else if (typeDef instanceof UnionTypeDefinition) {
886 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
887 typeProvider, schemaContext, genCtx.get(module), genCtx);
888 if (genTOBuilder != null) {
889 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
890 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
892 } else if (typeDef instanceof BitsTypeDefinition) {
893 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
894 typeProvider, schemaContext, genCtx.get(module), genCtx);
895 if (genTOBuilder != null) {
896 returnType = genTOBuilder.toInstance();
899 // It is constrained version of already declared type (inner declared type exists,
900 // onlyfor special cases (Enum, Union, Bits), which were already checked.
901 // In order to get proper class we need to look up closest derived type
902 // and apply restrictions from leaf type
903 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
904 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
905 restrictions, genCtx.get(module));
908 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
909 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
912 if (returnType == null) {
916 if (typeDef instanceof EnumTypeDefinition) {
917 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
920 String leafDesc = leaf.getDescription();
921 if (leafDesc == null) {
925 final String leafGetterName;
926 if ("key".equals(leafName.toLowerCase())) {
927 final StringBuilder sb = new StringBuilder(leafName)
928 .append('_').append("RESERVED_WORD");
929 leafGetterName = sb.toString();
931 leafGetterName = leafName;
933 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
938 * Converts <code>node</code> leaf list schema node to getter method of
939 * <code>typeBuilder</code>.
942 * generated type builder to which is <code>node</code> added as
945 * leaf list schema node which is added to
946 * <code>typeBuilder</code> as getter method
947 * @param module module
948 * @param typeProvider type provider instance
949 * @param genCtx actual generated context
950 * @return boolean value
952 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
953 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
954 * <li>false - other cases</li>
957 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
958 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
959 final Map<Module, ModuleContext> genCtx) {
960 if (node == null || typeBuilder == null) {
964 final QName nodeName = node.getQName();
966 final TypeDefinition<?> typeDef = node.getType();
967 final Module parentModule = findParentModule(schemaContext, node);
969 Type returnType = null;
970 if (typeDef.getBaseType() == null) {
971 if (typeDef instanceof EnumTypeDefinition) {
972 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
973 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
974 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
975 genCtx, typeBuilder, module);
976 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(), true,
978 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
979 } else if (typeDef instanceof UnionTypeDefinition) {
980 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
981 typeProvider, schemaContext, genCtx.get(module), genCtx);
982 if (genTOBuilder != null) {
983 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
985 } else if (typeDef instanceof BitsTypeDefinition) {
986 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
987 typeProvider, schemaContext, genCtx.get(module), genCtx);
988 returnType = genTOBuilder.toInstance();
990 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
991 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
994 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
995 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
998 final ParameterizedType listType = Types.listTypeFor(returnType);
999 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
1004 * Converts <code>caseNodes</code> set to list of corresponding generated
1007 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1008 * created generated type builder. The package names for the builder is
1009 * created as concatenation of the module package (
1010 * <code>basePackageName</code>) and names of all parents nodes of the
1011 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1012 * between every case builder and <i>choice</i> type
1016 * @param schemaContext
1017 * current schema context
1019 * actual generated context
1020 * @param basePackageName
1021 * string with the module package name
1022 * @param refChoiceType
1023 * type which represents superior <i>case</i>
1025 * choice case node which is mapped to generated type
1026 * @param verboseClassComments
1027 * Javadoc verbosity switch
1028 * @throws IllegalArgumentException
1030 * <li>if <code>basePackageName</code> equals null</li>
1031 * <li>if <code>refChoiceType</code> equals null</li>
1032 * <li>if <code>caseNodes</code> equals null</li>
1035 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1036 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1037 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1038 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1039 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1040 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1041 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1043 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1044 if (caseNodes == null) {
1048 for (final ChoiceCaseNode caseNode : caseNodes) {
1049 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1050 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1051 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1052 caseTypeBuilder.addImplementsType(refChoiceType);
1053 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1054 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1055 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1056 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1057 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1058 if (caseChildNodes != null) {
1059 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1061 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1062 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1064 if (parent instanceof AugmentationSchema) {
1065 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1066 final SchemaPath targetPath = augSchema.getTargetPath();
1067 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1068 if (targetSchemaNode instanceof DataSchemaNode
1069 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1070 if (targetSchemaNode instanceof DerivableSchemaNode) {
1071 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1073 if (targetSchemaNode == null) {
1074 throw new IllegalStateException(
1075 "Failed to find target node from grouping for augmentation " + augSchema
1076 + " in module " + module.getName());
1079 parent = targetSchemaNode;
1082 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1083 choiceNodeParentPath);
1084 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1085 if (childOfType == null) {
1086 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1088 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1089 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1091 final GeneratedTypeBuilder moduleType = genCtx.get(module).getModuleNode();
1092 Preconditions.checkNotNull(moduleType, "Module type can not be null.");
1093 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleType, caseChildNodes,
1094 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1096 processUsesImplements(caseNode, module, schemaContext, genCtx, namespaceType);
1102 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1103 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1104 final TypeProvider typeProvider) {
1106 final String anyName = node.getQName().getLocalName();
1107 if (anyName == null) {
1111 String anyDesc = node.getDescription();
1112 if (anyDesc == null) {
1116 final Type returnType = Types.DOCUMENT;
1118 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1123 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1124 * or to <code>genTOBuilder</code> as property.
1127 * string contains the name of list
1128 * @param basePackageName
1129 * string contains the module package name
1131 * data schema node which should be added as getter method to
1132 * <code>typeBuilder</code> or as a property to
1133 * <code>genTOBuilder</code> if is part of the list key
1134 * @param typeBuilder
1135 * generated type builder for the list schema node
1136 * @param genTOBuilder
1137 * generated TO builder for the list keys
1139 * list of string which contains QNames of the list keys
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
1152 * @throws IllegalArgumentException
1154 * <li>if <code>schemaNode</code> equals null</li>
1155 * <li>if <code>typeBuilder</code> equals null</li>
1158 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1159 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1160 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1161 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1162 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1163 final BindingNamespaceType namespaceType) {
1164 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1165 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1167 if (schemaNode instanceof LeafSchemaNode) {
1168 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1169 final QName leafQName = leaf.getQName();
1171 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1173 if (listKeys.contains(leafQName)) {
1175 resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1178 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1182 if (schemaNode instanceof LeafListSchemaNode) {
1183 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1184 typeProvider, genCtx);
1185 } else if (schemaNode instanceof ContainerSchemaNode) {
1186 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1187 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1188 } else if (schemaNode instanceof ListSchemaNode) {
1189 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1190 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1191 } else if (schemaNode instanceof ChoiceSchemaNode) {
1192 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1193 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1198 private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1199 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1200 final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1201 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1202 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1203 final BindingNamespaceType namespaceType) {
1204 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1205 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1207 if (schemaNode instanceof LeafSchemaNode) {
1208 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1209 final QName leafQName = leaf.getQName();
1210 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1212 if (listKeys.contains(leafQName)) {
1213 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1217 if (schemaNode instanceof LeafListSchemaNode) {
1218 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1219 typeProvider, genCtx);
1220 } else if (schemaNode instanceof ContainerSchemaNode) {
1221 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1222 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1223 } else if (schemaNode instanceof ListSchemaNode) {
1224 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1225 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1226 } else if (schemaNode instanceof ChoiceSchemaNode) {
1227 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1228 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1233 private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1234 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1235 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1237 if (leaf != null && toBuilder != null) {
1239 final TypeDefinition<?> typeDef = leaf.getType();
1240 if (typeDef instanceof UnionTypeDefinition) {
1241 // GeneratedType for this type definition should be already
1243 final QName qname = typeDef.getQName();
1244 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1245 qname.getRevision());
1246 final ModuleContext mc = genCtx.get(unionModule);
1247 returnType = mc.getTypedefs().get(typeDef.getPath());
1248 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1249 // Annonymous enumeration (already generated, since it is inherited via uses).
1250 final LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1251 final QName qname = originalLeaf.getQName();
1252 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1253 qname.getRevision());
1254 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1256 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1258 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1263 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1264 final TypeDefinition<?> baseType = typeDef.getBaseType();
1265 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1268 @SuppressWarnings({ "rawtypes", "unchecked" })
1269 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1270 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1271 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1272 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1274 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1275 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1276 genType.addComment(node.getDescription());
1277 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1278 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1279 verboseClassComments, namespaceType));
1280 genType.setModuleName(module.getName());
1281 genType.setReference(node.getReference());
1282 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1283 genType.setParentTypeForBuilder(childOf);
1284 if (node instanceof DataNodeContainer) {
1285 genCtx.get(module).addChildNodeType(node, genType);
1291 * Converts all <b>groupings</b> of the module to the list of
1292 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1293 * dependencies. At least dependent (independent) groupings are in the list
1294 * saved at first positions. For every grouping the record is added to map
1295 * {@link ModuleContext#groupings allGroupings}
1300 * collection of groupings from which types will be generated
1301 * @param typeProvider
1302 * provider that defines contract for generated types
1303 * @param schemaContext
1306 * map of generated entities in context of YANG modules
1307 * @param genTypeBuilders
1308 * map of generated type builders
1309 * @param verboseClassComments
1310 * generate verbose comments
1313 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1314 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1315 verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1316 final String basePackageName = BindingMapping.getRootPackageName(module);
1317 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1319 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1320 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1321 verboseClassComments, genTypeBuilders, typeProvider);
1327 * Converts individual grouping to GeneratedType. Firstly generated type
1328 * builder is created and every child node of grouping is resolved to the
1331 * @param basePackageName
1332 * string contains the module package name
1334 * GroupingDefinition which contains data about grouping
1337 * @param typeProvider
1338 * provider that defines contract for generated types
1339 * @param schemaContext
1342 * map of generated entities in context of YANG modules
1343 * @param genTypeBuilders
1344 * map of generated type builders
1345 * @param verboseClassComments
1346 * generate verbose comments
1348 * @return GeneratedType which is generated from grouping (object of type
1349 * <code>GroupingDefinition</code>)
1351 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1352 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1353 verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1354 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1355 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1356 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1357 genCtx.get(module).addGroupingType(grouping, genType);
1358 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1359 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1360 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1365 * //TODO: add information about multiple base identities in YANG 1.1
1366 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1367 * created transport object builder. If identity contains base identity then
1368 * reference to base identity is added to superior identity as its extend.
1369 * If identity doesn't contain base identity then only reference to abstract
1370 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1371 * BaseIdentity} is added
1375 * @param basePackageName
1376 * string contains the module package name
1378 * IdentitySchemaNode which contains data about identity
1379 * @param schemaContext
1380 * SchemaContext which is used to get package and name
1381 * information about base of identity
1382 * @param genCtx generated context
1383 * @return returns generated context
1385 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1386 final IdentitySchemaNode identity, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1387 final boolean verboseClassComments) {
1389 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1393 private static GeneratedTOBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1394 final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1395 final Map<Module, ModuleContext> genCtx) {
1396 Preconditions.checkNotNull(identity,"Identity can not be null!");
1398 //check first if identity has been resolved as base identity of some other one
1399 GeneratedTOBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1400 if (newType == null) {
1401 final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1402 Preconditions.checkState(module.equals(parentModule),
1403 "If the type is null ,it must be in the same module, otherwise it must has been"
1404 + "resolved by an imported module.");
1406 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1407 BindingNamespaceType.Identity);
1408 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false,
1409 genCtx.get(module));
1411 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1412 if (baseIdentities.size() == 0) {
1413 //no base - abstract
1414 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1415 BaseIdentity.class.getSimpleName(), genCtx.get(module));
1416 newType.setExtendsType(gto.toInstance());
1418 //one base - inheritance
1419 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1420 final GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1421 baseIdentity, module, verboseClassComments, genCtx);
1422 newType.setExtendsType(baseType.toInstance());
1425 newType.setAbstract(true);
1426 newType.addComment(identity.getDescription());
1427 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1428 verboseClassComments, BindingNamespaceType.Identity));
1429 newType.setReference(identity.getReference());
1430 newType.setModuleName(module.getName());
1431 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1433 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1435 genCtx.get(module).addIdentityType(identity.getQName(), newType);