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.mdsal.binding.javav2.generator.yang.types.TypeGenHelper.resolveRegExpressions;
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 java.util.Collection;
36 import java.util.HashMap;
37 import java.util.List;
40 import java.util.stream.Collectors;
41 import javax.annotation.Nullable;
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.GeneratedTypeBuilderImpl;
53 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.BaseYangTypes;
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.PatternConstraint;
97 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
98 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
99 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
102 * Helper util class used for generation of types in Binding spec v2.
105 final class GenHelperUtil {
107 private GenHelperUtil() {
108 throw new UnsupportedOperationException("Util class");
112 * Create GeneratedTypeBuilder object from module argument.
115 * Module object from which builder will be created
116 * @param genCtx generated context
117 * @param verboseClassComments verbosity switch
119 * @return <code>GeneratedTypeBuilder</code> which is internal
120 * representation of the module
121 * @throws IllegalArgumentException
124 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
125 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
127 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments,
129 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
130 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
132 if (verboseClassComments) {
133 YangSourceDefinition.of(module).ifPresent(moduleDataTypeBuilder::setYangSourceDefinition);
134 TypeComments.description(module).ifPresent(moduleDataTypeBuilder::addComment);
135 module.getDescription().ifPresent(moduleDataTypeBuilder::setDescription);
136 module.getReference().ifPresent(moduleDataTypeBuilder::setReference);
139 return moduleDataTypeBuilder;
143 * Generates type builder for <code>module</code>.
146 * Module which is source of package name for generated type
149 * string which is added to the module class name representation
151 * @param verboseClassComments verbosity switch
152 * @return instance of GeneratedTypeBuilder which represents
153 * <code>module</code>.
154 * @throws IllegalArgumentException
155 * if <code>module</code> is null
157 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
158 verboseClassComments, final ModuleContext context) {
159 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
160 final String packageName = BindingMapping.getRootPackageName(module);
161 // underscore used as separator for distinction of module name parts
162 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
164 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName, context);
165 if (verboseClassComments) {
166 YangSourceDefinition.of(module).ifPresent(moduleBuilder::setYangSourceDefinition);
167 TypeComments.description(module).ifPresent(moduleBuilder::addComment);
168 module.getDescription().ifPresent(moduleBuilder::setDescription);
169 module.getReference().ifPresent(moduleBuilder::setReference);
171 moduleBuilder.setModuleName(moduleName);
172 return moduleBuilder;
176 * Adds the implemented types to type builder.
178 * The method passes through the list of <i>uses</i> in
179 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
180 * generated type from all groupings
181 * allGroupings} which is added as <i>implements type</i> to
182 * <code>builder</code>
184 * @param dataNodeContainer
185 * element which contains the list of used YANG groupings
187 * builder to which are added implemented types according to
188 * <code>dataNodeContainer</code>
189 * @param genCtx generated context
190 * @return generated type builder with all implemented types
192 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
193 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
194 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
195 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
196 if (genType == null) {
197 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
198 + builder.getName());
200 builder.addImplementsType(genType);
205 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
206 for (final ModuleContext ctx : genCtx.values()) {
207 final GeneratedTypeBuilder result = ctx.getGrouping(path);
208 if (result != null) {
215 static GeneratedTypeBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
216 for (final ModuleContext ctx : genCtx.values()) {
217 final GeneratedTypeBuilder result = ctx.getIdentities().get(qname);
218 if (result != null) {
226 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
227 * node for which <code>typeBuilder</code> was created.
229 * The subnodes aren't mapped to the methods if they are part of grouping or
230 * augment (in this case are already part of them).
234 * @param basePackageName
235 * string contains the module package name
237 * generated type builder which represents any node. The subnodes
238 * of this node are added to the <code>typeBuilder</code> as
239 * methods. The subnode can be of type leaf, leaf-list, list,
244 * set of data schema nodes which are the children of the node
245 * for which <code>typeBuilder</code> was created
246 * @return generated type builder which is the same builder as input
247 * parameter. The getter methods (representing child nodes) could be
250 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
251 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
252 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
253 final SchemaContext schemaContext, final boolean verboseClassComments,
254 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
255 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
257 if (schemaNodes != null && parent != null) {
258 for (final DataSchemaNode schemaNode : schemaNodes) {
259 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
260 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
261 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
268 static boolean resolveDataSchemaNodesCheck(final Module module, final SchemaContext schemaContext,
269 final DataSchemaNode schemaNode) {
270 if (!schemaNode.isAugmenting()) {
274 final QName qname = schemaNode.getPath().getLastComponent();
275 final Module originalModule = schemaContext.findModule(qname.getModule()).get();
276 return module.equals(originalModule);
279 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
280 QName childNodeQName = null;
281 if (node instanceof Module) {
282 childNodeQName = QName.create(((Module) node).getQNameModule(), superChildNode.getQName().getLocalName());
283 } else if (node instanceof SchemaNode) {
284 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
285 } else if (node instanceof AugmentationSchemaNode) {
286 childNodeQName = QName.create(module.getQNameModule(), superChildNode.getQName().getLocalName());
288 throw new IllegalArgumentException("Not support node type:" + node);
291 return childNodeQName;
294 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
295 final Object node, final Module module, final SchemaContext schemaContext,
296 final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
297 if (superNode instanceof DataNodeContainer) {
298 for (DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
299 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
300 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
301 DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
302 Preconditions.checkNotNull(childNode, "%s->%s", node, childQName);
304 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
305 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
307 Preconditions.checkNotNull(type, "%s->%s", module, childNode.getPath());
308 Preconditions.checkNotNull(superType, "%s->%s", superModule, superChildNode.getPath());
309 type.addImplementsType(superType);
310 if (superChildNode instanceof ListSchemaNode
311 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
312 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
313 genCtx.get(module).getKeyType(childNode.getPath())
314 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
315 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
316 genCtx.get(module).getKeyGenTO(childNode.getPath())
317 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
320 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
323 } else if (superNode instanceof ChoiceSchemaNode) {
324 for (CaseSchemaNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases().values()) {
325 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
326 CaseSchemaNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
327 Preconditions.checkNotNull(caseNode, "%s->%s", node, childQName);
329 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
330 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
331 Preconditions.checkNotNull(type, "%s->%s", module, caseNode.getPath());
332 Preconditions.checkNotNull(superType, "%s->%s", superModule, superCaseNode.getPath());
333 type.addImplementsType(superType);
334 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
337 throw new IllegalArgumentException("Not support super node :" + superNode);
341 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
342 final Object parentNode, final UsesNode usesNode) {
343 SchemaNode groupingNode;
344 if (parentNode instanceof Module) {
345 final Module superModule = schemaContext.findModule(
346 usesNode.getGroupingPath().getLastComponent().getModule()).get();
347 groupingNode = superModule.getGroupings()
348 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
349 .findFirst().orElse(null);
351 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
352 final Iterable<QName> prefixedPath = usesNode.getGroupingPath().getPathFromRoot();
353 final QName current = prefixedPath.iterator().next();
354 final Module targetModule = schemaContext.findModule(current.getModule()).orElse(null);
355 Preconditions.checkArgument(targetModule != null, "Cannot find target module for %s and %s.",
356 current.getNamespace(), current.getRevision());
357 groupingNode = targetModule.getGroupings().stream()
358 .filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
359 .collect(Collectors.toList()).get(0);
360 if (groupingNode == null) {
361 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
365 Preconditions.checkNotNull(groupingNode, "%s->%s", module, usesNode.getGroupingPath());
366 Preconditions.checkState(groupingNode instanceof GroupingDefinition, "%s->%s", module,
367 usesNode.getGroupingPath());
368 return (GroupingDefinition) groupingNode;
371 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
372 final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
373 if (node instanceof DataNodeContainer) {
374 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
375 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
376 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
377 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
383 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
384 for (final ModuleContext ctx : genCtx.values()) {
385 final GeneratedTypeBuilder result = ctx.getChildNode(path);
386 if (result != null) {
393 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
394 for (final ModuleContext ctx : genCtx.values()) {
395 final GeneratedTypeBuilder result = ctx.getCase(path);
396 if (result != null) {
403 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module,
404 final String augmentPackageName, final Type targetTypeRef, final SchemaNode targetNode,
405 final List<AugmentationSchemaNode> schemaPathAugmentListEntry,
406 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
407 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
408 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 AugmentationSchemaNode 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 (AugmentationSchemaNode aug : schemaPathAugmentListEntry) {
420 // FIXME: when there're multiple augment identifiers for augmentations of same target,
421 // it would pick the first identifier.
422 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
426 if (augIdentifier == null) {
427 augIdentifier = new StringBuilder(module.getName())
428 .append('_').append(targetNode.getQName().getLocalName()).toString();
431 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
432 true, false, genCtx.get(module));
434 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
435 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
436 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
437 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
438 augTypeBuilder.setWithBuilder(true);
439 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
441 //produces getters for augTypeBuilder eventually
442 for (AugmentationSchemaNode aug : schemaPathAugmentListEntry) {
444 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
445 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder,
446 aug.getChildNodes(), genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders,
450 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
452 if(!augSchema.getChildNodes().isEmpty()) {
453 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
455 genCtx.get(module).addAugmentType(augTypeBuilder);
456 genCtx.get(module).addTypeToAugmentations(augTypeBuilder, schemaPathAugmentListEntry);
461 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
462 * node for which <code>typeBuilder</code> was created.
466 * @param basePackageName
467 * string contains the module package name
469 * generated type builder which represents any node. The subnodes
470 * of this node are added to the <code>typeBuilder</code> as
471 * methods. The subnode can be of type leaf, leaf-list, list,
476 * set of data schema nodes which are the children of the node
477 * for which <code>typeBuilder</code> was created
478 * @return generated type builder which is the same object as the input
479 * parameter <code>typeBuilder</code>. The getter method could be
482 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
483 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
484 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
485 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
486 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
487 if (schemaNodes != null && typeBuilder != null) {
488 for (final DataSchemaNode schemaNode : schemaNodes) {
489 if (!schemaNode.isAugmenting()) {
490 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
491 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
499 * Instantiates generated type builder with <code>packageName</code> and
500 * <code>schemaNode</code>.
502 * The new builder always implements
503 * {@link TreeNode TreeNode}.<br>
504 * If <code>schemaNode</code> is instance of GroupingDefinition it also
505 * implements {@link Augmentable
507 * If <code>schemaNode</code> is instance of
508 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
509 * DataNodeContainer} it can also implement nodes which are specified in
512 * @param basePackageName
513 * string contains the module package name
515 * schema node for which is created generated type builder
517 * parent generated type of data tree node, which should be
518 * set null if current schema node is not a data tree node.
519 * @param schemaContext schema context
520 * @return generated type builder <code>schemaNode</code>
522 public static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
523 schemaNode, @Nullable final Type childOf, final Module module, final Map<Module, ModuleContext> genCtx,
524 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
525 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
527 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", "",
528 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
530 if (namespaceType.equals(BindingNamespaceType.Data)) {
531 if (childOf == null) {
532 it.addImplementsType(BindingTypes.TREE_NODE);
534 if (!(schemaNode instanceof ListSchemaNode) ||
535 ((ListSchemaNode) schemaNode).getKeyDefinition().isEmpty()) {
536 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, childOf,
537 parameterizedTypeFor(BindingTypes.ITEM, it)));
541 if (!(schemaNode instanceof CaseSchemaNode)) {
542 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
545 it.addImplementsType(BindingTypes.augmentable(it));
547 it.addImplementsType(BindingTypes.TREE_NODE);
550 if (schemaNode instanceof DataNodeContainer) {
551 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
552 verboseClassComments, genTypeBuilders, typeProvider);
553 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
559 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, final String
560 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
561 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>>
562 genTypeBuilders, final TypeProvider typeProvider, final Map<Module, ModuleContext> genCtx) {
563 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
564 (basePackageName, notification, null, module, genCtx, schemaContext,
565 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
566 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
567 notificationInterface.addImplementsType(NOTIFICATION);
568 genCtx.get(module).addChildNodeType(notification, notificationInterface);
570 // Notification object
571 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
572 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
573 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
575 //in case of tied notification, incorporate parent's localName
576 final StringBuilder sb = new StringBuilder("on_");
577 if (parentName != null) {
578 sb.append(parentName).append('_');
580 sb.append(notificationInterface.getName());
582 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
583 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
584 .setComment(encodeAngleBrackets(notification.getDescription().orElse(null))).setReturnType(Types.VOID);
585 return listenerInterface;
589 * Returns reference to generated type builder for specified
590 * <code>schemaNode</code> with <code>packageName</code>.
592 * Firstly the generated type builder is searched in
593 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
594 * found it is created and added to <code>genTypeBuilders</code>.
596 * @param basePackageName
597 * string contains the module package name
599 * schema node which provide data about the schema node name
600 * @param schemaContext schema context
602 * return type name prefix
603 * @return generated type builder for <code>schemaNode</code>
604 * @throws IllegalArgumentException
606 * <li>if <code>schemaNode</code> is null</li>
607 * <li>if <code>packageName</code> is null</li>
608 * <li>if QName of schema node is null</li>
609 * <li>if schemaNode name is null</li>
613 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
614 final SchemaContext schemaContext, final String prefix, final String suffix,
615 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
616 final BindingNamespaceType namespaceType, final ModuleContext context) {
618 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
619 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
620 String schemaNodeName = schemaNode.getQName().getLocalName();
621 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
623 if (prefix != null && !prefix.isEmpty()) {
624 // underscore used as separator for distinction of class name parts
625 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
628 if (suffix != null && !suffix.isEmpty()) {
629 // underscore used as separator for distinction of class name parts
630 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
633 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
634 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
635 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
636 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
637 if (verboseClassComments) {
638 YangSourceDefinition.of(module, schemaNode).ifPresent(newType::setYangSourceDefinition);
639 TypeComments.description(schemaNode).ifPresent(newType::addComment);
640 schemaNode.getDescription().ifPresent(newType::setDescription);
641 schemaNode.getReference().ifPresent(newType::setReference);
643 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
644 newType.setModuleName(module.getName());
645 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
646 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
648 if (!genTypeBuilders.containsKey(packageName)) {
649 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
650 builders.put(newType.getName(), newType);
651 genTypeBuilders.put(packageName, builders);
653 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
654 if (!builders.containsKey(newType.getName())) {
655 builders.put(newType.getName(), newType);
662 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
663 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
664 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
665 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
666 final BindingNamespaceType namespaceType) {
668 if (node != null && typeBuilder != null) {
669 if (node instanceof ContainerSchemaNode) {
670 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
671 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
672 } else if (node instanceof LeafListSchemaNode) {
673 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
674 typeProvider, genCtx, verboseClassComments);
675 } else if (node instanceof LeafSchemaNode) {
676 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
677 typeProvider, verboseClassComments);
678 } else if (node instanceof ListSchemaNode) {
679 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
680 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
681 } else if (node instanceof ChoiceSchemaNode) {
682 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder, childOf,
683 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
684 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
685 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
691 * Converts <code>choiceNode</code> to the list of generated types for
692 * choice and its cases.
694 * The package names for choice and for its cases are created as
695 * concatenation of the module package (<code>basePackageName</code>) and
696 * names of all parents node.
700 * @param basePackageName
701 * string with the module package name
705 * choice node which is mapped to generated type. Also child
706 * nodes - cases are mapped to generated types.
707 * @throws IllegalArgumentException
709 * <li>if <code>basePackageName</code> is null</li>
710 * <li>if <code>choiceNode</code> is null</li>
713 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
714 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent,
715 final GeneratedTypeBuilder childOf, final ChoiceSchemaNode choiceNode,
716 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
717 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider,
718 final BindingNamespaceType namespaceType) {
719 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
720 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
722 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
723 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType, genCtx.get(module));
724 constructGetter(parent, choiceNode.getQName().getLocalName(),
725 choiceNode.getDescription().orElse(null), choiceTypeBuilder, choiceNode.getStatus());
726 choiceTypeBuilder.setParentTypeForBuilder(childOf);
727 if (namespaceType.equals(BindingNamespaceType.Data)) {
728 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
730 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
731 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
732 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
733 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
736 private static void containerToGenType(final Module module, final String basePackageName,
737 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
738 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
739 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
740 final BindingNamespaceType namespaceType) {
742 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
743 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
744 if (genType != null) {
745 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
746 constructGetter(parent, getterName.toString(), node.getDescription().orElse(null), genType, node.getStatus());
747 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
748 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
749 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
753 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
754 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
755 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
756 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
757 final BindingNamespaceType namespaceType) {
759 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
760 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
761 if (genType != null) {
762 final String nodeName = node.getQName().getLocalName();
764 Type getterReturnType = Types.listTypeFor(genType);
765 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
766 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
769 constructGetter(parent, nodeName, node.getDescription().orElse(null), getterReturnType, node.getStatus());
771 final List<QName> listKeys = node.getKeyDefinition();
772 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
773 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
774 //FIXME: Is it neccessary to generate interface of key and implemented by class?
775 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
776 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
777 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
778 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
779 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
780 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
783 if (genTypeBuilder != null) {
784 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
785 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
787 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
789 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
790 if (genTOBuilder != null) {
791 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
792 genTOBuilder.addImplementsType(IDENTIFIER);
793 genType.addImplementsType(identifiableMarker);
794 genType.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, childOf, parameterizedTypeFor
795 (BindingTypes.IDENTIFIABLE_ITEM, genType, genTOBuilder)));
799 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
800 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
801 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
802 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
805 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
808 if (genTOBuilder != null) {
809 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
810 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
811 genTOBuilder.setSUID(prop);
812 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
813 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
819 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
820 final Type keyType, final Map<Module, ModuleContext> genCtx,
821 final BindingNamespaceType namespaceType) {
822 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
823 if (keyType != null) {
824 Type returnKeyType = keyType;
825 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
826 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
829 constructGetter(typeBuilder, "identifier", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
834 private static void addPatternConstant(final GeneratedTypeBuilder typeBuilder, final String leafName,
835 final List<PatternConstraint> patternConstraints) {
836 if (!patternConstraints.isEmpty()) {
837 final StringBuilder field = new StringBuilder();
838 field.append(BindingMapping.PATTERN_CONSTANT_NAME).append("_")
839 .append(JavaIdentifierNormalizer.normalizeSpecificIdentifier(leafName, JavaIdentifier.METHOD));
840 typeBuilder.addConstant(Types.listTypeFor(BaseYangTypes.STRING_TYPE), field.toString(),
841 resolveRegExpressions(patternConstraints));
846 * Converts <code>leaf</code> to the getter method which is added to
847 * <code>typeBuilder</code>.
850 * generated type builder to which is added getter method as
851 * <code>leaf</code> mapping
853 * leaf schema node which is mapped as getter method which is
854 * added to <code>typeBuilder</code>
856 * Module in which type was defined
857 * @return boolean value
859 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
861 * <li>true - in other cases</li>
864 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
865 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
866 final Module module, final TypeProvider typeProvider, final boolean verboseClassComments) {
867 if (leaf == null || typeBuilder == null) {
871 final String leafName = leaf.getQName().getLocalName();
872 if (leafName == null) {
876 final Module parentModule = findParentModule(schemaContext, leaf);
877 Type returnType = null;
879 final TypeDefinition<?> typeDef = leaf.getType();
881 if (leaf.isAddedByUses()) {
882 Preconditions.checkState(leaf instanceof DerivableSchemaNode);
883 if (isInnerType(leaf, typeDef)) {
884 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
885 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
886 restrictions, genCtx.get(module));
888 if (typeDef.getBaseType() == null && (typeDef instanceof EnumTypeDefinition
889 || typeDef instanceof UnionTypeDefinition || typeDef instanceof BitsTypeDefinition)) {
890 LeafSchemaNode originalLeaf = (LeafSchemaNode) ((DerivableSchemaNode) leaf).getOriginal().orElse(null);
891 Preconditions.checkNotNull(originalLeaf);
892 returnType = genCtx.get(findParentModule(schemaContext, originalLeaf)).getInnerType(typeDef.getPath());
894 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
895 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
898 } else if (isInnerType(leaf, typeDef)) {
899 if (typeDef instanceof EnumTypeDefinition) {
900 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
901 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
902 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
903 genCtx, typeBuilder, module);
904 if (enumBuilder != null) {
905 returnType = enumBuilder.toInstance(typeBuilder);
907 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
908 } else if (typeDef instanceof UnionTypeDefinition) {
909 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
910 typeProvider, schemaContext, genCtx.get(module), genCtx);
911 if (genTOBuilder != null) {
912 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
913 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule,
914 typeProvider, verboseClassComments);
916 } else if (typeDef instanceof BitsTypeDefinition) {
917 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
918 typeProvider, schemaContext, genCtx.get(module), genCtx);
919 if (genTOBuilder != null) {
920 returnType = genTOBuilder.toInstance();
923 // It is constrained version of already declared type (inner declared type exists,
924 // onlyfor special cases (Enum, Union, Bits), which were already checked.
925 // In order to get proper class we need to look up closest derived type
926 // and apply restrictions from leaf type
927 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
928 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
929 restrictions, genCtx.get(module));
930 addPatternConstant(typeBuilder, leafName, restrictions.getPatternConstraints());
933 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
934 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
935 addPatternConstant(typeBuilder, leafName, restrictions.getPatternConstraints());
938 if (returnType == null) {
942 if (typeDef instanceof EnumTypeDefinition) {
943 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
946 final String leafGetterName;
947 if ("key".equals(leafName.toLowerCase())) {
948 StringBuilder sb = new StringBuilder(leafName)
949 .append('_').append("RESERVED_WORD");
950 leafGetterName = sb.toString();
952 leafGetterName = leafName;
954 constructGetter(typeBuilder, leafGetterName, leaf.getDescription().orElse(""), returnType, leaf.getStatus());
959 * Converts <code>node</code> leaf list schema node to getter method of
960 * <code>typeBuilder</code>.
963 * generated type builder to which is <code>node</code> added as
966 * leaf list schema node which is added to
967 * <code>typeBuilder</code> as getter method
968 * @param module module
969 * @param typeProvider type provider instance
970 * @param genCtx actual generated context
971 * @return boolean value
973 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
974 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
975 * <li>false - other cases</li>
978 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
979 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
980 final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
981 if (node == null || typeBuilder == null) {
985 final QName nodeName = node.getQName();
987 final TypeDefinition<?> typeDef = node.getType();
988 final Module parentModule = findParentModule(schemaContext, node);
990 Type returnType = null;
991 if (typeDef.getBaseType() == null) {
992 if (typeDef instanceof EnumTypeDefinition) {
993 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
994 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
995 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
996 genCtx, typeBuilder, module);
997 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(), true,
999 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
1000 } else if (typeDef instanceof UnionTypeDefinition) {
1001 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
1002 typeProvider, schemaContext, genCtx.get(module), genCtx);
1003 if (genTOBuilder != null) {
1004 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule,
1005 typeProvider, verboseClassComments);
1007 } else if (typeDef instanceof BitsTypeDefinition) {
1008 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
1009 typeProvider, schemaContext, genCtx.get(module), genCtx);
1010 returnType = genTOBuilder.toInstance();
1012 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1013 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
1015 addPatternConstant(typeBuilder, nodeName.getLocalName(), restrictions.getPatternConstraints());
1018 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1019 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
1021 addPatternConstant(typeBuilder, nodeName.getLocalName(), restrictions.getPatternConstraints());
1024 final ParameterizedType listType = Types.listTypeFor(returnType);
1025 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription().orElse(null), listType, node.getStatus());
1030 * Converts <code>caseNodes</code> set to list of corresponding generated
1033 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1034 * created generated type builder. The package names for the builder is
1035 * created as concatenation of the module package (
1036 * <code>basePackageName</code>) and names of all parents nodes of the
1037 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1038 * between every case builder and <i>choice</i> type
1042 * @param schemaContext
1043 * current schema context
1045 * actual generated context
1046 * @param basePackageName
1047 * string with the module package name
1048 * @param refChoiceType
1049 * type which represents superior <i>case</i>
1051 * choice case node which is mapped to generated type
1052 * @param verboseClassComments
1053 * Javadoc verbosity switch
1054 * @throws IllegalArgumentException
1056 * <li>if <code>basePackageName</code> equals null</li>
1057 * <li>if <code>refChoiceType</code> equals null</li>
1058 * <li>if <code>caseNodes</code> equals null</li>
1061 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1062 final Map<Module, ModuleContext> genCtx, final String basePackageName, final GeneratedType refChoiceType,
1063 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments,
1064 final TypeProvider typeProvider, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
1065 final BindingNamespaceType namespaceType) {
1066 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1067 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1068 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1070 for (final CaseSchemaNode caseNode : choiceNode.getCases().values()) {
1071 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1072 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1073 null, module, genCtx, schemaContext, verboseClassComments,
1074 genTypeBuilders, typeProvider, namespaceType);
1075 caseTypeBuilder.addImplementsType(refChoiceType);
1076 caseTypeBuilder.setParentTypeForBuilder(refChoiceType.getParentTypeForBuilder());
1077 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1078 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1079 if (namespaceType.equals(BindingNamespaceType.Data)) {
1080 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1083 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder,
1084 (GeneratedTypeBuilder) refChoiceType.getParentTypeForBuilder(), caseNode.getChildNodes(),
1085 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1086 processUsesImplements(caseNode, module, schemaContext, genCtx, namespaceType);
1091 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1092 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1093 final TypeProvider typeProvider) {
1095 final String anyName = node.getQName().getLocalName();
1096 if (anyName == null) {
1100 Type returnType = Types.DOCUMENT;
1101 constructGetter(typeBuilder, anyName, node.getDescription().orElse(""), returnType, node.getStatus());
1106 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1107 * or to <code>genTOBuilder</code> as property.
1110 * string contains the name of list
1111 * @param basePackageName
1112 * string contains the module package name
1114 * data schema node which should be added as getter method to
1115 * <code>typeBuilder</code> or as a property to
1116 * <code>genTOBuilder</code> if is part of the list key
1117 * @param typeBuilder
1118 * generated type builder for the list schema node
1119 * @param genTOBuilder
1120 * generated TO builder for the list keys
1122 * list of string which contains QNames of the list keys
1125 * @param typeProvider
1126 * provider that defines contract for generated types
1127 * @param schemaContext
1130 * map of generated entities in context of YANG modules
1131 * @param genTypeBuilders
1132 * map of generated type builders
1133 * @param verboseClassComments
1134 * generate verbose comments
1135 * @throws IllegalArgumentException
1137 * <li>if <code>schemaNode</code> equals null</li>
1138 * <li>if <code>typeBuilder</code> equals null</li>
1141 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1142 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1143 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1144 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1145 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1146 final BindingNamespaceType namespaceType) {
1147 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1148 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1150 if (schemaNode instanceof LeafSchemaNode) {
1151 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1152 final QName leafQName = leaf.getQName();
1154 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1155 typeProvider, verboseClassComments);
1156 if (listKeys.contains(leafQName)) {
1158 resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1161 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1165 if (schemaNode instanceof LeafListSchemaNode) {
1166 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1167 typeProvider, genCtx, verboseClassComments);
1168 } else if (schemaNode instanceof ContainerSchemaNode) {
1169 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1170 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1171 } else if (schemaNode instanceof ListSchemaNode) {
1172 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1173 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1174 } else if (schemaNode instanceof ChoiceSchemaNode) {
1175 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder, typeBuilder,
1176 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1181 private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1182 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1183 final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1184 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1185 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1186 final BindingNamespaceType namespaceType) {
1187 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1188 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1190 if (schemaNode instanceof LeafSchemaNode) {
1191 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1192 final QName leafQName = leaf.getQName();
1193 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1194 typeProvider, verboseClassComments);
1195 if (listKeys.contains(leafQName)) {
1196 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1197 typeProvider, verboseClassComments);
1200 if (schemaNode instanceof LeafListSchemaNode) {
1201 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1202 typeProvider, genCtx, verboseClassComments);
1203 } else if (schemaNode instanceof ContainerSchemaNode) {
1204 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1205 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1206 } else if (schemaNode instanceof ListSchemaNode) {
1207 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1208 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1209 } else if (schemaNode instanceof ChoiceSchemaNode) {
1210 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder, typeBuilder,
1211 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1216 private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1217 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1218 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1220 if (leaf != null && toBuilder != null) {
1222 final TypeDefinition<?> typeDef = leaf.getType();
1223 if (typeDef instanceof UnionTypeDefinition) {
1224 // GeneratedType for this type definition should be already
1226 final QName qname = typeDef.getQName();
1227 final Module unionModule = schemaContext.findModule(qname.getModule()).get();
1228 final ModuleContext mc = genCtx.get(unionModule);
1229 returnType = mc.getTypedefs().get(typeDef.getPath());
1230 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1231 // Annonymous enumeration (already generated, since it is inherited via uses).
1232 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1233 QName qname = originalLeaf.getQName();
1234 final Module enumModule = schemaContext.findModule(qname.getModule()).orElse(null);
1235 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1237 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1239 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1244 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1245 final TypeDefinition<?> baseType = typeDef.getBaseType();
1246 return baseType != null && baseType.getBaseType() != null ? baseType : typeDef;
1249 @SuppressWarnings({ "rawtypes", "unchecked" })
1250 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1251 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1252 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1253 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1255 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1256 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1257 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1258 genType.setModuleName(module.getName());
1259 if (verboseClassComments) {
1260 YangSourceDefinition.of(module, node).ifPresent(genType::setYangSourceDefinition);
1261 TypeComments.description(node).ifPresent(genType::addComment);
1262 node.getDescription().ifPresent(genType::setDescription);
1263 node.getReference().ifPresent(genType::setReference);
1265 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1266 genType.setParentTypeForBuilder(childOf);
1267 if (node instanceof DataNodeContainer) {
1268 genCtx.get(module).addChildNodeType(node, genType);
1274 * Converts all <b>groupings</b> of the module to the list of
1275 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1276 * dependencies. At least dependent (independent) groupings are in the list
1277 * saved at first positions. For every grouping the record is added to map
1278 * {@link ModuleContext#groupings allGroupings}
1283 * collection of groupings from which types will be generated
1284 * @param typeProvider
1285 * provider that defines contract for generated types
1286 * @param schemaContext
1289 * map of generated entities in context of YANG modules
1290 * @param genTypeBuilders
1291 * map of generated type builders
1292 * @param verboseClassComments
1293 * generate verbose comments
1296 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1297 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1298 verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1299 final String basePackageName = BindingMapping.getRootPackageName(module);
1300 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1302 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1303 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1304 verboseClassComments, genTypeBuilders, typeProvider);
1310 * Converts individual grouping to GeneratedType. Firstly generated type
1311 * builder is created and every child node of grouping is resolved to the
1314 * @param basePackageName
1315 * string contains the module package name
1317 * GroupingDefinition which contains data about grouping
1320 * @param typeProvider
1321 * provider that defines contract for generated types
1322 * @param schemaContext
1325 * map of generated entities in context of YANG modules
1326 * @param genTypeBuilders
1327 * map of generated type builders
1328 * @param verboseClassComments
1329 * generate verbose comments
1331 * @return GeneratedType which is generated from grouping (object of type
1332 * <code>GroupingDefinition</code>)
1334 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1335 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1336 verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1337 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, null, module, genCtx,
1338 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1339 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1340 genCtx.get(module).addGroupingType(grouping, genType);
1341 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1342 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1343 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1348 * //TODO: add information about multiple base identities in YANG 1.1
1349 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1350 * created transport object builder. If identity contains base identity then
1351 * reference to base identity is added to superior identity as its extend.
1352 * If identity doesn't contain base identity then only reference to abstract
1353 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1354 * BaseIdentity} is added
1358 * @param basePackageName
1359 * string contains the module package name
1361 * IdentitySchemaNode which contains data about identity
1362 * @param schemaContext
1363 * SchemaContext which is used to get package and name
1364 * information about base of identity
1365 * @param genCtx generated context
1366 * @return returns generated context
1368 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1369 final IdentitySchemaNode identity, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1370 final boolean verboseClassComments) {
1372 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1376 private static GeneratedTypeBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1377 final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1378 final Map<Module, ModuleContext> genCtx) {
1379 Preconditions.checkNotNull(identity,"Identity can not be null!");
1381 //check first if identity has been resolved as base identity of some other one
1382 GeneratedTypeBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1383 if (newType == null) {
1384 final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1385 Preconditions.checkState(module.equals(parentModule),
1386 "If the type is null ,it must be in the same module, otherwise it must has been"
1387 + "resolved by an imported module.");
1389 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1390 BindingNamespaceType.Identity);
1391 newType = new GeneratedTypeBuilderImpl(packageName, identity.getQName().getLocalName(), true, false,
1392 genCtx.get(module));
1394 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1395 if (baseIdentities.size() == 0) {
1396 //no base - abstract
1397 final GeneratedTypeBuilderImpl genType = new GeneratedTypeBuilderImpl(BaseIdentity.class.getPackage().getName(),
1398 BaseIdentity.class.getSimpleName(), genCtx.get(module));
1399 newType.addImplementsType(genType.toInstance());
1401 //multiple bases - inheritance
1402 for (IdentitySchemaNode baseIdentity : baseIdentities) {
1403 GeneratedTypeBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1404 baseIdentity, module, verboseClassComments, genCtx);
1405 newType.addImplementsType(baseType.toInstance());
1409 if (verboseClassComments) {
1410 YangSourceDefinition.of(module).ifPresent(newType::setYangSourceDefinition);
1411 TypeComments.description(module).ifPresent(newType::addComment);
1412 module.getDescription().ifPresent(newType::setDescription);
1413 module.getReference().ifPresent(newType::setReference);
1415 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1417 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1419 genCtx.get(module).addIdentityType(identity.getQName(), newType);