2 * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.mdsal.binding.javav2.generator.impl;
11 import static com.google.common.base.Preconditions.checkArgument;
12 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.addTOToTypeBuilder;
13 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.annotateDeprecatedIfNecessary;
14 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.constructGetter;
15 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createDescription;
16 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createReturnTypeForUnion;
17 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.getAugmentIdentifier;
18 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.isInnerType;
19 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.qNameConstant;
20 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveInnerEnumFromTypeDefinition;
21 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTOBuilder;
22 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.resolveListKeyTypeBuilder;
23 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.computeDefaultSUID;
24 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
25 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
26 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION;
27 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
28 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.wildcardTypeFor;
29 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
30 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
32 import com.google.common.annotations.Beta;
33 import com.google.common.base.Preconditions;
34 import com.google.common.collect.Iterables;
35 import java.util.Collection;
36 import java.util.HashMap;
37 import java.util.List;
40 import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
41 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
42 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
43 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
44 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
50 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
51 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
52 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
53 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
54 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
55 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
56 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
57 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
58 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
59 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
60 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
63 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
64 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
65 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
66 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
67 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
68 import org.opendaylight.yangtools.yang.common.QName;
69 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
70 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
72 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
73 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
74 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
75 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
76 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
79 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.Module;
84 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
85 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
86 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
88 import org.opendaylight.yangtools.yang.model.api.Status;
89 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
90 import org.opendaylight.yangtools.yang.model.api.UsesNode;
91 import org.opendaylight.yangtools.yang.model.api.meta.ModelStatement;
92 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
93 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
94 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
96 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
99 * Helper util class used for generation of types in Binding spec v2.
102 final class GenHelperUtil {
104 private GenHelperUtil() {
105 throw new UnsupportedOperationException("Util class");
109 * Create GeneratedTypeBuilder object from module argument.
112 * Module object from which builder will be created
113 * @param genCtx generated context
114 * @param verboseClassComments verbosity switch
116 * @return <code>GeneratedTypeBuilder</code> which is internal
117 * representation of the module
118 * @throws IllegalArgumentException
121 static GeneratedTypeBuilder moduleToDataType(final Module module, final Map<Module, ModuleContext> genCtx, final boolean verboseClassComments) {
122 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
124 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data", verboseClassComments,
126 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder, genCtx);
127 moduleDataTypeBuilder.addImplementsType(BindingTypes.TREE_ROOT);
128 moduleDataTypeBuilder.addComment(module.getDescription());
129 moduleDataTypeBuilder.setDescription(createDescription(module, verboseClassComments));
130 moduleDataTypeBuilder.setReference(module.getReference());
131 return moduleDataTypeBuilder;
135 * Generates type builder for <code>module</code>.
138 * Module which is source of package name for generated type
141 * string which is added to the module class name representation
143 * @param verboseClassComments verbosity switch
144 * @return instance of GeneratedTypeBuilder which represents
145 * <code>module</code>.
146 * @throws IllegalArgumentException
147 * if <code>module</code> is null
149 static GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix, final boolean
150 verboseClassComments, ModuleContext context) {
151 Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
152 final String packageName = BindingMapping.getRootPackageName(module);
153 // underscore used as separator for distinction of module name parts
154 final String moduleName = new StringBuilder(module.getName()).append('_').append(postfix).toString();
156 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName, context);
157 moduleBuilder.setDescription(createDescription(module, verboseClassComments));
158 moduleBuilder.setReference(module.getReference());
159 moduleBuilder.setModuleName(moduleName);
160 return moduleBuilder;
164 * Adds the implemented types to type builder.
166 * The method passes through the list of <i>uses</i> in
167 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
168 * generated type from all groupings
169 * allGroupings} which is added as <i>implements type</i> to
170 * <code>builder</code>
172 * @param dataNodeContainer
173 * element which contains the list of used YANG groupings
175 * builder to which are added implemented types according to
176 * <code>dataNodeContainer</code>
177 * @param genCtx generated context
178 * @return generated type builder with all implemented types
180 static GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
181 final GeneratedTypeBuilder builder, final Map<Module, ModuleContext> genCtx) {
182 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
183 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath(), genCtx).toInstance();
184 if (genType == null) {
185 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
186 + builder.getName());
188 builder.addImplementsType(genType);
193 static GeneratedTypeBuilder findGroupingByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
194 for (final ModuleContext ctx : genCtx.values()) {
195 final GeneratedTypeBuilder result = ctx.getGrouping(path);
196 if (result != null) {
203 static GeneratedTOBuilder findIdentityByQname(final QName qname, final Map<Module, ModuleContext> genCtx) {
204 for (final ModuleContext ctx : genCtx.values()) {
205 final GeneratedTOBuilder result = ctx.getIdentities().get(qname);
206 if (result != null) {
214 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
215 * node for which <code>typeBuilder</code> was created.
217 * The subnodes aren't mapped to the methods if they are part of grouping or
218 * augment (in this case are already part of them).
222 * @param basePackageName
223 * string contains the module package name
225 * generated type builder which represents any node. The subnodes
226 * of this node are added to the <code>typeBuilder</code> as
227 * methods. The subnode can be of type leaf, leaf-list, list,
232 * set of data schema nodes which are the children of the node
233 * for which <code>typeBuilder</code> was created
234 * @return generated type builder which is the same builder as input
235 * parameter. The getter methods (representing child nodes) could be
238 static GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
239 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf,
240 final Iterable<DataSchemaNode> schemaNodes, final Map<Module, ModuleContext> genCtx,
241 final SchemaContext schemaContext, final boolean verboseClassComments,
242 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
243 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
245 if (schemaNodes != null && parent != null) {
246 for (final DataSchemaNode schemaNode : schemaNodes) {
247 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
248 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module, genCtx,
249 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
256 static boolean resolveDataSchemaNodesCheck(final Module module, final SchemaContext schemaContext,
257 final DataSchemaNode schemaNode) {
258 if (!schemaNode.isAugmenting()) {
260 } else if (schemaNode.isAugmenting()) {
261 QName qname = schemaNode.getPath().getLastComponent();
262 final Module originalModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
263 qname.getRevision());
264 if (module.equals(originalModule)) {
272 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
273 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
274 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
275 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
276 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
277 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
280 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
281 QName childNodeQName = null;
282 if (node instanceof Module) {
283 childNodeQName = QName.create(((Module) node).getNamespace(), ((Module) node).getRevision(),
284 superChildNode.getQName().getLocalName());
285 } else if (node instanceof SchemaNode) {
286 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
287 } else if (node instanceof AugmentationSchema) {
288 childNodeQName = QName.create(module.getNamespace(), module.getRevision(), superChildNode.getQName().getLocalName());
290 throw new IllegalArgumentException("Not support node type:" + node.toString());
293 return childNodeQName;
296 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
297 final Object node, final Module module, final SchemaContext schemaContext,
298 Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
299 if (superNode instanceof DataNodeContainer) {
300 for (DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
301 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
302 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
303 DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
304 Preconditions.checkNotNull(childNode, node.toString() + "->" + childQName.toString());
306 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
307 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
309 Preconditions.checkNotNull(type, module.toString() + "->" + childNode.getPath().toString());
310 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superChildNode.getPath().toString());
311 type.addImplementsType(superType);
312 if (superChildNode instanceof ListSchemaNode
313 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
314 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
315 genCtx.get(module).getKeyType(childNode.getPath())
316 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
317 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
318 genCtx.get(module).getKeyGenTO(childNode.getPath())
319 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
322 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
325 } else if (superNode instanceof ChoiceSchemaNode) {
326 for (ChoiceCaseNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases()) {
327 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
328 ChoiceCaseNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
329 Preconditions.checkNotNull(caseNode, node.toString() + "->" + childQName.toString());
331 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
332 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
333 Preconditions.checkNotNull(type, module.toString() + "->" + caseNode.getPath().toString());
334 Preconditions.checkNotNull(superType, superModule.toString() + "->" + superCaseNode.getPath().toString());
335 type.addImplementsType(superType);
336 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
339 throw new IllegalArgumentException("Not support super node :" + superNode.toString());
343 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
344 final Object parentNode, final UsesNode usesNode) {
345 SchemaNode groupingNode;
346 if (parentNode instanceof Module) {
347 final Module superModule = schemaContext.findModuleByNamespaceAndRevision(
348 usesNode.getGroupingPath().getLastComponent().getModule().getNamespace(),
349 usesNode.getGroupingPath().getLastComponent().getModule().getRevision());
350 groupingNode = superModule.getGroupings()
351 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
352 .findFirst().orElse(null);
354 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
355 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
357 Preconditions.checkNotNull(groupingNode, module.toString() + "->"
358 + usesNode.getGroupingPath().toString());
359 Preconditions.checkState(groupingNode instanceof GroupingDefinition,
360 module.toString() + "->" + usesNode.getGroupingPath().toString());
361 return (GroupingDefinition) groupingNode;
364 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
365 final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
366 if (node instanceof DataNodeContainer) {
367 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
368 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
369 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
370 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
376 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
377 for (final ModuleContext ctx : genCtx.values()) {
378 final GeneratedTypeBuilder result = ctx.getChildNode(path);
379 if (result != null) {
386 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
387 for (final ModuleContext ctx : genCtx.values()) {
388 final GeneratedTypeBuilder result = ctx.getCase(path);
389 if (result != null) {
396 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
397 final Type targetTypeRef, final SchemaNode targetNode, final List<AugmentationSchema> schemaPathAugmentListEntry,
398 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
399 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
400 final BindingNamespaceType namespaceType) {
402 //pick augmentation grouped by augmentation target, there is always at least one
403 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
405 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
406 augmentPackageName, k -> new HashMap<>());
408 //this requires valid semantics in YANG model
409 String augIdentifier = null;
410 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
411 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
415 if (augIdentifier == null) {
416 augIdentifier = new StringBuilder(module.getName())
417 .append('_').append(targetNode.getQName().getLocalName()).toString();
420 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
421 true, false, genCtx.get(module));
423 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
424 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
425 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
426 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
427 augTypeBuilder.setWithBuilder(true);
428 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
430 //produces getters for augTypeBuilder eventually
431 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
433 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
434 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
435 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
438 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
440 if(!augSchema.getChildNodes().isEmpty()) {
441 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
442 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
444 genCtx.get(module).addAugmentType(augTypeBuilder);
449 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
450 * node for which <code>typeBuilder</code> was created.
454 * @param basePackageName
455 * string contains the module package name
457 * generated type builder which represents any node. The subnodes
458 * of this node are added to the <code>typeBuilder</code> as
459 * methods. The subnode can be of type leaf, leaf-list, list,
464 * set of data schema nodes which are the children of the node
465 * for which <code>typeBuilder</code> was created
466 * @return generated type builder which is the same object as the input
467 * parameter <code>typeBuilder</code>. The getter method could be
470 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
471 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
472 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
473 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
474 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
475 if (schemaNodes != null && typeBuilder != null) {
476 for (final DataSchemaNode schemaNode : schemaNodes) {
477 if (!schemaNode.isAugmenting()) {
478 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
479 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
487 * Instantiates generated type builder with <code>packageName</code> and
488 * <code>schemaNode</code>.
490 * The new builder always implements
491 * {@link TreeNode TreeNode}.<br>
492 * If <code>schemaNode</code> is instance of GroupingDefinition it also
493 * implements {@link Augmentable
495 * If <code>schemaNode</code> is instance of
496 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
497 * DataNodeContainer} it can also implement nodes which are specified in
500 * @param basePackageName
501 * string contains the module package name
503 * schema node for which is created generated type builder
505 * parent type (can be null)
506 * @param schemaContext schema context
507 * @return generated type builder <code>schemaNode</code>
509 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
510 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
511 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
512 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
515 if (schemaNode instanceof GroupingDefinition) {
517 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
521 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
522 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
523 if (namespaceType.equals(BindingNamespaceType.Data)) {
524 if (parent == null) {
525 it.addImplementsType(BindingTypes.TREE_NODE);
527 if (parent instanceof ListSchemaNode) {
528 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
529 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
531 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
532 (BindingTypes.ITEM, parent)));
533 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
537 if (!(schemaNode instanceof GroupingDefinition)) {
538 it.addImplementsType(BindingTypes.augmentable(it));
541 it.addImplementsType(BindingTypes.TREE_NODE);
544 if (schemaNode instanceof DataNodeContainer) {
545 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
546 verboseClassComments, genTypeBuilders, typeProvider);
547 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
553 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, String
554 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
555 final SchemaContext schemaContext, final boolean verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>>
556 genTypeBuilders, TypeProvider typeProvider, Map<Module, ModuleContext> genCtx) {
557 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
558 (basePackageName, notification, null, module, genCtx, schemaContext,
559 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
560 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
561 notificationInterface.addImplementsType(NOTIFICATION);
562 genCtx.get(module).addChildNodeType(notification, notificationInterface);
564 // Notification object
565 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
566 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
567 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
569 //in case of tied notification, incorporate parent's localName
570 final StringBuilder sb = new StringBuilder("on_");
571 if (parentName != null) {
572 sb.append(parentName).append('_');
574 sb.append(notificationInterface.getName());
576 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
577 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
578 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
579 return listenerInterface;
583 * Returns reference to generated type builder for specified
584 * <code>schemaNode</code> with <code>packageName</code>.
586 * Firstly the generated type builder is searched in
587 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
588 * found it is created and added to <code>genTypeBuilders</code>.
590 * @param basePackageName
591 * string contains the module package name
593 * schema node which provide data about the schema node name
594 * @param schemaContext schema context
596 * return type name prefix
597 * @return generated type builder for <code>schemaNode</code>
598 * @throws IllegalArgumentException
600 * <li>if <code>schemaNode</code> is null</li>
601 * <li>if <code>packageName</code> is null</li>
602 * <li>if QName of schema node is null</li>
603 * <li>if schemaNode name is null</li>
607 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
608 final SchemaContext schemaContext, final String prefix, final String suffix,
609 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
610 final BindingNamespaceType namespaceType, ModuleContext context) {
612 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
613 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
614 String schemaNodeName = schemaNode.getQName().getLocalName();
615 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
617 if (prefix != null && !prefix.isEmpty()) {
618 // underscore used as separator for distinction of class name parts
619 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
622 if (suffix != null && !suffix.isEmpty()) {
623 // underscore used as separator for distinction of class name parts
624 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
627 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
628 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
629 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
630 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
631 newType.addComment(schemaNode.getDescription());
632 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
633 verboseClassComments, namespaceType));
634 newType.setReference(schemaNode.getReference());
635 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
636 newType.setModuleName(module.getName());
637 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
638 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
640 if (!genTypeBuilders.containsKey(packageName)) {
641 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
642 builders.put(newType.getName(), newType);
643 genTypeBuilders.put(packageName, builders);
645 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
646 if (!builders.containsKey(newType.getName())) {
647 builders.put(newType.getName(), newType);
654 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
655 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
656 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
657 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
658 final BindingNamespaceType namespaceType) {
660 if (node != null && typeBuilder != null) {
661 if (node instanceof ContainerSchemaNode) {
662 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
663 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
664 } else if (node instanceof LeafListSchemaNode) {
665 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
666 typeProvider, genCtx);
667 } else if (node instanceof LeafSchemaNode) {
668 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
670 } else if (node instanceof ListSchemaNode) {
671 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
672 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
673 } else if (node instanceof ChoiceSchemaNode) {
674 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, childOf,
675 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
676 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
677 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
683 * Converts <code>choiceNode</code> to the list of generated types for
684 * choice and its cases.
686 * The package names for choice and for its cases are created as
687 * concatenation of the module package (<code>basePackageName</code>) and
688 * names of all parents node.
692 * @param basePackageName
693 * string with the module package name
697 * choice node which is mapped to generated type. Also child
698 * nodes - cases are mapped to generated types.
699 * @throws IllegalArgumentException
701 * <li>if <code>basePackageName</code> is null</li>
702 * <li>if <code>choiceNode</code> is null</li>
705 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
706 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
707 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
708 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
709 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
710 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
712 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
713 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType, genCtx.get(module));
714 constructGetter(parent, choiceNode.getQName().getLocalName(),
715 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
716 if (namespaceType.equals(BindingNamespaceType.Data)) {
717 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
719 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
720 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
721 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
722 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
725 private static void containerToGenType(final Module module, final String basePackageName,
726 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
727 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
728 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
729 final BindingNamespaceType namespaceType) {
731 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
732 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
733 if (genType != null) {
734 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
735 final MethodSignatureBuilder getter = constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
736 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
737 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
738 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
742 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
743 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
744 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
745 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
746 final BindingNamespaceType namespaceType) {
748 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
749 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
750 if (genType != null) {
751 final String nodeName = node.getQName().getLocalName();
753 Type getterReturnType = Types.listTypeFor(genType);
754 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
755 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
758 constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
760 final List<QName> listKeys = node.getKeyDefinition();
761 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
762 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
763 //FIXME: Is it neccessary to generate interface of key and implemented by class?
764 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
765 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
766 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
767 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
768 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
769 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
772 if (genTypeBuilder != null) {
773 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
774 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
777 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
778 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
779 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
780 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
781 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
786 if (genTOBuilder != null) {
787 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
788 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
789 genTOBuilder.setSUID(prop);
791 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
792 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
798 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
799 final Type keyType, final Map<Module, ModuleContext> genCtx,
800 final BindingNamespaceType namespaceType) {
801 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
802 if (keyType != null) {
803 Type returnKeyType = keyType;
804 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
805 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
808 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
814 * Converts <code>leaf</code> to the getter method which is added to
815 * <code>typeBuilder</code>.
818 * generated type builder to which is added getter method as
819 * <code>leaf</code> mapping
821 * leaf schema node which is mapped as getter method which is
822 * added to <code>typeBuilder</code>
824 * Module in which type was defined
825 * @return boolean value
827 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
829 * <li>true - in other cases</li>
832 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
833 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
834 final Module module, final TypeProvider typeProvider) {
835 if (leaf == null || typeBuilder == null) {
839 final String leafName = leaf.getQName().getLocalName();
840 if (leafName == null) {
844 final Module parentModule = findParentModule(schemaContext, leaf);
845 Type returnType = null;
847 final TypeDefinition<?> typeDef = leaf.getType();
848 if (isInnerType(leaf, typeDef)) {
849 if (typeDef instanceof EnumTypeDefinition) {
850 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
851 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
852 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
853 genCtx, typeBuilder, module);
854 if (enumBuilder != null) {
855 returnType = enumBuilder.toInstance(typeBuilder);
857 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
858 } else if (typeDef instanceof UnionTypeDefinition) {
859 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
860 typeProvider, schemaContext, genCtx.get(module));
861 if (genTOBuilder != null) {
862 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
863 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
865 } else if (typeDef instanceof BitsTypeDefinition) {
866 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
867 typeProvider, schemaContext, genCtx.get(module));
868 if (genTOBuilder != null) {
869 returnType = genTOBuilder.toInstance();
872 // It is constrained version of already declared type (inner declared type exists,
873 // onlyfor special cases (Enum, Union, Bits), which were already checked.
874 // In order to get proper class we need to look up closest derived type
875 // and apply restrictions from leaf type
876 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
877 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
878 restrictions, genCtx.get(module));
881 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
882 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
885 if (returnType == null) {
889 if (typeDef instanceof EnumTypeDefinition) {
890 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
893 String leafDesc = leaf.getDescription();
894 if (leafDesc == null) {
898 final String leafGetterName;
899 if ("key".equals(leafName.toLowerCase())) {
900 StringBuilder sb = new StringBuilder(leafName)
901 .append('_').append("RESERVED_WORD");
902 leafGetterName = sb.toString();
904 leafGetterName = leafName;
906 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
911 * Converts <code>node</code> leaf list schema node to getter method of
912 * <code>typeBuilder</code>.
915 * generated type builder to which is <code>node</code> added as
918 * leaf list schema node which is added to
919 * <code>typeBuilder</code> as getter method
920 * @param module module
921 * @param typeProvider type provider instance
922 * @param genCtx actual generated context
923 * @return boolean value
925 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
926 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
927 * <li>false - other cases</li>
930 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
931 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
932 final Map<Module, ModuleContext> genCtx) {
933 if (node == null || typeBuilder == null) {
937 final QName nodeName = node.getQName();
939 final TypeDefinition<?> typeDef = node.getType();
940 final Module parentModule = findParentModule(schemaContext, node);
942 Type returnType = null;
943 if (typeDef.getBaseType() == null) {
944 if (typeDef instanceof EnumTypeDefinition) {
945 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
946 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
947 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
948 genCtx, typeBuilder, module);
949 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(),
951 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
952 } else if (typeDef instanceof UnionTypeDefinition) {
953 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
954 typeProvider, schemaContext, genCtx.get(module));
955 if (genTOBuilder != null) {
956 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
958 } else if (typeDef instanceof BitsTypeDefinition) {
959 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
960 typeProvider, schemaContext, genCtx.get(module));
961 returnType = genTOBuilder.toInstance();
963 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
964 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
967 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
968 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
971 final ParameterizedType listType = Types.listTypeFor(returnType);
972 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
977 * Converts <code>caseNodes</code> set to list of corresponding generated
980 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
981 * created generated type builder. The package names for the builder is
982 * created as concatenation of the module package (
983 * <code>basePackageName</code>) and names of all parents nodes of the
984 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
985 * between every case builder and <i>choice</i> type
989 * @param schemaContext
990 * current schema context
992 * actual generated context
993 * @param basePackageName
994 * string with the module package name
995 * @param refChoiceType
996 * type which represents superior <i>case</i>
998 * choice case node which is mapped to generated type
999 * @param verboseClassComments
1000 * Javadoc verbosity switch
1001 * @throws IllegalArgumentException
1003 * <li>if <code>basePackageName</code> equals null</li>
1004 * <li>if <code>refChoiceType</code> equals null</li>
1005 * <li>if <code>caseNodes</code> equals null</li>
1008 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1009 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1010 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1011 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1012 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1013 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1014 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1016 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1017 if (caseNodes == null) {
1021 for (final ChoiceCaseNode caseNode : caseNodes) {
1022 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1023 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1024 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1025 caseTypeBuilder.addImplementsType(refChoiceType);
1026 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1027 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1028 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1029 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1030 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1031 if (caseChildNodes != null) {
1032 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1034 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1035 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1037 if (parent instanceof AugmentationSchema) {
1038 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1039 final SchemaPath targetPath = augSchema.getTargetPath();
1040 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1041 if (targetSchemaNode instanceof DataSchemaNode
1042 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1043 if (targetSchemaNode instanceof DerivableSchemaNode) {
1044 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1046 if (targetSchemaNode == null) {
1047 throw new IllegalStateException(
1048 "Failed to find target node from grouping for augmentation " + augSchema
1049 + " in module " + module.getName());
1052 parent = targetSchemaNode;
1055 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1056 choiceNodeParentPath);
1057 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1058 if (childOfType == null) {
1059 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1061 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1062 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1064 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module,
1065 genCtx, verboseClassComments), caseChildNodes, genCtx, schemaContext,
1066 verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1073 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1074 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1075 final TypeProvider typeProvider) {
1077 final String anyName = node.getQName().getLocalName();
1078 if (anyName == null) {
1082 String anyDesc = node.getDescription();
1083 if (anyDesc == null) {
1087 Type returnType = Types.DOCUMENT;
1089 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1094 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1095 * or to <code>genTOBuilder</code> as property.
1098 * string contains the name of list
1099 * @param basePackageName
1100 * string contains the module package name
1102 * data schema node which should be added as getter method to
1103 * <code>typeBuilder</code> or as a property to
1104 * <code>genTOBuilder</code> if is part of the list key
1105 * @param typeBuilder
1106 * generated type builder for the list schema node
1107 * @param genTOBuilder
1108 * generated TO builder for the list keys
1110 * list of string which contains QNames of the list keys
1113 * @param typeProvider
1114 * provider that defines contract for generated types
1115 * @param schemaContext
1118 * map of generated entities in context of YANG modules
1119 * @param genTypeBuilders
1120 * map of generated type builders
1121 * @param verboseClassComments
1122 * generate verbose comments
1123 * @throws IllegalArgumentException
1125 * <li>if <code>schemaNode</code> equals null</li>
1126 * <li>if <code>typeBuilder</code> equals null</li>
1129 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1130 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1131 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1132 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1133 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1134 final BindingNamespaceType namespaceType) {
1135 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1136 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1138 if (schemaNode instanceof LeafSchemaNode) {
1139 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1140 final QName leafQName = leaf.getQName();
1142 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1144 if (listKeys.contains(leafQName)) {
1146 resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1149 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1153 if (schemaNode instanceof LeafListSchemaNode) {
1154 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1155 typeProvider, genCtx);
1156 } else if (schemaNode instanceof ContainerSchemaNode) {
1157 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1158 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1159 } else if (schemaNode instanceof ListSchemaNode) {
1160 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1161 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1162 } else if (schemaNode instanceof ChoiceSchemaNode) {
1163 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1164 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1169 private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1170 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1171 final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1172 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1173 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1174 final BindingNamespaceType namespaceType) {
1175 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1176 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1178 if (schemaNode instanceof LeafSchemaNode) {
1179 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1180 final QName leafQName = leaf.getQName();
1181 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1183 if (listKeys.contains(leafQName)) {
1184 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1188 if (schemaNode instanceof LeafListSchemaNode) {
1189 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1190 typeProvider, genCtx);
1191 } else if (schemaNode instanceof ContainerSchemaNode) {
1192 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1193 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1194 } else if (schemaNode instanceof ListSchemaNode) {
1195 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1196 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1197 } else if (schemaNode instanceof ChoiceSchemaNode) {
1198 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1199 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1204 private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1205 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1206 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1208 if (leaf != null && toBuilder != null) {
1210 final TypeDefinition<?> typeDef = leaf.getType();
1211 if (typeDef instanceof UnionTypeDefinition) {
1212 // GeneratedType for this type definition should be already
1214 final QName qname = typeDef.getQName();
1215 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1216 qname.getRevision());
1217 final ModuleContext mc = genCtx.get(unionModule);
1218 returnType = mc.getTypedefs().get(typeDef.getPath());
1219 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1220 // Annonymous enumeration (already generated, since it is inherited via uses).
1221 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1222 QName qname = originalLeaf.getQName();
1223 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1224 qname.getRevision());
1225 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1227 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1229 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1234 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1235 final TypeDefinition<?> baseType = typeDef.getBaseType();
1236 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1239 @SuppressWarnings({ "rawtypes", "unchecked" })
1240 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1241 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1242 final boolean verboseClassComments, Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1243 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1245 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1246 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1247 genType.addComment(node.getDescription());
1248 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1249 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1250 verboseClassComments, namespaceType));
1251 genType.setModuleName(module.getName());
1252 genType.setReference(node.getReference());
1253 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1254 genType.setParentTypeForBuilder(childOf);
1255 if (node instanceof DataNodeContainer) {
1256 genCtx.get(module).addChildNodeType(node, genType);
1262 * Converts all <b>groupings</b> of the module to the list of
1263 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1264 * dependencies. At least dependent (independent) groupings are in the list
1265 * saved at first positions. For every grouping the record is added to map
1266 * {@link ModuleContext#groupings allGroupings}
1271 * collection of groupings from which types will be generated
1272 * @param typeProvider
1273 * provider that defines contract for generated types
1274 * @param schemaContext
1277 * map of generated entities in context of YANG modules
1278 * @param genTypeBuilders
1279 * map of generated type builders
1280 * @param verboseClassComments
1281 * generate verbose comments
1284 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1285 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1286 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1287 final String basePackageName = BindingMapping.getRootPackageName(module);
1288 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1290 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1291 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1292 verboseClassComments, genTypeBuilders, typeProvider);
1298 * Converts individual grouping to GeneratedType. Firstly generated type
1299 * builder is created and every child node of grouping is resolved to the
1302 * @param basePackageName
1303 * string contains the module package name
1305 * GroupingDefinition which contains data about grouping
1308 * @param typeProvider
1309 * provider that defines contract for generated types
1310 * @param schemaContext
1313 * map of generated entities in context of YANG modules
1314 * @param genTypeBuilders
1315 * map of generated type builders
1316 * @param verboseClassComments
1317 * generate verbose comments
1319 * @return GeneratedType which is generated from grouping (object of type
1320 * <code>GroupingDefinition</code>)
1322 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1323 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1324 verboseClassComments, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1325 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1326 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1327 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1328 genCtx.get(module).addGroupingType(grouping, genType);
1329 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1330 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1331 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1336 * //TODO: add information about multiple base identities in YANG 1.1
1337 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1338 * created transport object builder. If identity contains base identity then
1339 * reference to base identity is added to superior identity as its extend.
1340 * If identity doesn't contain base identity then only reference to abstract
1341 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1342 * BaseIdentity} is added
1346 * @param basePackageName
1347 * string contains the module package name
1349 * IdentitySchemaNode which contains data about identity
1350 * @param schemaContext
1351 * SchemaContext which is used to get package and name
1352 * information about base of identity
1353 * @param genCtx generated context
1354 * @return returns generated context
1356 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1357 final IdentitySchemaNode identity, final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx,
1358 boolean verboseClassComments) {
1360 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1364 private static GeneratedTOBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1365 final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1366 final Map<Module, ModuleContext> genCtx) {
1367 Preconditions.checkNotNull(identity,"Identity can not be null!");
1369 //check first if identity has been resolved as base identity of some other one
1370 GeneratedTOBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1371 if (newType == null) {
1372 final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1373 Preconditions.checkState(module.equals(parentModule),
1374 "If the type is null ,it must be in the same module, otherwise it must has been"
1375 + "resolved by an imported module.");
1377 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1378 BindingNamespaceType.Identity);
1379 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false,
1380 genCtx.get(module));
1382 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1383 if (baseIdentities.size() == 0) {
1384 //no base - abstract
1385 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1386 BaseIdentity.class.getSimpleName(), genCtx.get(module));
1387 newType.setExtendsType(gto.toInstance());
1389 //one base - inheritance
1390 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1391 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1392 baseIdentity, module, verboseClassComments, genCtx);
1393 newType.setExtendsType(baseType.toInstance());
1396 newType.setAbstract(true);
1397 newType.addComment(identity.getDescription());
1398 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1399 verboseClassComments, BindingNamespaceType.Identity));
1400 newType.setReference(identity.getReference());
1401 newType.setModuleName(module.getName());
1402 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1404 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1406 genCtx.get(module).addIdentityType(identity.getQName(), newType);