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 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.GeneratedType;
56 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
57 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
58 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
59 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
60 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
63 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
64 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
65 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
66 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
67 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
68 import org.opendaylight.yangtools.yang.common.QName;
69 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
70 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
72 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
73 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
76 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
79 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.Module;
84 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
85 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
86 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
88 import org.opendaylight.yangtools.yang.model.api.Status;
89 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
90 import org.opendaylight.yangtools.yang.model.api.UsesNode;
91 import org.opendaylight.yangtools.yang.model.api.meta.ModelStatement;
92 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
93 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
94 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
96 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
99 * Helper util class used for generation of types in Binding spec v2.
102 final class GenHelperUtil {
104 private GenHelperUtil() {
105 throw new UnsupportedOperationException("Util class");
109 * Create GeneratedTypeBuilder object from module argument.
112 * Module object from which builder will be created
113 * @param genCtx generated context
114 * @param verboseClassComments verbosity switch
116 * @return <code>GeneratedTypeBuilder</code> which is internal
117 * representation of the module
118 * @throws IllegalArgumentException
121 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
122 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
124 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments,
126 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
127 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
128 moduleDataTypeBuilder.addComment(module.getDescription());
129 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
130 moduleDataTypeBuilder.setReference(module.getReference());
131 return moduleDataTypeBuilder;
135 * Generates type builder for <code>module</code>.
138 * Module which is source of package name for generated type
141 * string which is added to the module class name representation
143 * @param verboseClassComments verbosity switch
144 * @return instance of GeneratedTypeBuilder which represents
145 * <code>module</code>.
146 * @throws IllegalArgumentException
147 * if <code>module</code> is null
149 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
150 verboseClassComments, ModuleContext context) {
151 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
152 final String packageName = BindingMapping.getRootPackageName(module);
153 // underscore used as separator for distinction of module name parts
154 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
156 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName, context);
157 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
158 moduleBuilder.setReference(module.getReference());
159 moduleBuilder.setModuleName(moduleName);
160 return moduleBuilder;
164 * Adds the implemented types to type builder.
166 * The method passes through the list of <i>uses</i> in
167 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
168 * generated type from all groupings
169 * allGroupings} which is added as <i>implements type</i> to
170 * <code>builder</code>
172 * @param dataNodeContainer
173 * element which contains the list of used YANG groupings
175 * builder to which are added implemented types according to
176 * <code>dataNodeContainer</code>
177 * @param genCtx generated context
178 * @return generated type builder with all implemented types
180 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
181 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
182 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
183 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
184 if (genType == null) {
185 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
186 + builder.getName());
188 builder.addImplementsType(genType);
193 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
194 for (final ModuleContext ctx : genCtx.values()) {
195 final GeneratedTypeBuilder result = ctx.getGrouping(path);
196 if (result != null) {
203 static GeneratedTOBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
204 for (final ModuleContext ctx : genCtx.values()) {
205 final GeneratedTOBuilder result = ctx.getIdentities().get(qname);
206 if (result != null) {
214 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
215 * node for which <code>typeBuilder</code> was created.
217 * The subnodes aren't mapped to the methods if they are part of grouping or
218 * augment (in this case are already part of them).
222 * @param basePackageName
223 * string contains the module package name
225 * generated type builder which represents any node. The subnodes
226 * of this node are added to the <code>typeBuilder</code> as
227 * methods. The subnode can be of type leaf, leaf-list, list,
232 * set of data schema nodes which are the children of the node
233 * for which <code>typeBuilder</code> was created
234 * @return generated type builder which is the same builder as input
235 * parameter. The getter methods (representing child nodes) could be
238 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
239 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
240 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
241 final SchemaContext schemaContext, final boolean verboseClassComments,
242 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
243 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
245 if (schemaNodes != null && parent != null) {
246 for (final DataSchemaNode schemaNode : schemaNodes) {
247 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
248 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
249 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
256 static boolean resolveDataSchemaNodesCheck(final Module module, final SchemaContext schemaContext,
257 final DataSchemaNode schemaNode) {
258 if (!schemaNode.isAugmenting()) {
260 } else if (schemaNode.isAugmenting()) {
261 QName qname = schemaNode.getPath().getLastComponent();
262 final Module originalModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
263 qname.getRevision());
264 if (module.equals(originalModule)) {
272 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
273 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
274 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
275 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
276 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
277 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
280 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
281 QName childNodeQName = null;
282 if (node instanceof Module) {
283 childNodeQName = QName.create(((Module) node).getNamespace(), ((Module) node).getRevision(),
284 superChildNode.getQName().getLocalName());
285 } else if (node instanceof SchemaNode) {
286 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
287 } else if (node instanceof AugmentationSchema) {
288 childNodeQName = QName.create(module.getNamespace(), module.getRevision(), superChildNode.getQName().getLocalName());
290 throw new IllegalArgumentException("Not support node type:" + node.toString());
293 return childNodeQName;
296 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
297 final Object node, final Module module, final SchemaContext schemaContext,
298 Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
299 if (superNode instanceof DataNodeContainer) {
300 for (DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
301 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
302 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
303 DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
304 Preconditions.checkNotNull(childNode, node.toString() + "->" + childQName.toString());
306 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
307 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
309 Preconditions.checkNotNull(type, module.toString() + "->" + childNode.getPath().toString());
310 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superChildNode.getPath().toString());
311 type.addImplementsType(superType);
312 if (superChildNode instanceof ListSchemaNode
313 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
314 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
315 genCtx.get(module).getKeyType(childNode.getPath())
316 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
317 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
318 genCtx.get(module).getKeyGenTO(childNode.getPath())
319 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
322 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
325 } else if (superNode instanceof ChoiceSchemaNode) {
326 for (ChoiceCaseNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases()) {
327 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
328 ChoiceCaseNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
329 Preconditions.checkNotNull(caseNode, node.toString() + "->" + childQName.toString());
331 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
332 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
333 Preconditions.checkNotNull(type, module.toString() + "->" + caseNode.getPath().toString());
334 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superCaseNode.getPath().toString());
335 type.addImplementsType(superType);
336 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
339 throw new IllegalArgumentException("Not support super node :" + superNode.toString());
343 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
344 final Object parentNode, final UsesNode usesNode) {
345 SchemaNode groupingNode;
346 if (parentNode instanceof Module) {
347 final Module superModule = schemaContext.findModuleByNamespaceAndRevision(
348 usesNode.getGroupingPath().getLastComponent().getModule().getNamespace(),
349 usesNode.getGroupingPath().getLastComponent().getModule().getRevision());
350 groupingNode = superModule.getGroupings()
351 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
352 .findFirst().orElse(null);
354 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
355 final Iterable<QName> prefixedPath = usesNode.getGroupingPath().getPathFromRoot();
356 final QName current = prefixedPath.iterator().next();
357 final Module targetModule = schemaContext.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
358 Preconditions.checkArgument(targetModule != null, "Cannot find target module for %s and %s.",
359 current.getNamespace(), current.getRevision());
360 groupingNode = targetModule.getGroupings().stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
361 .collect(Collectors.toList()).get(0);
362 if (groupingNode == null) {
363 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
366 Preconditions.checkNotNull(groupingNode, module.toString() + "->"
367 + usesNode.getGroupingPath().toString());
368 Preconditions.checkState(groupingNode instanceof GroupingDefinition,
369 module.toString() + "->" + usesNode.getGroupingPath().toString());
370 return (GroupingDefinition) groupingNode;
373 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
374 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
375 if (node instanceof DataNodeContainer) {
376 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
377 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
378 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
379 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
385 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
386 for (final ModuleContext ctx : genCtx.values()) {
387 final GeneratedTypeBuilder result = ctx.getChildNode(path);
388 if (result != null) {
395 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
396 for (final ModuleContext ctx : genCtx.values()) {
397 final GeneratedTypeBuilder result = ctx.getCase(path);
398 if (result != null) {
405 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
406 final Type targetTypeRef, final SchemaNode targetNode, final List<AugmentationSchema> schemaPathAugmentListEntry,
407 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
408 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
409 final BindingNamespaceType namespaceType) {
411 //pick augmentation grouped by augmentation target, there is always at least one
412 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
414 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
415 augmentPackageName, k -> new HashMap<>());
417 //this requires valid semantics in YANG model
418 String augIdentifier = null;
419 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
420 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
424 if (augIdentifier == null) {
425 augIdentifier = new StringBuilder(module.getName())
426 .append('_').append(targetNode.getQName().getLocalName()).toString();
429 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
430 true, false, genCtx.get(module));
432 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
433 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
434 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
435 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
436 augTypeBuilder.setWithBuilder(true);
437 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
439 //produces getters for augTypeBuilder eventually
440 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
442 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
443 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
444 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
447 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
449 if(!augSchema.getChildNodes().isEmpty()) {
450 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
451 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
453 genCtx.get(module).addAugmentType(augTypeBuilder);
458 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
459 * node for which <code>typeBuilder</code> was created.
463 * @param basePackageName
464 * string contains the module package name
466 * generated type builder which represents any node. The subnodes
467 * of this node are added to the <code>typeBuilder</code> as
468 * methods. The subnode can be of type leaf, leaf-list, list,
473 * set of data schema nodes which are the children of the node
474 * for which <code>typeBuilder</code> was created
475 * @return generated type builder which is the same object as the input
476 * parameter <code>typeBuilder</code>. The getter method could be
479 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
480 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
481 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
482 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
483 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
484 if (schemaNodes != null && typeBuilder != null) {
485 for (final DataSchemaNode schemaNode : schemaNodes) {
486 if (!schemaNode.isAugmenting()) {
487 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
488 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
496 * Instantiates generated type builder with <code>packageName</code> and
497 * <code>schemaNode</code>.
499 * The new builder always implements
500 * {@link TreeNode TreeNode}.<br>
501 * If <code>schemaNode</code> is instance of GroupingDefinition it also
502 * implements {@link Augmentable
504 * If <code>schemaNode</code> is instance of
505 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
506 * DataNodeContainer} it can also implement nodes which are specified in
509 * @param basePackageName
510 * string contains the module package name
512 * schema node for which is created generated type builder
514 * parent type (can be null)
515 * @param schemaContext schema context
516 * @return generated type builder <code>schemaNode</code>
518 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
519 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
520 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
521 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
524 if (schemaNode instanceof GroupingDefinition) {
526 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
530 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
531 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
532 if (namespaceType.equals(BindingNamespaceType.Data)) {
533 if (parent == null) {
534 it.addImplementsType(BindingTypes.TREE_NODE);
536 if (parent instanceof ListSchemaNode) {
537 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
538 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
540 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
541 (BindingTypes.ITEM, parent)));
542 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
546 if (!(schemaNode instanceof GroupingDefinition)) {
547 it.addImplementsType(BindingTypes.augmentable(it));
550 it.addImplementsType(BindingTypes.TREE_NODE);
553 if (schemaNode instanceof DataNodeContainer) {
554 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
555 verboseClassComments, genTypeBuilders, typeProvider);
556 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
562 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
563 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
564 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
565 genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
566 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
567 (basePackageName, notification, null, module, genCtx, schemaContext,
568 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
569 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
570 notificationInterface.addImplementsType(NOTIFICATION);
571 genCtx.get(module).addChildNodeType(notification, notificationInterface);
573 // Notification object
574 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
575 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
576 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
578 //in case of tied notification, incorporate parent's localName
579 final StringBuilder sb = new StringBuilder("on_");
580 if (parentName != null) {
581 sb.append(parentName).append('_');
583 sb.append(notificationInterface.getName());
585 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
586 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
587 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
588 return listenerInterface;
592 * Returns reference to generated type builder for specified
593 * <code>schemaNode</code> with <code>packageName</code>.
595 * Firstly the generated type builder is searched in
596 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
597 * found it is created and added to <code>genTypeBuilders</code>.
599 * @param basePackageName
600 * string contains the module package name
602 * schema node which provide data about the schema node name
603 * @param schemaContext schema context
605 * return type name prefix
606 * @return generated type builder for <code>schemaNode</code>
607 * @throws IllegalArgumentException
609 * <li>if <code>schemaNode</code> is null</li>
610 * <li>if <code>packageName</code> is null</li>
611 * <li>if QName of schema node is null</li>
612 * <li>if schemaNode name is null</li>
616 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
617 final SchemaContext schemaContext, final String prefix, final String suffix,
618 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
619 final BindingNamespaceType namespaceType, ModuleContext context) {
621 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
622 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
623 String schemaNodeName = schemaNode.getQName().getLocalName();
624 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
626 if (prefix != null && !prefix.isEmpty()) {
627 // underscore used as separator for distinction of class name parts
628 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
631 if (suffix != null && !suffix.isEmpty()) {
632 // underscore used as separator for distinction of class name parts
633 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
636 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
637 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
638 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
639 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
640 newType.addComment(schemaNode.getDescription());
641 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
642 verboseClassComments, namespaceType));
643 newType.setReference(schemaNode.getReference());
644 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
645 newType.setModuleName(module.getName());
646 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
647 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
649 if (!genTypeBuilders.containsKey(packageName)) {
650 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
651 builders.put(newType.getName(), newType);
652 genTypeBuilders.put(packageName, builders);
654 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
655 if (!builders.containsKey(newType.getName())) {
656 builders.put(newType.getName(), newType);
663 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
664 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
665 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
666 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
667 final BindingNamespaceType namespaceType) {
669 if (node != null && typeBuilder != null) {
670 if (node instanceof ContainerSchemaNode) {
671 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
672 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
673 } else if (node instanceof LeafListSchemaNode) {
674 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
675 typeProvider, genCtx);
676 } else if (node instanceof LeafSchemaNode) {
677 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
679 } else if (node instanceof ListSchemaNode) {
680 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
681 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
682 } else if (node instanceof ChoiceSchemaNode) {
683 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
684 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
685 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
686 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
692 * Converts <code>choiceNode</code> to the list of generated types for
693 * choice and its cases.
695 * The package names for choice and for its cases are created as
696 * concatenation of the module package (<code>basePackageName</code>) and
697 * names of all parents node.
701 * @param basePackageName
702 * string with the module package name
706 * choice node which is mapped to generated type. Also child
707 * nodes - cases are mapped to generated types.
708 * @throws IllegalArgumentException
710 * <li>if <code>basePackageName</code> is null</li>
711 * <li>if <code>choiceNode</code> is null</li>
714 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
715 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
716 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
717 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
718 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
719 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
721 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
722 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType, genCtx.get(module));
723 constructGetter(parent, choiceNode.getQName().getLocalName(),
724 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
725 if (namespaceType.equals(BindingNamespaceType.Data)) {
726 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
728 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
729 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
730 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
731 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
734 private static void containerToGenType(final Module module, final String basePackageName,
735 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
736 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
737 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
738 final BindingNamespaceType namespaceType) {
740 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
741 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
742 if (genType != null) {
743 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
744 constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
745 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
746 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
747 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
751 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
752 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
753 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
754 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
755 final BindingNamespaceType namespaceType) {
757 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
758 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
759 if (genType != null) {
760 final String nodeName = node.getQName().getLocalName();
762 Type getterReturnType = Types.listTypeFor(genType);
763 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
764 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
767 constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
769 final List<QName> listKeys = node.getKeyDefinition();
770 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
771 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
772 //FIXME: Is it neccessary to generate interface of key and implemented by class?
773 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
774 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
775 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
776 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
777 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
778 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
781 if (genTypeBuilder != null) {
782 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
783 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
786 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
787 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
788 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
789 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
790 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
793 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
796 if (genTOBuilder != null) {
797 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
798 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
799 genTOBuilder.setSUID(prop);
801 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
802 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
808 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
809 final Type keyType, final Map<Module, ModuleContext> genCtx,
810 final BindingNamespaceType namespaceType) {
811 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
812 if (keyType != null) {
813 Type returnKeyType = keyType;
814 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
815 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
818 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
824 * Converts <code>leaf</code> to the getter method which is added to
825 * <code>typeBuilder</code>.
828 * generated type builder to which is added getter method as
829 * <code>leaf</code> mapping
831 * leaf schema node which is mapped as getter method which is
832 * added to <code>typeBuilder</code>
834 * Module in which type was defined
835 * @return boolean value
837 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
839 * <li>true - in other cases</li>
842 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
843 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
844 final Module module, final TypeProvider typeProvider) {
845 if (leaf == null || typeBuilder == null) {
849 final String leafName = leaf.getQName().getLocalName();
850 if (leafName == null) {
854 final Module parentModule = findParentModule(schemaContext, leaf);
855 Type returnType = null;
857 final TypeDefinition<?> typeDef = leaf.getType();
859 if (leaf.isAddedByUses()) {
860 Preconditions.checkState(leaf instanceof DerivableSchemaNode);
861 LeafSchemaNode originalLeaf = (LeafSchemaNode)((DerivableSchemaNode) leaf).getOriginal().orNull();
862 Preconditions.checkNotNull(originalLeaf);
863 if (isInnerType(originalLeaf, typeDef)) {
864 if (typeDef instanceof EnumTypeDefinition
865 || typeDef instanceof UnionTypeDefinition
866 || typeDef instanceof BitsTypeDefinition) {
867 returnType = genCtx.get(findParentModule(schemaContext, originalLeaf)).getInnerType(typeDef.getPath());
869 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
870 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
871 restrictions, genCtx.get(module));
874 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
875 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
877 } else if (isInnerType(leaf, typeDef)) {
878 if (typeDef instanceof EnumTypeDefinition) {
879 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
880 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
881 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
882 genCtx, typeBuilder, module);
883 if (enumBuilder != null) {
884 returnType = enumBuilder.toInstance(typeBuilder);
886 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
887 } else if (typeDef instanceof UnionTypeDefinition) {
888 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
889 typeProvider, schemaContext, genCtx.get(module), genCtx);
890 if (genTOBuilder != null) {
891 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
892 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
894 } else if (typeDef instanceof BitsTypeDefinition) {
895 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
896 typeProvider, schemaContext, genCtx.get(module), genCtx);
897 if (genTOBuilder != null) {
898 returnType = genTOBuilder.toInstance();
901 // It is constrained version of already declared type (inner declared type exists,
902 // onlyfor special cases (Enum, Union, Bits), which were already checked.
903 // In order to get proper class we need to look up closest derived type
904 // and apply restrictions from leaf type
905 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
906 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
907 restrictions, genCtx.get(module));
910 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
911 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
915 if (returnType == null) {
919 if (typeDef instanceof EnumTypeDefinition) {
920 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
923 String leafDesc = leaf.getDescription();
924 if (leafDesc == null) {
928 final String leafGetterName;
929 if ("key".equals(leafName.toLowerCase())) {
930 StringBuilder sb = new StringBuilder(leafName)
931 .append('_').append("RESERVED_WORD");
932 leafGetterName = sb.toString();
934 leafGetterName = leafName;
936 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
941 * Converts <code>node</code> leaf list schema node to getter method of
942 * <code>typeBuilder</code>.
945 * generated type builder to which is <code>node</code> added as
948 * leaf list schema node which is added to
949 * <code>typeBuilder</code> as getter method
950 * @param module module
951 * @param typeProvider type provider instance
952 * @param genCtx actual generated context
953 * @return boolean value
955 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
956 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
957 * <li>false - other cases</li>
960 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
961 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
962 final Map<Module, ModuleContext> genCtx) {
963 if (node == null || typeBuilder == null) {
967 final QName nodeName = node.getQName();
969 final TypeDefinition<?> typeDef = node.getType();
970 final Module parentModule = findParentModule(schemaContext, node);
972 Type returnType = null;
973 if (typeDef.getBaseType() == null) {
974 if (typeDef instanceof EnumTypeDefinition) {
975 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
976 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
977 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
978 genCtx, typeBuilder, module);
979 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(), true,
981 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
982 } else if (typeDef instanceof UnionTypeDefinition) {
983 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
984 typeProvider, schemaContext, genCtx.get(module), genCtx);
985 if (genTOBuilder != null) {
986 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
988 } else if (typeDef instanceof BitsTypeDefinition) {
989 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
990 typeProvider, schemaContext, genCtx.get(module), genCtx);
991 returnType = genTOBuilder.toInstance();
993 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
994 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
997 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
998 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
1001 final ParameterizedType listType = Types.listTypeFor(returnType);
1002 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
1007 * Converts <code>caseNodes</code> set to list of corresponding generated
1010 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1011 * created generated type builder. The package names for the builder is
1012 * created as concatenation of the module package (
1013 * <code>basePackageName</code>) and names of all parents nodes of the
1014 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1015 * between every case builder and <i>choice</i> type
1019 * @param schemaContext
1020 * current schema context
1022 * actual generated context
1023 * @param basePackageName
1024 * string with the module package name
1025 * @param refChoiceType
1026 * type which represents superior <i>case</i>
1028 * choice case node which is mapped to generated type
1029 * @param verboseClassComments
1030 * Javadoc verbosity switch
1031 * @throws IllegalArgumentException
1033 * <li>if <code>basePackageName</code> equals null</li>
1034 * <li>if <code>refChoiceType</code> equals null</li>
1035 * <li>if <code>caseNodes</code> equals null</li>
1038 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1039 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1040 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1041 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1042 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1043 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1044 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1046 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1047 if (caseNodes == null) {
1051 for (final ChoiceCaseNode caseNode : caseNodes) {
1052 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1053 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1054 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1055 caseTypeBuilder.addImplementsType(refChoiceType);
1056 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1057 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1058 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1059 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1060 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1061 if (caseChildNodes != null) {
1062 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1064 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1065 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1067 if (parent instanceof AugmentationSchema) {
1068 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1069 final SchemaPath targetPath = augSchema.getTargetPath();
1070 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1071 if (targetSchemaNode instanceof DataSchemaNode
1072 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1073 if (targetSchemaNode instanceof DerivableSchemaNode) {
1074 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1076 if (targetSchemaNode == null) {
1077 throw new IllegalStateException(
1078 "Failed to find target node from grouping for augmentation " + augSchema
1079 + " in module " + module.getName());
1082 parent = targetSchemaNode;
1085 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1086 choiceNodeParentPath);
1087 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1088 if (childOfType == null) {
1089 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1091 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1092 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1094 final GeneratedTypeBuilder moduleType = genCtx.get(module).getModuleNode();
1095 Preconditions.checkNotNull(moduleType, "Module type can not be null.");
1096 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleType, caseChildNodes,
1097 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1099 processUsesImplements(caseNode, module, schemaContext, genCtx, namespaceType);
1105 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1106 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1107 final TypeProvider typeProvider) {
1109 final String anyName = node.getQName().getLocalName();
1110 if (anyName == null) {
1114 String anyDesc = node.getDescription();
1115 if (anyDesc == null) {
1119 Type returnType = Types.DOCUMENT;
1121 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1126 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1127 * or to <code>genTOBuilder</code> as property.
1130 * string contains the name of list
1131 * @param basePackageName
1132 * string contains the module package name
1134 * data schema node which should be added as getter method to
1135 * <code>typeBuilder</code> or as a property to
1136 * <code>genTOBuilder</code> if is part of the list key
1137 * @param typeBuilder
1138 * generated type builder for the list schema node
1139 * @param genTOBuilder
1140 * generated TO builder for the list keys
1142 * list of string which contains QNames of the list keys
1145 * @param typeProvider
1146 * provider that defines contract for generated types
1147 * @param schemaContext
1150 * map of generated entities in context of YANG modules
1151 * @param genTypeBuilders
1152 * map of generated type builders
1153 * @param verboseClassComments
1154 * generate verbose comments
1155 * @throws IllegalArgumentException
1157 * <li>if <code>schemaNode</code> equals null</li>
1158 * <li>if <code>typeBuilder</code> equals null</li>
1161 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1162 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1163 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1164 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1165 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1166 final BindingNamespaceType namespaceType) {
1167 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1168 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1170 if (schemaNode instanceof LeafSchemaNode) {
1171 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1172 final QName leafQName = leaf.getQName();
1174 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1176 if (listKeys.contains(leafQName)) {
1178 resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1181 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1185 if (schemaNode instanceof LeafListSchemaNode) {
1186 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1187 typeProvider, genCtx);
1188 } else if (schemaNode instanceof ContainerSchemaNode) {
1189 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1190 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1191 } else if (schemaNode instanceof ListSchemaNode) {
1192 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1193 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1194 } else if (schemaNode instanceof ChoiceSchemaNode) {
1195 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1196 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1201 private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1202 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1203 final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1204 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1205 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1206 final BindingNamespaceType namespaceType) {
1207 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1208 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1210 if (schemaNode instanceof LeafSchemaNode) {
1211 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1212 final QName leafQName = leaf.getQName();
1213 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1215 if (listKeys.contains(leafQName)) {
1216 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1220 if (schemaNode instanceof LeafListSchemaNode) {
1221 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1222 typeProvider, genCtx);
1223 } else if (schemaNode instanceof ContainerSchemaNode) {
1224 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1225 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1226 } else if (schemaNode instanceof ListSchemaNode) {
1227 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1228 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1229 } else if (schemaNode instanceof ChoiceSchemaNode) {
1230 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1231 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1236 private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1237 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1238 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1240 if (leaf != null && toBuilder != null) {
1242 final TypeDefinition<?> typeDef = leaf.getType();
1243 if (typeDef instanceof UnionTypeDefinition) {
1244 // GeneratedType for this type definition should be already
1246 final QName qname = typeDef.getQName();
1247 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1248 qname.getRevision());
1249 final ModuleContext mc = genCtx.get(unionModule);
1250 returnType = mc.getTypedefs().get(typeDef.getPath());
1251 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1252 // Annonymous enumeration (already generated, since it is inherited via uses).
1253 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1254 QName qname = originalLeaf.getQName();
1255 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1256 qname.getRevision());
1257 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1259 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1261 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1266 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1267 final TypeDefinition<?> baseType = typeDef.getBaseType();
1268 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1271 @SuppressWarnings({ "rawtypes", "unchecked" })
1272 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1273 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1274 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1275 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1277 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1278 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1279 genType.addComment(node.getDescription());
1280 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1281 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1282 verboseClassComments, namespaceType));
1283 genType.setModuleName(module.getName());
1284 genType.setReference(node.getReference());
1285 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1286 genType.setParentTypeForBuilder(childOf);
1287 if (node instanceof DataNodeContainer) {
1288 genCtx.get(module).addChildNodeType(node, genType);
1294 * Converts all <b>groupings</b> of the module to the list of
1295 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1296 * dependencies. At least dependent (independent) groupings are in the list
1297 * saved at first positions. For every grouping the record is added to map
1298 * {@link ModuleContext#groupings allGroupings}
1303 * collection of groupings from which types will be generated
1304 * @param typeProvider
1305 * provider that defines contract for generated types
1306 * @param schemaContext
1309 * map of generated entities in context of YANG modules
1310 * @param genTypeBuilders
1311 * map of generated type builders
1312 * @param verboseClassComments
1313 * generate verbose comments
1316 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1317 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1318 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1319 final String basePackageName = BindingMapping.getRootPackageName(module);
1320 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1322 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1323 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1324 verboseClassComments, genTypeBuilders, typeProvider);
1330 * Converts individual grouping to GeneratedType. Firstly generated type
1331 * builder is created and every child node of grouping is resolved to the
1334 * @param basePackageName
1335 * string contains the module package name
1337 * GroupingDefinition which contains data about grouping
1340 * @param typeProvider
1341 * provider that defines contract for generated types
1342 * @param schemaContext
1345 * map of generated entities in context of YANG modules
1346 * @param genTypeBuilders
1347 * map of generated type builders
1348 * @param verboseClassComments
1349 * generate verbose comments
1351 * @return GeneratedType which is generated from grouping (object of type
1352 * <code>GroupingDefinition</code>)
1354 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1355 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1356 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1357 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1358 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1359 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1360 genCtx.get(module).addGroupingType(grouping, genType);
1361 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1362 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1363 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1368 * //TODO: add information about multiple base identities in YANG 1.1
1369 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1370 * created transport object builder. If identity contains base identity then
1371 * reference to base identity is added to superior identity as its extend.
1372 * If identity doesn't contain base identity then only reference to abstract
1373 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1374 * BaseIdentity} is added
1378 * @param basePackageName
1379 * string contains the module package name
1381 * IdentitySchemaNode which contains data about identity
1382 * @param schemaContext
1383 * SchemaContext which is used to get package and name
1384 * information about base of identity
1385 * @param genCtx generated context
1386 * @return returns generated context
1388 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1389 final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1390 boolean verboseClassComments) {
1392 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1396 private static GeneratedTOBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1397 final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1398 final Map<Module, ModuleContext> genCtx) {
1399 Preconditions.checkNotNull(identity,"Identity can not be null!");
1401 //check first if identity has been resolved as base identity of some other one
1402 GeneratedTOBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1403 if (newType == null) {
1404 final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1405 Preconditions.checkState(module.equals(parentModule),
1406 "If the type is null ,it must be in the same module, otherwise it must has been"
1407 + "resolved by an imported module.");
1409 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1410 BindingNamespaceType.Identity);
1411 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false,
1412 genCtx.get(module));
1414 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1415 if (baseIdentities.size() == 0) {
1416 //no base - abstract
1417 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1418 BaseIdentity.class.getSimpleName(), genCtx.get(module));
1419 newType.setExtendsType(gto.toInstance());
1421 //one base - inheritance
1422 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1423 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1424 baseIdentity, module, verboseClassComments, genCtx);
1425 newType.setExtendsType(baseType.toInstance());
1428 newType.setAbstract(true);
1429 newType.addComment(identity.getDescription());
1430 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1431 verboseClassComments, BindingNamespaceType.Identity));
1432 newType.setReference(identity.getReference());
1433 newType.setModuleName(module.getName());
1434 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1436 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1438 genCtx.get(module).addIdentityType(identity.getQName(), newType);