2 * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.mdsal.binding.javav2.generator.impl;
11 import static com.google.common.base.Preconditions.checkArgument;
12 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.addTOToTypeBuilder;
13 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.annotateDeprecatedIfNecessary;
14 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.constructGetter;
15 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createDescription;
16 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createReturnTypeForUnion;
17 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.getAugmentIdentifier;
18 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.isInnerType;
19 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.qNameConstant;
20 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveInnerEnumFromTypeDefinition;
21 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTOBuilder;
22 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTypeBuilder;
23 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.computeDefaultSUID;
24 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
25 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
26 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION;
27 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
28 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.wildcardTypeFor;
29 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
32 import com.google.common.annotations.Beta;
33 import com.google.common.base.Preconditions;
34 import com.google.common.collect.Iterables;
35 import java.util.Collection;
36 import java.util.HashMap;
37 import java.util.List;
40 import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
41 import java.util.stream.Collectors;
42 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
43 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
50 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
51 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
52 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
53 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
54 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
55 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
56 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
57 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
58 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
59 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
60 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
63 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
64 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
65 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
66 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
67 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
68 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
69 import org.opendaylight.yangtools.yang.common.QName;
70 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
72 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
73 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
74 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
77 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
79 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
80 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.Module;
85 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
86 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
87 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
89 import org.opendaylight.yangtools.yang.model.api.Status;
90 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
91 import org.opendaylight.yangtools.yang.model.api.UsesNode;
92 import org.opendaylight.yangtools.yang.model.api.meta.ModelStatement;
93 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
94 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
96 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
97 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
100 * Helper util class used for generation of types in Binding spec v2.
103 final class GenHelperUtil {
105 private GenHelperUtil() {
106 throw new UnsupportedOperationException("Util class");
110 * Create GeneratedTypeBuilder object from module argument.
113 * Module object from which builder will be created
114 * @param genCtx generated context
115 * @param verboseClassComments verbosity switch
117 * @return <code>GeneratedTypeBuilder</code> which is internal
118 * representation of the module
119 * @throws IllegalArgumentException
122 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
123 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
125 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments,
127 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
128 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
129 moduleDataTypeBuilder.addComment(module.getDescription());
130 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
131 moduleDataTypeBuilder.setReference(module.getReference());
132 return moduleDataTypeBuilder;
136 * Generates type builder for <code>module</code>.
139 * Module which is source of package name for generated type
142 * string which is added to the module class name representation
144 * @param verboseClassComments verbosity switch
145 * @return instance of GeneratedTypeBuilder which represents
146 * <code>module</code>.
147 * @throws IllegalArgumentException
148 * if <code>module</code> is null
150 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
151 verboseClassComments, ModuleContext context) {
152 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
153 final String packageName = BindingMapping.getRootPackageName(module);
154 // underscore used as separator for distinction of module name parts
155 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
157 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName, context);
158 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
159 moduleBuilder.setReference(module.getReference());
160 moduleBuilder.setModuleName(moduleName);
161 return moduleBuilder;
165 * Adds the implemented types to type builder.
167 * The method passes through the list of <i>uses</i> in
168 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
169 * generated type from all groupings
170 * allGroupings} which is added as <i>implements type</i> to
171 * <code>builder</code>
173 * @param dataNodeContainer
174 * element which contains the list of used YANG groupings
176 * builder to which are added implemented types according to
177 * <code>dataNodeContainer</code>
178 * @param genCtx generated context
179 * @return generated type builder with all implemented types
181 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
182 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
183 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
184 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
185 if (genType == null) {
186 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
187 + builder.getName());
189 builder.addImplementsType(genType);
194 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
195 for (final ModuleContext ctx : genCtx.values()) {
196 final GeneratedTypeBuilder result = ctx.getGrouping(path);
197 if (result != null) {
204 static GeneratedTOBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
205 for (final ModuleContext ctx : genCtx.values()) {
206 final GeneratedTOBuilder result = ctx.getIdentities().get(qname);
207 if (result != null) {
215 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
216 * node for which <code>typeBuilder</code> was created.
218 * The subnodes aren't mapped to the methods if they are part of grouping or
219 * augment (in this case are already part of them).
223 * @param basePackageName
224 * string contains the module package name
226 * generated type builder which represents any node. The subnodes
227 * of this node are added to the <code>typeBuilder</code> as
228 * methods. The subnode can be of type leaf, leaf-list, list,
233 * set of data schema nodes which are the children of the node
234 * for which <code>typeBuilder</code> was created
235 * @return generated type builder which is the same builder as input
236 * parameter. The getter methods (representing child nodes) could be
239 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
240 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
241 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
242 final SchemaContext schemaContext, final boolean verboseClassComments,
243 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
244 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
246 if (schemaNodes != null && parent != null) {
247 for (final DataSchemaNode schemaNode : schemaNodes) {
248 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
249 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
250 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
257 static boolean resolveDataSchemaNodesCheck(final Module module, final SchemaContext schemaContext,
258 final DataSchemaNode schemaNode) {
259 if (!schemaNode.isAugmenting()) {
261 } else if (schemaNode.isAugmenting()) {
262 QName qname = schemaNode.getPath().getLastComponent();
263 final Module originalModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
264 qname.getRevision());
265 if (module.equals(originalModule)) {
273 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
274 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
275 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
276 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
277 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
278 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
281 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
282 QName childNodeQName = null;
283 if (node instanceof Module) {
284 childNodeQName = QName.create(((Module) node).getNamespace(), ((Module) node).getRevision(),
285 superChildNode.getQName().getLocalName());
286 } else if (node instanceof SchemaNode) {
287 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
288 } else if (node instanceof AugmentationSchema) {
289 childNodeQName = QName.create(module.getNamespace(), module.getRevision(), superChildNode.getQName().getLocalName());
291 throw new IllegalArgumentException("Not support node type:" + node.toString());
294 return childNodeQName;
297 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
298 final Object node, final Module module, final SchemaContext schemaContext,
299 Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
300 if (superNode instanceof DataNodeContainer) {
301 for (DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
302 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
303 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
304 DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
305 Preconditions.checkNotNull(childNode, node.toString() + "->" + childQName.toString());
307 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
308 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
310 Preconditions.checkNotNull(type, module.toString() + "->" + childNode.getPath().toString());
311 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superChildNode.getPath().toString());
312 type.addImplementsType(superType);
313 if (superChildNode instanceof ListSchemaNode
314 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
315 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
316 genCtx.get(module).getKeyType(childNode.getPath())
317 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
318 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
319 genCtx.get(module).getKeyGenTO(childNode.getPath())
320 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
323 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
326 } else if (superNode instanceof ChoiceSchemaNode) {
327 for (ChoiceCaseNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases()) {
328 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
329 ChoiceCaseNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
330 Preconditions.checkNotNull(caseNode, node.toString() + "->" + childQName.toString());
332 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
333 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
334 Preconditions.checkNotNull(type, module.toString() + "->" + caseNode.getPath().toString());
335 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superCaseNode.getPath().toString());
336 type.addImplementsType(superType);
337 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
340 throw new IllegalArgumentException("Not support super node :" + superNode.toString());
344 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
345 final Object parentNode, final UsesNode usesNode) {
346 SchemaNode groupingNode;
347 if (parentNode instanceof Module) {
348 final Module superModule = schemaContext.findModuleByNamespaceAndRevision(
349 usesNode.getGroupingPath().getLastComponent().getModule().getNamespace(),
350 usesNode.getGroupingPath().getLastComponent().getModule().getRevision());
351 groupingNode = superModule.getGroupings()
352 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
353 .findFirst().orElse(null);
355 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
356 final Iterable<QName> prefixedPath = usesNode.getGroupingPath().getPathFromRoot();
357 final QName current = prefixedPath.iterator().next();
358 final Module targetModule = schemaContext.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
359 Preconditions.checkArgument(targetModule != null, "Cannot find target module for %s and %s.",
360 current.getNamespace(), current.getRevision());
361 groupingNode = targetModule.getGroupings().stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
362 .collect(Collectors.toList()).get(0);
363 if (groupingNode == null) {
364 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
367 Preconditions.checkNotNull(groupingNode, module.toString() + "->"
368 + usesNode.getGroupingPath().toString());
369 Preconditions.checkState(groupingNode instanceof GroupingDefinition,
370 module.toString() + "->" + usesNode.getGroupingPath().toString());
371 return (GroupingDefinition) groupingNode;
374 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
375 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
376 if (node instanceof DataNodeContainer) {
377 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
378 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
379 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
380 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
386 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
387 for (final ModuleContext ctx : genCtx.values()) {
388 final GeneratedTypeBuilder result = ctx.getChildNode(path);
389 if (result != null) {
396 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
397 for (final ModuleContext ctx : genCtx.values()) {
398 final GeneratedTypeBuilder result = ctx.getCase(path);
399 if (result != null) {
406 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
407 final Type targetTypeRef, final SchemaNode targetNode, final List<AugmentationSchema> schemaPathAugmentListEntry,
408 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
409 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
410 final BindingNamespaceType namespaceType) {
412 //pick augmentation grouped by augmentation target, there is always at least one
413 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
415 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
416 augmentPackageName, k -> new HashMap<>());
418 //this requires valid semantics in YANG model
419 String augIdentifier = null;
420 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
421 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
425 if (augIdentifier == null) {
426 augIdentifier = new StringBuilder(module.getName())
427 .append('_').append(targetNode.getQName().getLocalName()).toString();
430 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
431 true, false, genCtx.get(module));
433 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
434 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
435 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
436 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
437 augTypeBuilder.setWithBuilder(true);
438 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
440 //produces getters for augTypeBuilder eventually
441 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
443 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
444 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
445 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
448 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
450 if(!augSchema.getChildNodes().isEmpty()) {
451 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
452 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
454 genCtx.get(module).addAugmentType(augTypeBuilder);
459 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
460 * node for which <code>typeBuilder</code> was created.
464 * @param basePackageName
465 * string contains the module package name
467 * generated type builder which represents any node. The subnodes
468 * of this node are added to the <code>typeBuilder</code> as
469 * methods. The subnode can be of type leaf, leaf-list, list,
474 * set of data schema nodes which are the children of the node
475 * for which <code>typeBuilder</code> was created
476 * @return generated type builder which is the same object as the input
477 * parameter <code>typeBuilder</code>. The getter method could be
480 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
481 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
482 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
483 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
484 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
485 if (schemaNodes != null && typeBuilder != null) {
486 for (final DataSchemaNode schemaNode : schemaNodes) {
487 if (!schemaNode.isAugmenting()) {
488 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
489 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
497 * Instantiates generated type builder with <code>packageName</code> and
498 * <code>schemaNode</code>.
500 * The new builder always implements
501 * {@link TreeNode TreeNode}.<br>
502 * If <code>schemaNode</code> is instance of GroupingDefinition it also
503 * implements {@link Augmentable
505 * If <code>schemaNode</code> is instance of
506 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
507 * DataNodeContainer} it can also implement nodes which are specified in
510 * @param basePackageName
511 * string contains the module package name
513 * schema node for which is created generated type builder
515 * parent type (can be null)
516 * @param schemaContext schema context
517 * @return generated type builder <code>schemaNode</code>
519 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
520 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
521 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
522 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
525 if (schemaNode instanceof GroupingDefinition) {
527 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
531 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
532 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
533 if (namespaceType.equals(BindingNamespaceType.Data)) {
534 if (parent == null) {
535 it.addImplementsType(BindingTypes.TREE_NODE);
537 if (parent instanceof ListSchemaNode) {
538 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
539 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
541 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
542 (BindingTypes.ITEM, parent)));
543 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, String
564 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
565 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
566 genTypeBuilders, TypeProvider typeProvider, 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 genCtx.get(module).addChildNodeType(notification, notificationInterface);
574 // Notification object
575 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
576 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
577 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
579 //in case of tied notification, incorporate parent's localName
580 final StringBuilder sb = new StringBuilder("on_");
581 if (parentName != null) {
582 sb.append(parentName).append('_');
584 sb.append(notificationInterface.getName());
586 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
587 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
588 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
589 return listenerInterface;
593 * Returns reference to generated type builder for specified
594 * <code>schemaNode</code> with <code>packageName</code>.
596 * Firstly the generated type builder is searched in
597 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
598 * found it is created and added to <code>genTypeBuilders</code>.
600 * @param basePackageName
601 * string contains the module package name
603 * schema node which provide data about the schema node name
604 * @param schemaContext schema context
606 * return type name prefix
607 * @return generated type builder for <code>schemaNode</code>
608 * @throws IllegalArgumentException
610 * <li>if <code>schemaNode</code> is null</li>
611 * <li>if <code>packageName</code> is null</li>
612 * <li>if QName of schema node is null</li>
613 * <li>if schemaNode name is null</li>
617 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
618 final SchemaContext schemaContext, final String prefix, final String suffix,
619 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
620 final BindingNamespaceType namespaceType, ModuleContext context) {
622 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
623 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
624 String schemaNodeName = schemaNode.getQName().getLocalName();
625 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
627 if (prefix != null && !prefix.isEmpty()) {
628 // underscore used as separator for distinction of class name parts
629 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
632 if (suffix != null && !suffix.isEmpty()) {
633 // underscore used as separator for distinction of class name parts
634 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
637 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
638 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
639 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
640 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
641 newType.addComment(schemaNode.getDescription());
642 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
643 verboseClassComments, namespaceType));
644 newType.setReference(schemaNode.getReference());
645 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
646 newType.setModuleName(module.getName());
647 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
648 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
650 if (!genTypeBuilders.containsKey(packageName)) {
651 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
652 builders.put(newType.getName(), newType);
653 genTypeBuilders.put(packageName, builders);
655 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
656 if (!builders.containsKey(newType.getName())) {
657 builders.put(newType.getName(), newType);
664 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
665 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
666 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
667 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
668 final BindingNamespaceType namespaceType) {
670 if (node != null && typeBuilder != null) {
671 if (node instanceof ContainerSchemaNode) {
672 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
673 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
674 } else if (node instanceof LeafListSchemaNode) {
675 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
676 typeProvider, genCtx);
677 } else if (node instanceof LeafSchemaNode) {
678 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
680 } else if (node instanceof ListSchemaNode) {
681 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
682 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
683 } else if (node instanceof ChoiceSchemaNode) {
684 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
685 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
686 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
687 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
693 * Converts <code>choiceNode</code> to the list of generated types for
694 * choice and its cases.
696 * The package names for choice and for its cases are created as
697 * concatenation of the module package (<code>basePackageName</code>) and
698 * names of all parents node.
702 * @param basePackageName
703 * string with the module package name
707 * choice node which is mapped to generated type. Also child
708 * nodes - cases are mapped to generated types.
709 * @throws IllegalArgumentException
711 * <li>if <code>basePackageName</code> is null</li>
712 * <li>if <code>choiceNode</code> is null</li>
715 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
716 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
717 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
718 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, 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(), choiceTypeBuilder, choiceNode.getStatus());
726 if (namespaceType.equals(BindingNamespaceType.Data)) {
727 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
729 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
730 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
731 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
732 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
735 private static void containerToGenType(final Module module, final String basePackageName,
736 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
737 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
738 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
739 final BindingNamespaceType namespaceType) {
741 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
742 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
743 if (genType != null) {
744 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
745 final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
746 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
747 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
748 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
752 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
753 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
754 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
755 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
756 final BindingNamespaceType namespaceType) {
758 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
759 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
760 if (genType != null) {
761 final String nodeName = node.getQName().getLocalName();
763 Type getterReturnType = Types.listTypeFor(genType);
764 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
765 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
768 constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
770 final List<QName> listKeys = node.getKeyDefinition();
771 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
772 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
773 //FIXME: Is it neccessary to generate interface of key and implemented by class?
774 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
775 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
776 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
777 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
778 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
779 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
782 if (genTypeBuilder != null) {
783 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
784 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
787 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
788 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
789 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
790 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
791 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
796 if (genTOBuilder != null) {
797 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
798 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
799 genTOBuilder.setSUID(prop);
801 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
802 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
808 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
809 final Type keyType, final Map<Module, ModuleContext> genCtx,
810 final BindingNamespaceType namespaceType) {
811 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
812 if (keyType != null) {
813 Type returnKeyType = keyType;
814 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
815 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
818 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
824 * Converts <code>leaf</code> to the getter method which is added to
825 * <code>typeBuilder</code>.
828 * generated type builder to which is added getter method as
829 * <code>leaf</code> mapping
831 * leaf schema node which is mapped as getter method which is
832 * added to <code>typeBuilder</code>
834 * Module in which type was defined
835 * @return boolean value
837 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
839 * <li>true - in other cases</li>
842 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
843 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
844 final Module module, final TypeProvider typeProvider) {
845 if (leaf == null || typeBuilder == null) {
849 final String leafName = leaf.getQName().getLocalName();
850 if (leafName == null) {
854 final Module parentModule = findParentModule(schemaContext, leaf);
855 Type returnType = null;
857 final TypeDefinition<?> typeDef = leaf.getType();
858 if (isInnerType(leaf, typeDef)) {
859 if (typeDef instanceof EnumTypeDefinition) {
860 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
861 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
862 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
863 genCtx, typeBuilder, module);
864 if (enumBuilder != null) {
865 returnType = enumBuilder.toInstance(typeBuilder);
867 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
868 } else if (typeDef instanceof UnionTypeDefinition) {
869 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
870 typeProvider, schemaContext, genCtx.get(module));
871 if (genTOBuilder != null) {
872 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
873 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
875 } else if (typeDef instanceof BitsTypeDefinition) {
876 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
877 typeProvider, schemaContext, genCtx.get(module));
878 if (genTOBuilder != null) {
879 returnType = genTOBuilder.toInstance();
882 // It is constrained version of already declared type (inner declared type exists,
883 // onlyfor special cases (Enum, Union, Bits), which were already checked.
884 // In order to get proper class we need to look up closest derived type
885 // and apply restrictions from leaf type
886 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
887 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
888 restrictions, genCtx.get(module));
891 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
892 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
895 if (returnType == null) {
899 if (typeDef instanceof EnumTypeDefinition) {
900 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
903 String leafDesc = leaf.getDescription();
904 if (leafDesc == null) {
908 final String leafGetterName;
909 if ("key".equals(leafName.toLowerCase())) {
910 StringBuilder sb = new StringBuilder(leafName)
911 .append('_').append("RESERVED_WORD");
912 leafGetterName = sb.toString();
914 leafGetterName = leafName;
916 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
921 * Converts <code>node</code> leaf list schema node to getter method of
922 * <code>typeBuilder</code>.
925 * generated type builder to which is <code>node</code> added as
928 * leaf list schema node which is added to
929 * <code>typeBuilder</code> as getter method
930 * @param module module
931 * @param typeProvider type provider instance
932 * @param genCtx actual generated context
933 * @return boolean value
935 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
936 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
937 * <li>false - other cases</li>
940 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
941 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
942 final Map<Module, ModuleContext> genCtx) {
943 if (node == null || typeBuilder == null) {
947 final QName nodeName = node.getQName();
949 final TypeDefinition<?> typeDef = node.getType();
950 final Module parentModule = findParentModule(schemaContext, node);
952 Type returnType = null;
953 if (typeDef.getBaseType() == null) {
954 if (typeDef instanceof EnumTypeDefinition) {
955 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
956 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
957 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
958 genCtx, typeBuilder, module);
959 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(),
961 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
962 } else if (typeDef instanceof UnionTypeDefinition) {
963 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
964 typeProvider, schemaContext, genCtx.get(module));
965 if (genTOBuilder != null) {
966 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
968 } else if (typeDef instanceof BitsTypeDefinition) {
969 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
970 typeProvider, schemaContext, genCtx.get(module));
971 returnType = genTOBuilder.toInstance();
973 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
974 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
977 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
978 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
981 final ParameterizedType listType = Types.listTypeFor(returnType);
982 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
987 * Converts <code>caseNodes</code> set to list of corresponding generated
990 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
991 * created generated type builder. The package names for the builder is
992 * created as concatenation of the module package (
993 * <code>basePackageName</code>) and names of all parents nodes of the
994 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
995 * between every case builder and <i>choice</i> type
999 * @param schemaContext
1000 * current schema context
1002 * actual generated context
1003 * @param basePackageName
1004 * string with the module package name
1005 * @param refChoiceType
1006 * type which represents superior <i>case</i>
1008 * choice case node which is mapped to generated type
1009 * @param verboseClassComments
1010 * Javadoc verbosity switch
1011 * @throws IllegalArgumentException
1013 * <li>if <code>basePackageName</code> equals null</li>
1014 * <li>if <code>refChoiceType</code> equals null</li>
1015 * <li>if <code>caseNodes</code> equals null</li>
1018 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1019 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1020 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1021 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1022 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1023 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1024 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1026 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1027 if (caseNodes == null) {
1031 for (final ChoiceCaseNode caseNode : caseNodes) {
1032 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1033 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1034 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1035 caseTypeBuilder.addImplementsType(refChoiceType);
1036 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1037 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1038 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1039 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1040 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1041 if (caseChildNodes != null) {
1042 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1044 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1045 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1047 if (parent instanceof AugmentationSchema) {
1048 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1049 final SchemaPath targetPath = augSchema.getTargetPath();
1050 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1051 if (targetSchemaNode instanceof DataSchemaNode
1052 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1053 if (targetSchemaNode instanceof DerivableSchemaNode) {
1054 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1056 if (targetSchemaNode == null) {
1057 throw new IllegalStateException(
1058 "Failed to find target node from grouping for augmentation " + augSchema
1059 + " in module " + module.getName());
1062 parent = targetSchemaNode;
1065 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1066 choiceNodeParentPath);
1067 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1068 if (childOfType == null) {
1069 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1071 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1072 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1074 final GeneratedTypeBuilder moduleType = genCtx.get(module).getModuleNode();
1075 Preconditions.checkNotNull(moduleType, "Module type can not be null.");
1076 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleType, caseChildNodes,
1077 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1079 processUsesImplements(caseNode, module, schemaContext, genCtx, namespaceType);
1085 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1086 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1087 final TypeProvider typeProvider) {
1089 final String anyName = node.getQName().getLocalName();
1090 if (anyName == null) {
1094 String anyDesc = node.getDescription();
1095 if (anyDesc == null) {
1099 Type returnType = Types.DOCUMENT;
1101 constructGetter(typeBuilder, anyName, anyDesc, 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,
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);
1168 } else if (schemaNode instanceof ContainerSchemaNode) {
1169 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1170 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1171 } else if (schemaNode instanceof ListSchemaNode) {
1172 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1173 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1174 } else if (schemaNode instanceof ChoiceSchemaNode) {
1175 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1176 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1181 private static 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,
1195 if (listKeys.contains(leafQName)) {
1196 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1200 if (schemaNode instanceof LeafListSchemaNode) {
1201 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1202 typeProvider, genCtx);
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,
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.findModuleByNamespaceAndRevision(qname.getNamespace(),
1228 qname.getRevision());
1229 final ModuleContext mc = genCtx.get(unionModule);
1230 returnType = mc.getTypedefs().get(typeDef.getPath());
1231 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1232 // Annonymous enumeration (already generated, since it is inherited via uses).
1233 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1234 QName qname = originalLeaf.getQName();
1235 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1236 qname.getRevision());
1237 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1239 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1241 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1246 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1247 final TypeDefinition<?> baseType = typeDef.getBaseType();
1248 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1251 @SuppressWarnings({ "rawtypes", "unchecked" })
1252 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1253 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1254 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1255 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1257 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1258 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1259 genType.addComment(node.getDescription());
1260 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1261 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1262 verboseClassComments, namespaceType));
1263 genType.setModuleName(module.getName());
1264 genType.setReference(node.getReference());
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, 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, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1337 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, 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, Map<Module, ModuleContext> genCtx,
1370 boolean verboseClassComments) {
1372 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1376 private static GeneratedTOBuilder 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 GeneratedTOBuilder 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 GeneratedTOBuilderImpl(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 GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1398 BaseIdentity.class.getSimpleName(), genCtx.get(module));
1399 newType.setExtendsType(gto.toInstance());
1401 //one base - inheritance
1402 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1403 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1404 baseIdentity, module, verboseClassComments, genCtx);
1405 newType.setExtendsType(baseType.toInstance());
1408 newType.setAbstract(true);
1409 newType.addComment(identity.getDescription());
1410 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1411 verboseClassComments, BindingNamespaceType.Identity));
1412 newType.setReference(identity.getReference());
1413 newType.setModuleName(module.getName());
1414 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1416 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1418 genCtx.get(module).addIdentityType(identity.getQName(), newType);