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.createReturnTypeForUnion;
16 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.getAugmentIdentifier;
17 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.isInnerType;
18 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.qNameConstant;
19 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveInnerEnumFromTypeDefinition;
20 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTOBuilder;
21 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTypeBuilder;
22 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.computeDefaultSUID;
23 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
24 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
25 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.IDENTIFIABLE;
26 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.IDENTIFIER;
27 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION;
28 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
29 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.wildcardTypeFor;
30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
31 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
33 import com.google.common.annotations.Beta;
34 import com.google.common.base.Preconditions;
35 import com.google.common.collect.Iterables;
36 import java.util.Collection;
37 import java.util.HashMap;
38 import java.util.List;
41 import java.util.stream.Collectors;
42 import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
43 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.TypeComments;
50 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
51 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
52 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
53 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
54 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
55 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
56 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
57 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
58 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
59 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
60 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
61 import org.opendaylight.mdsal.binding.javav2.model.api.YangSourceDefinition;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
63 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
64 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
65 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
66 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
67 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
68 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
69 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
70 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
71 import org.opendaylight.yangtools.yang.common.QName;
72 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
73 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
79 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
82 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.Module;
87 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
88 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
89 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
90 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
91 import org.opendaylight.yangtools.yang.model.api.Status;
92 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
93 import org.opendaylight.yangtools.yang.model.api.UsesNode;
94 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
96 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
97 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
98 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
101 * Helper util class used for generation of types in Binding spec v2.
104 final class GenHelperUtil {
106 private GenHelperUtil() {
107 throw new UnsupportedOperationException("Util class");
111 * Create GeneratedTypeBuilder object from module argument.
114 * Module object from which builder will be created
115 * @param genCtx generated context
116 * @param verboseClassComments verbosity switch
118 * @return <code>GeneratedTypeBuilder</code> which is internal
119 * representation of the module
120 * @throws IllegalArgumentException
123 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
124 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
126 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments,
128 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
129 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
131 if (verboseClassComments) {
132 moduleDataTypeBuilder.setYangSourceDefinition(YangSourceDefinition.of(module));
133 TypeComments.description(module).ifPresent(moduleDataTypeBuilder::addComment);
134 module.getDescription().ifPresent(moduleDataTypeBuilder::setDescription);
135 module.getReference().ifPresent(moduleDataTypeBuilder::setReference);
138 return moduleDataTypeBuilder;
142 * Generates type builder for <code>module</code>.
145 * Module which is source of package name for generated type
148 * string which is added to the module class name representation
150 * @param verboseClassComments verbosity switch
151 * @return instance of GeneratedTypeBuilder which represents
152 * <code>module</code>.
153 * @throws IllegalArgumentException
154 * if <code>module</code> is null
156 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
157 verboseClassComments, final ModuleContext context) {
158 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
159 final String packageName = BindingMapping.getRootPackageName(module);
160 // underscore used as separator for distinction of module name parts
161 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
163 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName, context);
164 if (verboseClassComments) {
165 moduleBuilder.setYangSourceDefinition(YangSourceDefinition.of(module));
166 TypeComments.description(module).ifPresent(moduleBuilder::addComment);
167 module.getDescription().ifPresent(moduleBuilder::setDescription);
168 module.getReference().ifPresent(moduleBuilder::setReference);
170 moduleBuilder.setModuleName(moduleName);
171 return moduleBuilder;
175 * Adds the implemented types to type builder.
177 * The method passes through the list of <i>uses</i> in
178 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
179 * generated type from all groupings
180 * allGroupings} which is added as <i>implements type</i> to
181 * <code>builder</code>
183 * @param dataNodeContainer
184 * element which contains the list of used YANG groupings
186 * builder to which are added implemented types according to
187 * <code>dataNodeContainer</code>
188 * @param genCtx generated context
189 * @return generated type builder with all implemented types
191 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
192 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
193 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
194 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
195 if (genType == null) {
196 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
197 + builder.getName());
199 builder.addImplementsType(genType);
204 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
205 for (final ModuleContext ctx : genCtx.values()) {
206 final GeneratedTypeBuilder result = ctx.getGrouping(path);
207 if (result != null) {
214 static GeneratedTOBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
215 for (final ModuleContext ctx : genCtx.values()) {
216 final GeneratedTOBuilder result = ctx.getIdentities().get(qname);
217 if (result != null) {
225 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
226 * node for which <code>typeBuilder</code> was created.
228 * The subnodes aren't mapped to the methods if they are part of grouping or
229 * augment (in this case are already part of them).
233 * @param basePackageName
234 * string contains the module package name
236 * generated type builder which represents any node. The subnodes
237 * of this node are added to the <code>typeBuilder</code> as
238 * methods. The subnode can be of type leaf, leaf-list, list,
243 * set of data schema nodes which are the children of the node
244 * for which <code>typeBuilder</code> was created
245 * @return generated type builder which is the same builder as input
246 * parameter. The getter methods (representing child nodes) could be
249 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
250 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
251 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
252 final SchemaContext schemaContext, final boolean verboseClassComments,
253 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
254 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
256 if (schemaNodes != null && parent != null) {
257 for (final DataSchemaNode schemaNode : schemaNodes) {
258 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
259 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
260 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
267 static boolean resolveDataSchemaNodesCheck(final Module module, final SchemaContext schemaContext,
268 final DataSchemaNode schemaNode) {
269 if (!schemaNode.isAugmenting()) {
273 final QName qname = schemaNode.getPath().getLastComponent();
274 final Module originalModule = schemaContext.findModule(qname.getModule()).get();
275 return module.equals(originalModule);
278 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
279 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
280 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
281 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
282 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
283 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
286 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
287 QName childNodeQName = null;
288 if (node instanceof Module) {
289 childNodeQName = QName.create(((Module) node).getQNameModule(), superChildNode.getQName().getLocalName());
290 } else if (node instanceof SchemaNode) {
291 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
292 } else if (node instanceof AugmentationSchemaNode) {
293 childNodeQName = QName.create(module.getQNameModule(), superChildNode.getQName().getLocalName());
295 throw new IllegalArgumentException("Not support node type:" + node);
298 return childNodeQName;
301 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
302 final Object node, final Module module, final SchemaContext schemaContext,
303 final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
304 if (superNode instanceof DataNodeContainer) {
305 for (DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
306 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
307 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
308 DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
309 Preconditions.checkNotNull(childNode, "%s->%s", node, childQName);
311 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
312 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
314 Preconditions.checkNotNull(type, "%s->%s", module, childNode.getPath());
315 Preconditions.checkNotNull(superType, "%s->%s", superModule, superChildNode.getPath());
316 type.addImplementsType(superType);
317 if (superChildNode instanceof ListSchemaNode
318 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
319 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
320 genCtx.get(module).getKeyType(childNode.getPath())
321 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
322 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
323 genCtx.get(module).getKeyGenTO(childNode.getPath())
324 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
327 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
330 } else if (superNode instanceof ChoiceSchemaNode) {
331 for (CaseSchemaNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases().values()) {
332 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
333 CaseSchemaNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
334 Preconditions.checkNotNull(caseNode, "%s->%s", node, childQName);
336 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
337 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
338 Preconditions.checkNotNull(type, "%s->%s", module, caseNode.getPath());
339 Preconditions.checkNotNull(superType, "%s->%s", superModule, superCaseNode.getPath());
340 type.addImplementsType(superType);
341 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
344 throw new IllegalArgumentException("Not support super node :" + superNode);
348 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
349 final Object parentNode, final UsesNode usesNode) {
350 SchemaNode groupingNode;
351 if (parentNode instanceof Module) {
352 final Module superModule = schemaContext.findModule(
353 usesNode.getGroupingPath().getLastComponent().getModule()).get();
354 groupingNode = superModule.getGroupings()
355 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
356 .findFirst().orElse(null);
358 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
359 final Iterable<QName> prefixedPath = usesNode.getGroupingPath().getPathFromRoot();
360 final QName current = prefixedPath.iterator().next();
361 final Module targetModule = schemaContext.findModule(current.getModule()).orElse(null);
362 Preconditions.checkArgument(targetModule != null, "Cannot find target module for %s and %s.",
363 current.getNamespace(), current.getRevision());
364 groupingNode = targetModule.getGroupings().stream()
365 .filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
366 .collect(Collectors.toList()).get(0);
367 if (groupingNode == null) {
368 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
372 Preconditions.checkNotNull(groupingNode, "%s->%s", module, usesNode.getGroupingPath());
373 Preconditions.checkState(groupingNode instanceof GroupingDefinition, "%s->%s", module,
374 usesNode.getGroupingPath());
375 return (GroupingDefinition) groupingNode;
378 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
379 final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
380 if (node instanceof DataNodeContainer) {
381 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
382 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
383 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
384 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
390 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
391 for (final ModuleContext ctx : genCtx.values()) {
392 final GeneratedTypeBuilder result = ctx.getChildNode(path);
393 if (result != null) {
400 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
401 for (final ModuleContext ctx : genCtx.values()) {
402 final GeneratedTypeBuilder result = ctx.getCase(path);
403 if (result != null) {
410 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module,
411 final String augmentPackageName, final Type targetTypeRef, final SchemaNode targetNode,
412 final List<AugmentationSchemaNode> schemaPathAugmentListEntry,
413 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
414 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
415 final boolean verboseClassComments, final TypeProvider typeProvider,
416 final BindingNamespaceType namespaceType) {
418 //pick augmentation grouped by augmentation target, there is always at least one
419 final AugmentationSchemaNode augSchema = schemaPathAugmentListEntry.get(0);
421 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
422 augmentPackageName, k -> new HashMap<>());
424 //this requires valid semantics in YANG model
425 String augIdentifier = null;
426 for (AugmentationSchemaNode aug : schemaPathAugmentListEntry) {
427 // FIXME: when there're multiple augment identifiers for augmentations of same target,
428 // it would pick the first identifier.
429 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
433 if (augIdentifier == null) {
434 augIdentifier = new StringBuilder(module.getName())
435 .append('_').append(targetNode.getQName().getLocalName()).toString();
438 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
439 true, false, genCtx.get(module));
441 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
442 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
443 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
444 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
445 augTypeBuilder.setWithBuilder(true);
446 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
448 //produces getters for augTypeBuilder eventually
449 for (AugmentationSchemaNode aug : schemaPathAugmentListEntry) {
451 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
452 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder,
453 aug.getChildNodes(), genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders,
457 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
459 if(!augSchema.getChildNodes().isEmpty()) {
460 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
462 genCtx.get(module).addAugmentType(augTypeBuilder);
463 genCtx.get(module).addTypeToAugmentations(augTypeBuilder, schemaPathAugmentListEntry);
468 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
469 * node for which <code>typeBuilder</code> was created.
473 * @param basePackageName
474 * string contains the module package name
476 * generated type builder which represents any node. The subnodes
477 * of this node are added to the <code>typeBuilder</code> as
478 * methods. The subnode can be of type leaf, leaf-list, list,
483 * set of data schema nodes which are the children of the node
484 * for which <code>typeBuilder</code> was created
485 * @return generated type builder which is the same object as the input
486 * parameter <code>typeBuilder</code>. The getter method could be
489 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
490 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
491 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
492 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
493 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
494 if (schemaNodes != null && typeBuilder != null) {
495 for (final DataSchemaNode schemaNode : schemaNodes) {
496 if (!schemaNode.isAugmenting()) {
497 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
498 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
506 * Instantiates generated type builder with <code>packageName</code> and
507 * <code>schemaNode</code>.
509 * The new builder always implements
510 * {@link TreeNode TreeNode}.<br>
511 * If <code>schemaNode</code> is instance of GroupingDefinition it also
512 * implements {@link Augmentable
514 * If <code>schemaNode</code> is instance of
515 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
516 * DataNodeContainer} it can also implement nodes which are specified in
519 * @param basePackageName
520 * string contains the module package name
522 * schema node for which is created generated type builder
524 * parent type (can be null)
525 * @param schemaContext schema context
526 * @return generated type builder <code>schemaNode</code>
528 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
529 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
530 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
531 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
533 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", "",
534 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
535 if (namespaceType.equals(BindingNamespaceType.Data)) {
536 if (parent == null) {
537 it.addImplementsType(BindingTypes.TREE_NODE);
539 if (!(schemaNode instanceof ListSchemaNode) ||
540 ((ListSchemaNode) schemaNode).getKeyDefinition().isEmpty()) {
541 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
542 (BindingTypes.ITEM, it)));
544 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
547 if (!(schemaNode instanceof GroupingDefinition)) {
548 it.addImplementsType(BindingTypes.augmentable(it));
551 it.addImplementsType(BindingTypes.TREE_NODE);
554 if (schemaNode instanceof DataNodeContainer) {
555 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
556 verboseClassComments, genTypeBuilders, typeProvider);
557 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
563 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, final String
564 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
565 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>>
566 genTypeBuilders, final TypeProvider typeProvider, final Map<Module, ModuleContext> genCtx) {
567 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
568 (basePackageName, notification, null, module, genCtx, schemaContext,
569 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
570 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
571 notificationInterface.addImplementsType(NOTIFICATION);
572 notificationInterface.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, notificationInterface));
573 genCtx.get(module).addChildNodeType(notification, notificationInterface);
575 // Notification object
576 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
577 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
578 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
580 //in case of tied notification, incorporate parent's localName
581 final StringBuilder sb = new StringBuilder("on_");
582 if (parentName != null) {
583 sb.append(parentName).append('_');
585 sb.append(notificationInterface.getName());
587 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
588 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
589 .setComment(encodeAngleBrackets(notification.getDescription().orElse(null))).setReturnType(Types.VOID);
590 return listenerInterface;
594 * Returns reference to generated type builder for specified
595 * <code>schemaNode</code> with <code>packageName</code>.
597 * Firstly the generated type builder is searched in
598 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
599 * found it is created and added to <code>genTypeBuilders</code>.
601 * @param basePackageName
602 * string contains the module package name
604 * schema node which provide data about the schema node name
605 * @param schemaContext schema context
607 * return type name prefix
608 * @return generated type builder for <code>schemaNode</code>
609 * @throws IllegalArgumentException
611 * <li>if <code>schemaNode</code> is null</li>
612 * <li>if <code>packageName</code> is null</li>
613 * <li>if QName of schema node is null</li>
614 * <li>if schemaNode name is null</li>
618 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
619 final SchemaContext schemaContext, final String prefix, final String suffix,
620 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
621 final BindingNamespaceType namespaceType, final ModuleContext context) {
623 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
624 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
625 String schemaNodeName = schemaNode.getQName().getLocalName();
626 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
628 if (prefix != null && !prefix.isEmpty()) {
629 // underscore used as separator for distinction of class name parts
630 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
633 if (suffix != null && !suffix.isEmpty()) {
634 // underscore used as separator for distinction of class name parts
635 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
638 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
639 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
640 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
641 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
642 if (verboseClassComments) {
643 newType.setYangSourceDefinition(YangSourceDefinition.of(module, schemaNode));
644 TypeComments.description(schemaNode).ifPresent(newType::addComment);
645 schemaNode.getDescription().ifPresent(newType::setDescription);
646 schemaNode.getReference().ifPresent(newType::setReference);
648 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
649 newType.setModuleName(module.getName());
650 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
651 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
653 if (!genTypeBuilders.containsKey(packageName)) {
654 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
655 builders.put(newType.getName(), newType);
656 genTypeBuilders.put(packageName, builders);
658 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
659 if (!builders.containsKey(newType.getName())) {
660 builders.put(newType.getName(), newType);
667 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
668 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
669 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
670 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
671 final BindingNamespaceType namespaceType) {
673 if (node != null && typeBuilder != null) {
674 if (node instanceof ContainerSchemaNode) {
675 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
676 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
677 } else if (node instanceof LeafListSchemaNode) {
678 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
679 typeProvider, genCtx, verboseClassComments);
680 } else if (node instanceof LeafSchemaNode) {
681 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
682 typeProvider, verboseClassComments);
683 } else if (node instanceof ListSchemaNode) {
684 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
685 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
686 } else if (node instanceof ChoiceSchemaNode) {
687 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
688 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
689 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
690 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
696 * Converts <code>choiceNode</code> to the list of generated types for
697 * choice and its cases.
699 * The package names for choice and for its cases are created as
700 * concatenation of the module package (<code>basePackageName</code>) and
701 * names of all parents node.
705 * @param basePackageName
706 * string with the module package name
710 * choice node which is mapped to generated type. Also child
711 * nodes - cases are mapped to generated types.
712 * @throws IllegalArgumentException
714 * <li>if <code>basePackageName</code> is null</li>
715 * <li>if <code>choiceNode</code> is null</li>
718 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
719 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
720 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
721 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
722 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
723 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
725 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
726 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType, genCtx.get(module));
727 constructGetter(parent, choiceNode.getQName().getLocalName(),
728 choiceNode.getDescription().orElse(null), choiceTypeBuilder, choiceNode.getStatus());
729 if (namespaceType.equals(BindingNamespaceType.Data)) {
730 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
732 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
733 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
734 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
735 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
738 private static void containerToGenType(final Module module, final String basePackageName,
739 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
740 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
741 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
742 final BindingNamespaceType namespaceType) {
744 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
745 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
746 if (genType != null) {
747 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
748 constructGetter(parent, getterName.toString(), node.getDescription().orElse(null), genType, node.getStatus());
749 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
750 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
751 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
755 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
756 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
757 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
758 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
759 final BindingNamespaceType namespaceType) {
761 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
762 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
763 if (genType != null) {
764 final String nodeName = node.getQName().getLocalName();
766 Type getterReturnType = Types.listTypeFor(genType);
767 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
768 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
771 constructGetter(parent, nodeName, node.getDescription().orElse(null), getterReturnType, node.getStatus());
773 final List<QName> listKeys = node.getKeyDefinition();
774 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
775 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
776 //FIXME: Is it neccessary to generate interface of key and implemented by class?
777 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
778 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
779 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
780 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
781 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
782 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
785 if (genTypeBuilder != null) {
786 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
787 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
789 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
791 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
792 if (genTOBuilder != null) {
793 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
794 genTOBuilder.addImplementsType(IDENTIFIER);
795 genType.addImplementsType(identifiableMarker);
796 genType.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
797 (BindingTypes.IDENTIFIABLE_ITEM, genType, genTOBuilder)));
801 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
802 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
803 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
804 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
807 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
810 if (genTOBuilder != null) {
811 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
812 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
813 genTOBuilder.setSUID(prop);
814 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
815 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
821 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
822 final Type keyType, final Map<Module, ModuleContext> genCtx,
823 final BindingNamespaceType namespaceType) {
824 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
825 if (keyType != null) {
826 Type returnKeyType = keyType;
827 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
828 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
831 constructGetter(typeBuilder, "identifier", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
837 * Converts <code>leaf</code> to the getter method which is added to
838 * <code>typeBuilder</code>.
841 * generated type builder to which is added getter method as
842 * <code>leaf</code> mapping
844 * leaf schema node which is mapped as getter method which is
845 * added to <code>typeBuilder</code>
847 * Module in which type was defined
848 * @return boolean value
850 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
852 * <li>true - in other cases</li>
855 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
856 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
857 final Module module, final TypeProvider typeProvider, final boolean verboseClassComments) {
858 if (leaf == null || typeBuilder == null) {
862 final String leafName = leaf.getQName().getLocalName();
863 if (leafName == null) {
867 final Module parentModule = findParentModule(schemaContext, leaf);
868 Type returnType = null;
870 final TypeDefinition<?> typeDef = leaf.getType();
872 if (leaf.isAddedByUses()) {
873 Preconditions.checkState(leaf instanceof DerivableSchemaNode);
874 if (isInnerType(leaf, typeDef)) {
875 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
876 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
877 restrictions, genCtx.get(module));
879 if (typeDef.getBaseType() == null && (typeDef instanceof EnumTypeDefinition
880 || typeDef instanceof UnionTypeDefinition || typeDef instanceof BitsTypeDefinition)) {
881 LeafSchemaNode originalLeaf = (LeafSchemaNode) ((DerivableSchemaNode) leaf).getOriginal().orElse(null);
882 Preconditions.checkNotNull(originalLeaf);
883 returnType = genCtx.get(findParentModule(schemaContext, originalLeaf)).getInnerType(typeDef.getPath());
885 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
886 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
889 } else if (isInnerType(leaf, typeDef)) {
890 if (typeDef instanceof EnumTypeDefinition) {
891 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
892 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
893 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
894 genCtx, typeBuilder, module);
895 if (enumBuilder != null) {
896 returnType = enumBuilder.toInstance(typeBuilder);
898 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
899 } else if (typeDef instanceof UnionTypeDefinition) {
900 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
901 typeProvider, schemaContext, genCtx.get(module), genCtx);
902 if (genTOBuilder != null) {
903 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
904 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule,
905 typeProvider, verboseClassComments);
907 } else if (typeDef instanceof BitsTypeDefinition) {
908 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
909 typeProvider, schemaContext, genCtx.get(module), genCtx);
910 if (genTOBuilder != null) {
911 returnType = genTOBuilder.toInstance();
914 // It is constrained version of already declared type (inner declared type exists,
915 // onlyfor special cases (Enum, Union, Bits), which were already checked.
916 // In order to get proper class we need to look up closest derived type
917 // and apply restrictions from leaf type
918 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
919 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
920 restrictions, genCtx.get(module));
923 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
924 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
927 if (returnType == null) {
931 if (typeDef instanceof EnumTypeDefinition) {
932 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
935 final String leafGetterName;
936 if ("key".equals(leafName.toLowerCase())) {
937 StringBuilder sb = new StringBuilder(leafName)
938 .append('_').append("RESERVED_WORD");
939 leafGetterName = sb.toString();
941 leafGetterName = leafName;
943 constructGetter(typeBuilder, leafGetterName, leaf.getDescription().orElse(""), returnType, leaf.getStatus());
948 * Converts <code>node</code> leaf list schema node to getter method of
949 * <code>typeBuilder</code>.
952 * generated type builder to which is <code>node</code> added as
955 * leaf list schema node which is added to
956 * <code>typeBuilder</code> as getter method
957 * @param module module
958 * @param typeProvider type provider instance
959 * @param genCtx actual generated context
960 * @return boolean value
962 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
963 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
964 * <li>false - other cases</li>
967 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
968 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
969 final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
970 if (node == null || typeBuilder == null) {
974 final QName nodeName = node.getQName();
976 final TypeDefinition<?> typeDef = node.getType();
977 final Module parentModule = findParentModule(schemaContext, node);
979 Type returnType = null;
980 if (typeDef.getBaseType() == null) {
981 if (typeDef instanceof EnumTypeDefinition) {
982 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
983 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
984 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
985 genCtx, typeBuilder, module);
986 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(), true,
988 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
989 } else if (typeDef instanceof UnionTypeDefinition) {
990 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
991 typeProvider, schemaContext, genCtx.get(module), genCtx);
992 if (genTOBuilder != null) {
993 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule,
994 typeProvider, verboseClassComments);
996 } else if (typeDef instanceof BitsTypeDefinition) {
997 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
998 typeProvider, schemaContext, genCtx.get(module), genCtx);
999 returnType = genTOBuilder.toInstance();
1001 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1002 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
1005 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1006 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
1009 final ParameterizedType listType = Types.listTypeFor(returnType);
1010 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription().orElse(null), listType, node.getStatus());
1015 * Converts <code>caseNodes</code> set to list of corresponding generated
1018 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1019 * created generated type builder. The package names for the builder is
1020 * created as concatenation of the module package (
1021 * <code>basePackageName</code>) and names of all parents nodes of the
1022 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1023 * between every case builder and <i>choice</i> type
1027 * @param schemaContext
1028 * current schema context
1030 * actual generated context
1031 * @param basePackageName
1032 * string with the module package name
1033 * @param refChoiceType
1034 * type which represents superior <i>case</i>
1036 * choice case node which is mapped to generated type
1037 * @param verboseClassComments
1038 * Javadoc verbosity switch
1039 * @throws IllegalArgumentException
1041 * <li>if <code>basePackageName</code> equals null</li>
1042 * <li>if <code>refChoiceType</code> equals null</li>
1043 * <li>if <code>caseNodes</code> equals null</li>
1046 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1047 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1048 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1049 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1050 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1051 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1052 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1054 for (final CaseSchemaNode caseNode : choiceNode.getCases().values()) {
1055 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1056 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1057 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1058 caseTypeBuilder.addImplementsType(refChoiceType);
1059 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1060 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1061 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1062 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1063 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1064 if (caseChildNodes != null) {
1065 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1067 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1068 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1070 if (parent instanceof AugmentationSchemaNode) {
1071 final AugmentationSchemaNode augSchema = (AugmentationSchemaNode) parent;
1072 final SchemaPath targetPath = augSchema.getTargetPath();
1073 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1074 if (targetSchemaNode instanceof DataSchemaNode
1075 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1076 if (targetSchemaNode instanceof DerivableSchemaNode) {
1077 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orElse(null);
1079 if (targetSchemaNode == null) {
1080 throw new IllegalStateException(
1081 "Failed to find target node from grouping for augmentation " + augSchema
1082 + " in module " + module.getName());
1085 parent = targetSchemaNode;
1088 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1089 choiceNodeParentPath);
1090 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1091 if (childOfType == null) {
1092 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1094 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1095 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1097 final GeneratedTypeBuilder moduleType = genCtx.get(module).getModuleNode();
1098 Preconditions.checkNotNull(moduleType, "Module type can not be null.");
1099 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleType, caseChildNodes,
1100 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1102 processUsesImplements(caseNode, module, schemaContext, genCtx, namespaceType);
1108 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1109 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1110 final TypeProvider typeProvider) {
1112 final String anyName = node.getQName().getLocalName();
1113 if (anyName == null) {
1117 Type returnType = Types.DOCUMENT;
1118 constructGetter(typeBuilder, anyName, node.getDescription().orElse(""), 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,
1172 typeProvider, verboseClassComments);
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, verboseClassComments);
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,
1211 typeProvider, verboseClassComments);
1212 if (listKeys.contains(leafQName)) {
1213 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1214 typeProvider, verboseClassComments);
1217 if (schemaNode instanceof LeafListSchemaNode) {
1218 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1219 typeProvider, genCtx, verboseClassComments);
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.findModule(qname.getModule()).get();
1245 final ModuleContext mc = genCtx.get(unionModule);
1246 returnType = mc.getTypedefs().get(typeDef.getPath());
1247 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1248 // Annonymous enumeration (already generated, since it is inherited via uses).
1249 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1250 QName qname = originalLeaf.getQName();
1251 final Module enumModule = schemaContext.findModule(qname.getModule()).orElse(null);
1252 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1254 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1256 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1261 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1262 final TypeDefinition<?> baseType = typeDef.getBaseType();
1263 return baseType != null && baseType.getBaseType() != null ? baseType : typeDef;
1266 @SuppressWarnings({ "rawtypes", "unchecked" })
1267 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1268 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1269 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1270 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1272 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1273 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1274 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1275 genType.setModuleName(module.getName());
1276 if (verboseClassComments) {
1277 genType.setYangSourceDefinition(YangSourceDefinition.of(module, node));
1278 TypeComments.description(node).ifPresent(genType::addComment);
1279 node.getDescription().ifPresent(genType::setDescription);
1280 node.getReference().ifPresent(genType::setReference);
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 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1421 baseIdentity, module, verboseClassComments, genCtx);
1422 newType.setExtendsType(baseType.toInstance());
1425 newType.setAbstract(true);
1427 if (verboseClassComments) {
1428 newType.setYangSourceDefinition(YangSourceDefinition.of(module));
1429 TypeComments.description(module).ifPresent(newType::addComment);
1430 module.getDescription().ifPresent(newType::setDescription);
1431 module.getReference().ifPresent(newType::setReference);
1433 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1435 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1437 genCtx.get(module).addIdentityType(identity.getQName(), newType);