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.IDENTIFIABLE;
27 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.IDENTIFIER;
28 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION;
29 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.parameterizedTypeFor;
30 import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.wildcardTypeFor;
31 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
32 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
34 import com.google.common.annotations.Beta;
35 import com.google.common.base.Preconditions;
36 import com.google.common.collect.Iterables;
37 import java.util.Collection;
38 import java.util.HashMap;
39 import java.util.List;
42 import java.util.stream.Collectors;
43 import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
44 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
45 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
46 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes;
47 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
48 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
49 import org.opendaylight.mdsal.binding.javav2.generator.util.ReferencedTypeImpl;
50 import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
51 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
52 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
53 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
54 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.GroupingDefinitionDependencySort;
55 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
56 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
57 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
58 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
59 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
60 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
61 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
62 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
63 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
64 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
65 import org.opendaylight.mdsal.binding.javav2.spec.base.BaseIdentity;
66 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
67 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
68 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
69 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
70 import org.opendaylight.yangtools.yang.common.QName;
71 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
72 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
73 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
74 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
75 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
77 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
78 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
79 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
80 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
81 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.Module;
86 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
87 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
88 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
90 import org.opendaylight.yangtools.yang.model.api.Status;
91 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
92 import org.opendaylight.yangtools.yang.model.api.UsesNode;
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, final 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()) {
263 final QName qname = schemaNode.getPath().getLastComponent();
264 final Module originalModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
265 qname.getRevision());
266 return module.equals(originalModule);
269 static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
270 schemaNode, final Module module, final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext,
271 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
272 final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
273 return addDefaultInterfaceDefinition(basePackageName, schemaNode, null, module, genCtx, schemaContext,
274 verboseClassComments, genTypeBuilders, typeProvider , namespaceType);
277 private static QName createQNameFromSuperNode(final Module module, final Object node, final SchemaNode superChildNode) {
278 QName childNodeQName = null;
279 if (node instanceof Module) {
280 childNodeQName = QName.create(((Module) node).getQNameModule(), superChildNode.getQName().getLocalName());
281 } else if (node instanceof SchemaNode) {
282 childNodeQName = QName.create(((SchemaNode) node).getQName(), superChildNode.getQName().getLocalName());
283 } else if (node instanceof AugmentationSchema) {
284 childNodeQName = QName.create(module.getQNameModule(), superChildNode.getQName().getLocalName());
286 throw new IllegalArgumentException("Not support node type:" + node);
289 return childNodeQName;
292 private static void addUsesImplements(final SchemaNode superNode, final Module superModule,
293 final Object node, final Module module, final SchemaContext schemaContext,
294 final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
295 if (superNode instanceof DataNodeContainer) {
296 for (DataSchemaNode superChildNode : ((DataNodeContainer) superNode).getChildNodes()) {
297 if (superChildNode instanceof DataNodeContainer || superChildNode instanceof ChoiceSchemaNode) {
298 final QName childQName = createQNameFromSuperNode(module, node, superChildNode);
299 DataSchemaNode childNode = ((DataNodeContainer) node).getDataChildByName(childQName);
300 Preconditions.checkNotNull(childNode, "%s->%s", node, childQName);
302 final GeneratedTypeBuilder type = genCtx.get(module).getChildNode(childNode.getPath());
303 final GeneratedTypeBuilder superType = genCtx.get(superModule).getChildNode(superChildNode.getPath());
305 Preconditions.checkNotNull(type, "%s->%s", module, childNode.getPath());
306 Preconditions.checkNotNull(superType, "%s->%s", superModule, superChildNode.getPath());
307 type.addImplementsType(superType);
308 if (superChildNode instanceof ListSchemaNode
309 && !((ListSchemaNode) superChildNode).getKeyDefinition().isEmpty()) {
310 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
311 genCtx.get(module).getKeyType(childNode.getPath())
312 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
313 } else if (namespaceType.equals(BindingNamespaceType.Data)) {
314 genCtx.get(module).getKeyGenTO(childNode.getPath())
315 .addImplementsType(genCtx.get(superModule).getKeyType(superChildNode.getPath()));
318 addUsesImplements(superChildNode, superModule, childNode, module, schemaContext, genCtx, namespaceType);
321 } else if (superNode instanceof ChoiceSchemaNode) {
322 for (ChoiceCaseNode superCaseNode : ((ChoiceSchemaNode) superNode).getCases()) {
323 final QName childQName = createQNameFromSuperNode(module, node, superCaseNode);
324 ChoiceCaseNode caseNode = ((ChoiceSchemaNode) node).getCaseNodeByName(childQName);
325 Preconditions.checkNotNull(caseNode, "%s->%s", node, childQName);
327 final GeneratedTypeBuilder type = genCtx.get(module).getCase(caseNode.getPath());
328 final GeneratedTypeBuilder superType = genCtx.get(superModule).getCase(superCaseNode.getPath());
329 Preconditions.checkNotNull(type, "%s->%s", module, caseNode.getPath());
330 Preconditions.checkNotNull(superType, "%s->%s", superModule, superCaseNode.getPath());
331 type.addImplementsType(superType);
332 addUsesImplements(superCaseNode, superModule, caseNode, module, schemaContext, genCtx, namespaceType);
335 throw new IllegalArgumentException("Not support super node :" + superNode);
339 private static GroupingDefinition findGroupingNodeFromUses(final Module module, final SchemaContext schemaContext,
340 final Object parentNode, final UsesNode usesNode) {
341 SchemaNode groupingNode;
342 if (parentNode instanceof Module) {
343 final Module superModule = schemaContext.findModuleByNamespaceAndRevision(
344 usesNode.getGroupingPath().getLastComponent().getModule().getNamespace(),
345 usesNode.getGroupingPath().getLastComponent().getModule().getRevision());
346 groupingNode = superModule.getGroupings()
347 .stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
348 .findFirst().orElse(null);
350 //FIXME: Schema path is not unique for Yang 1.1, findDataSchemaNode always does search from data node first.
351 final Iterable<QName> prefixedPath = usesNode.getGroupingPath().getPathFromRoot();
352 final QName current = prefixedPath.iterator().next();
353 final Module targetModule = schemaContext.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
354 Preconditions.checkArgument(targetModule != null, "Cannot find target module for %s and %s.",
355 current.getNamespace(), current.getRevision());
356 groupingNode = targetModule.getGroupings().stream().filter(grouping -> grouping.getPath().equals(usesNode.getGroupingPath()))
357 .collect(Collectors.toList()).get(0);
358 if (groupingNode == null) {
359 groupingNode = SchemaContextUtil.findDataSchemaNode(schemaContext, usesNode.getGroupingPath());
363 Preconditions.checkNotNull(groupingNode, "%s->%s", module, usesNode.getGroupingPath());
364 Preconditions.checkState(groupingNode instanceof GroupingDefinition, "%s->%s", module,
365 usesNode.getGroupingPath());
366 return (GroupingDefinition) groupingNode;
369 static Map<Module, ModuleContext> processUsesImplements(final Object node, final Module module,
370 final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx, final BindingNamespaceType namespaceType) {
371 if (node instanceof DataNodeContainer) {
372 for (final UsesNode usesNode : ((DataNodeContainer) node).getUses()) {
373 final GroupingDefinition grouping = findGroupingNodeFromUses(module, schemaContext, node, usesNode);
374 final Module superModule = SchemaContextUtil.findParentModule(schemaContext, grouping);
375 addUsesImplements(grouping, superModule, node, module, schemaContext, genCtx, namespaceType);
381 static GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
382 for (final ModuleContext ctx : genCtx.values()) {
383 final GeneratedTypeBuilder result = ctx.getChildNode(path);
384 if (result != null) {
391 static GeneratedTypeBuilder findCaseByPath(final SchemaPath path, final Map<Module, ModuleContext> genCtx) {
392 for (final ModuleContext ctx : genCtx.values()) {
393 final GeneratedTypeBuilder result = ctx.getCase(path);
394 if (result != null) {
401 static Map<Module, ModuleContext> addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
402 final Type targetTypeRef, final SchemaNode targetNode, final List<AugmentationSchema> schemaPathAugmentListEntry,
403 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final Map<Module, ModuleContext> genCtx,
404 final SchemaContext schemaContext, final boolean verboseClassComments, final TypeProvider typeProvider,
405 final BindingNamespaceType namespaceType) {
407 //pick augmentation grouped by augmentation target, there is always at least one
408 final AugmentationSchema augSchema = schemaPathAugmentListEntry.get(0);
410 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.computeIfAbsent(
411 augmentPackageName, k -> new HashMap<>());
413 //this requires valid semantics in YANG model
414 String augIdentifier = null;
415 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
416 augIdentifier = getAugmentIdentifier(aug.getUnknownSchemaNodes());
420 if (augIdentifier == null) {
421 augIdentifier = new StringBuilder(module.getName())
422 .append('_').append(targetNode.getQName().getLocalName()).toString();
425 GeneratedTypeBuilderImpl augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augIdentifier,
426 true, false, genCtx.get(module));
428 augTypeBuilder.addImplementsType(BindingTypes.TREE_NODE);
429 augTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, augTypeBuilder));
430 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
431 augTypeBuilder.setBasePackageName(BindingMapping.getRootPackageName(module));
432 augTypeBuilder.setWithBuilder(true);
433 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
435 //produces getters for augTypeBuilder eventually
436 for (AugmentationSchema aug : schemaPathAugmentListEntry) {
438 addImplementedInterfaceFromUses(aug, augTypeBuilder, genCtx);
439 augSchemaNodeToMethods(module, BindingMapping.getRootPackageName(module), augTypeBuilder, augTypeBuilder, aug.getChildNodes(),
440 genCtx, schemaContext, verboseClassComments, typeProvider, genTypeBuilders, namespaceType);
443 augmentBuilders.put(augTypeBuilder.getName(), augTypeBuilder);
445 if(!augSchema.getChildNodes().isEmpty()) {
446 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
447 genCtx.get(module).addTargetToAugmentation(augTypeBuilder, augSchema.getTargetPath());
449 genCtx.get(module).addAugmentType(augTypeBuilder);
454 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
455 * node for which <code>typeBuilder</code> was created.
459 * @param basePackageName
460 * string contains the module package name
462 * generated type builder which represents any node. The subnodes
463 * of this node are added to the <code>typeBuilder</code> as
464 * methods. The subnode can be of type leaf, leaf-list, list,
469 * set of data schema nodes which are the children of the node
470 * for which <code>typeBuilder</code> was created
471 * @return generated type builder which is the same object as the input
472 * parameter <code>typeBuilder</code>. The getter method could be
475 private static GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
476 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes,
477 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
478 verboseClassComments, final TypeProvider typeProvider, final Map<String, Map<String,
479 GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
480 if (schemaNodes != null && typeBuilder != null) {
481 for (final DataSchemaNode schemaNode : schemaNodes) {
482 if (!schemaNode.isAugmenting()) {
483 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module, genCtx,
484 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
492 * Instantiates generated type builder with <code>packageName</code> and
493 * <code>schemaNode</code>.
495 * The new builder always implements
496 * {@link TreeNode TreeNode}.<br>
497 * If <code>schemaNode</code> is instance of GroupingDefinition it also
498 * implements {@link Augmentable
500 * If <code>schemaNode</code> is instance of
501 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
502 * DataNodeContainer} it can also implement nodes which are specified in
505 * @param basePackageName
506 * string contains the module package name
508 * schema node for which is created generated type builder
510 * parent type (can be null)
511 * @param schemaContext schema context
512 * @return generated type builder <code>schemaNode</code>
514 private static GeneratedTypeBuilder addDefaultInterfaceDefinition(final String basePackageName, final SchemaNode
515 schemaNode, final Type parent, final Module module, final Map<Module, ModuleContext> genCtx,
516 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String,
517 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
520 if (schemaNode instanceof GroupingDefinition) {
522 } else if (namespaceType.equals(BindingNamespaceType.Grouping)) {
526 GeneratedTypeBuilder it = addRawInterfaceDefinition(basePackageName, schemaNode, schemaContext, "", suffix,
527 verboseClassComments, genTypeBuilders, namespaceType, genCtx.get(module));
528 if (namespaceType.equals(BindingNamespaceType.Data)) {
529 if (parent == null) {
530 it.addImplementsType(BindingTypes.TREE_NODE);
532 if (parent instanceof ListSchemaNode) {
533 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
534 (BindingTypes.IDENTIFIABLE_ITEM, parent)));
536 it.addImplementsType(parameterizedTypeFor(BindingTypes.TREE_CHILD_NODE, parent, parameterizedTypeFor
537 (BindingTypes.ITEM, parent)));
538 it.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, it));
542 if (!(schemaNode instanceof GroupingDefinition)) {
543 it.addImplementsType(BindingTypes.augmentable(it));
546 it.addImplementsType(BindingTypes.TREE_NODE);
549 if (schemaNode instanceof DataNodeContainer) {
550 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings(), genCtx, schemaContext,
551 verboseClassComments, genTypeBuilders, typeProvider);
552 it = addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it, genCtx);
558 static GeneratedTypeBuilder resolveNotification(final GeneratedTypeBuilder listenerInterface, final String
559 parentName, final String basePackageName, final NotificationDefinition notification, final Module module,
560 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>>
561 genTypeBuilders, final TypeProvider typeProvider, final Map<Module, ModuleContext> genCtx) {
562 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition
563 (basePackageName, notification, null, module, genCtx, schemaContext,
564 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
565 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
566 notificationInterface.addImplementsType(NOTIFICATION);
567 genCtx.get(module).addChildNodeType(notification, notificationInterface);
569 // Notification object
570 resolveDataSchemaNodes(module, basePackageName, notificationInterface,
571 notificationInterface, notification.getChildNodes(), genCtx, schemaContext,
572 verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Data);
574 //in case of tied notification, incorporate parent's localName
575 final StringBuilder sb = new StringBuilder("on_");
576 if (parentName != null) {
577 sb.append(parentName).append('_');
579 sb.append(notificationInterface.getName());
581 listenerInterface.addMethod(JavaIdentifierNormalizer.normalizeSpecificIdentifier(sb.toString(), JavaIdentifier.METHOD))
582 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
583 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
584 return listenerInterface;
588 * Returns reference to generated type builder for specified
589 * <code>schemaNode</code> with <code>packageName</code>.
591 * Firstly the generated type builder is searched in
592 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
593 * found it is created and added to <code>genTypeBuilders</code>.
595 * @param basePackageName
596 * string contains the module package name
598 * schema node which provide data about the schema node name
599 * @param schemaContext schema context
601 * return type name prefix
602 * @return generated type builder for <code>schemaNode</code>
603 * @throws IllegalArgumentException
605 * <li>if <code>schemaNode</code> is null</li>
606 * <li>if <code>packageName</code> is null</li>
607 * <li>if QName of schema node is null</li>
608 * <li>if schemaNode name is null</li>
612 static GeneratedTypeBuilder addRawInterfaceDefinition(final String basePackageName, final SchemaNode schemaNode,
613 final SchemaContext schemaContext, final String prefix, final String suffix,
614 final boolean verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
615 final BindingNamespaceType namespaceType, final ModuleContext context) {
617 Preconditions.checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
618 Preconditions.checkArgument(basePackageName != null, "Base package Name for Generated Type cannot be NULL.");
619 String schemaNodeName = schemaNode.getQName().getLocalName();
620 Preconditions.checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
622 if (prefix != null && !prefix.isEmpty()) {
623 // underscore used as separator for distinction of class name parts
624 schemaNodeName = new StringBuilder(prefix).append('_').append(schemaNodeName).toString();
627 if (suffix != null && !suffix.isEmpty()) {
628 // underscore used as separator for distinction of class name parts
629 schemaNodeName = new StringBuilder(schemaNodeName).append('_').append(suffix).toString();
632 final String packageName = packageNameForGeneratedType(basePackageName, schemaNode.getPath(), namespaceType);
633 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, schemaNodeName, context);
634 final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
635 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
636 newType.addComment(schemaNode.getDescription());
637 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName(), schemaContext,
638 verboseClassComments, namespaceType));
639 newType.setReference(schemaNode.getReference());
640 newType.setSchemaPath((List<QName>) schemaNode.getPath().getPathFromRoot());
641 newType.setModuleName(module.getName());
642 newType.setBasePackageName(BindingMapping.getRootPackageName(module));
643 newType.setWithBuilder(AuxiliaryGenUtils.hasBuilderClass(schemaNode, namespaceType));
645 if (!genTypeBuilders.containsKey(packageName)) {
646 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
647 builders.put(newType.getName(), newType);
648 genTypeBuilders.put(packageName, builders);
650 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
651 if (!builders.containsKey(newType.getName())) {
652 builders.put(newType.getName(), newType);
659 private static void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
660 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module,
661 final Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
662 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
663 final BindingNamespaceType namespaceType) {
665 if (node != null && typeBuilder != null) {
666 if (node instanceof ContainerSchemaNode) {
667 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node,
668 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
669 } else if (node instanceof LeafListSchemaNode) {
670 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) node, module,
671 typeProvider, genCtx);
672 } else if (node instanceof LeafSchemaNode) {
673 resolveLeafSchemaNodeAsMethod("", schemaContext, typeBuilder, genCtx, (LeafSchemaNode) node, module,
675 } else if (node instanceof ListSchemaNode) {
676 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node, schemaContext,
677 verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
678 } else if (node instanceof ChoiceSchemaNode) {
679 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
680 (ChoiceSchemaNode) node, genTypeBuilders, genCtx, typeProvider, namespaceType);
681 } else if (node instanceof AnyXmlSchemaNode || node instanceof AnyDataSchemaNode) {
682 resolveAnyNodeAsMethod(schemaContext, typeBuilder, genCtx, node, module, typeProvider);
688 * Converts <code>choiceNode</code> to the list of generated types for
689 * choice and its cases.
691 * The package names for choice and for its cases are created as
692 * concatenation of the module package (<code>basePackageName</code>) and
693 * names of all parents node.
697 * @param basePackageName
698 * string with the module package name
702 * choice node which is mapped to generated type. Also child
703 * nodes - cases are mapped to generated types.
704 * @throws IllegalArgumentException
706 * <li>if <code>basePackageName</code> is null</li>
707 * <li>if <code>choiceNode</code> is null</li>
710 private static void choiceToGenType(final Module module, final SchemaContext schemaContext, final boolean
711 verboseClasssComments, final String basePackageName, final GeneratedTypeBuilder parent, final
712 ChoiceSchemaNode choiceNode, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
713 final Map<Module, ModuleContext> genCtx, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
714 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
715 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
717 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(basePackageName, choiceNode,
718 schemaContext, "", "", verboseClasssComments, genTypeBuilders, namespaceType, genCtx.get(module));
719 constructGetter(parent, choiceNode.getQName().getLocalName(),
720 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
721 if (namespaceType.equals(BindingNamespaceType.Data)) {
722 choiceTypeBuilder.addImplementsType(parameterizedTypeFor(BindingTypes.INSTANTIABLE, choiceTypeBuilder));
724 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
725 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
726 generateTypesFromChoiceCases(module, schemaContext, genCtx, basePackageName, choiceTypeBuilder.toInstance(),
727 choiceNode, verboseClasssComments, typeProvider, genTypeBuilders, namespaceType);
730 private static void containerToGenType(final Module module, final String basePackageName,
731 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node,
732 final SchemaContext schemaContext, final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
733 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
734 final BindingNamespaceType namespaceType) {
736 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
737 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
738 if (genType != null) {
739 StringBuilder getterName = new StringBuilder(node.getQName().getLocalName());
740 constructGetter(parent, getterName.toString(), node.getDescription(), genType, node.getStatus());
741 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes(), genCtx,
742 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
743 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
747 private static void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder
748 parent, final GeneratedTypeBuilder childOf, final ListSchemaNode node, final SchemaContext schemaContext,
749 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx,
750 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider,
751 final BindingNamespaceType namespaceType) {
753 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node,
754 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
755 if (genType != null) {
756 final String nodeName = node.getQName().getLocalName();
758 Type getterReturnType = Types.listTypeFor(genType);
759 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
760 getterReturnType = Types.listTypeFor(wildcardTypeFor(genType.getPackageName(), genType.getName(),
763 constructGetter(parent, nodeName, node.getDescription(), getterReturnType, node.getStatus());
765 final List<QName> listKeys = node.getKeyDefinition();
766 final String packageName = new StringBuilder(packageNameForGeneratedType(basePackageName, node.getPath(),
767 BindingNamespaceType.Key)).append('.').append(nodeName).toString();
768 //FIXME: Is it neccessary to generate interface of key and implemented by class?
769 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
770 final GeneratedTypeBuilder genTypeBuilder = resolveListKeyTypeBuilder(packageName, node, genCtx.get(module));
771 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
772 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
773 addSchemaNodeToListTypeBuilders(nodeName, basePackageName, schemaNode, genType, genTypeBuilder, listKeys,
774 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
777 if (genTypeBuilder != null) {
778 typeBuildersToGenTypes(module, genType, genTypeBuilder.toInstance(), genCtx, namespaceType);
779 genCtx.get(module).addKeyType(node.getPath(), genTypeBuilder);
781 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
783 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node, genCtx.get(module));
784 if (genTOBuilder != null) {
785 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
786 genTOBuilder.addImplementsType(IDENTIFIER);
787 genType.addImplementsType(identifiableMarker);
790 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
791 if (resolveDataSchemaNodesCheck(module, schemaContext, schemaNode)) {
792 addSchemaNodeToListBuilders(nodeName, basePackageName, schemaNode, genType, genTOBuilder, listKeys,
793 module, typeProvider, schemaContext, genCtx, genTypeBuilders, verboseClassComments, namespaceType);
796 processUsesImplements(node, module, schemaContext, genCtx, namespaceType);
799 if (genTOBuilder != null) {
800 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
801 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
802 genTOBuilder.setSUID(prop);
804 typeBuildersToGenTypes(module, genType, genTOBuilder.toInstance(), genCtx, namespaceType);
805 genCtx.get(module).addGeneratedTOBuilder(node.getPath(), genTOBuilder);
811 private static void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
812 final Type keyType, final Map<Module, ModuleContext> genCtx,
813 final BindingNamespaceType namespaceType) {
814 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
815 if (keyType != null) {
816 Type returnKeyType = keyType;
817 if (namespaceType.equals(BindingNamespaceType.Grouping)) {
818 returnKeyType = wildcardTypeFor(keyType.getPackageName(), keyType.getName(),
821 constructGetter(typeBuilder, "identifier", "Returns Primary Key of Yang List Type", returnKeyType, Status.CURRENT);
827 * Converts <code>leaf</code> to the getter method which is added to
828 * <code>typeBuilder</code>.
831 * generated type builder to which is added getter method as
832 * <code>leaf</code> mapping
834 * leaf schema node which is mapped as getter method which is
835 * added to <code>typeBuilder</code>
837 * Module in which type was defined
838 * @return boolean value
840 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
842 * <li>true - in other cases</li>
845 private static Type resolveLeafSchemaNodeAsMethod(final String nodeName, final SchemaContext schemaContext,
846 final GeneratedTypeBuilder typeBuilder, final Map<Module, ModuleContext> genCtx, final LeafSchemaNode leaf,
847 final Module module, final TypeProvider typeProvider) {
848 if (leaf == null || typeBuilder == null) {
852 final String leafName = leaf.getQName().getLocalName();
853 if (leafName == null) {
857 final Module parentModule = findParentModule(schemaContext, leaf);
858 Type returnType = null;
860 final TypeDefinition<?> typeDef = leaf.getType();
862 if (leaf.isAddedByUses()) {
863 Preconditions.checkState(leaf instanceof DerivableSchemaNode);
864 if (isInnerType(leaf, typeDef)) {
865 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
866 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
867 restrictions, genCtx.get(module));
869 if (typeDef.getBaseType() == null && (typeDef instanceof EnumTypeDefinition
870 || typeDef instanceof UnionTypeDefinition || typeDef instanceof BitsTypeDefinition)) {
871 LeafSchemaNode originalLeaf = (LeafSchemaNode) ((DerivableSchemaNode) leaf).getOriginal().orNull();
872 Preconditions.checkNotNull(originalLeaf);
873 returnType = genCtx.get(findParentModule(schemaContext, originalLeaf)).getInnerType(typeDef.getPath());
875 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
876 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
879 } else if (isInnerType(leaf, typeDef)) {
880 if (typeDef instanceof EnumTypeDefinition) {
881 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
882 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
883 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
884 genCtx, typeBuilder, module);
885 if (enumBuilder != null) {
886 returnType = enumBuilder.toInstance(typeBuilder);
888 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
889 } else if (typeDef instanceof UnionTypeDefinition) {
890 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
891 typeProvider, schemaContext, genCtx.get(module), genCtx);
892 if (genTOBuilder != null) {
893 //TODO: https://bugs.opendaylight.org/show_bug.cgi?id=2289
894 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
896 } else if (typeDef instanceof BitsTypeDefinition) {
897 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule,
898 typeProvider, schemaContext, genCtx.get(module), genCtx);
899 if (genTOBuilder != null) {
900 returnType = genTOBuilder.toInstance();
903 // It is constrained version of already declared type (inner declared type exists,
904 // onlyfor special cases (Enum, Union, Bits), which were already checked.
905 // In order to get proper class we need to look up closest derived type
906 // and apply restrictions from leaf type
907 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
908 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
909 restrictions, genCtx.get(module));
912 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
913 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions, genCtx.get(module));
916 if (returnType == null) {
920 if (typeDef instanceof EnumTypeDefinition) {
921 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
924 String leafDesc = leaf.getDescription();
925 if (leafDesc == null) {
929 final String leafGetterName;
930 if ("key".equals(leafName.toLowerCase())) {
931 StringBuilder sb = new StringBuilder(leafName)
932 .append('_').append("RESERVED_WORD");
933 leafGetterName = sb.toString();
935 leafGetterName = leafName;
937 constructGetter(typeBuilder, leafGetterName, leafDesc, returnType, leaf.getStatus());
942 * Converts <code>node</code> leaf list schema node to getter method of
943 * <code>typeBuilder</code>.
946 * generated type builder to which is <code>node</code> added as
949 * leaf list schema node which is added to
950 * <code>typeBuilder</code> as getter method
951 * @param module module
952 * @param typeProvider type provider instance
953 * @param genCtx actual generated context
954 * @return boolean value
956 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
957 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
958 * <li>false - other cases</li>
961 private static boolean resolveLeafListSchemaNode(final SchemaContext schemaContext, final GeneratedTypeBuilder
962 typeBuilder, final LeafListSchemaNode node, final Module module, final TypeProvider typeProvider,
963 final Map<Module, ModuleContext> genCtx) {
964 if (node == null || typeBuilder == null) {
968 final QName nodeName = node.getQName();
970 final TypeDefinition<?> typeDef = node.getType();
971 final Module parentModule = findParentModule(schemaContext, node);
973 Type returnType = null;
974 if (typeDef.getBaseType() == null) {
975 if (typeDef instanceof EnumTypeDefinition) {
976 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, genCtx.get(module));
977 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
978 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
979 genCtx, typeBuilder, module);
980 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName(), true,
982 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
983 } else if (typeDef instanceof UnionTypeDefinition) {
984 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
985 typeProvider, schemaContext, genCtx.get(module), genCtx);
986 if (genTOBuilder != null) {
987 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule, typeProvider);
989 } else if (typeDef instanceof BitsTypeDefinition) {
990 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule,
991 typeProvider, schemaContext, genCtx.get(module), genCtx);
992 returnType = genTOBuilder.toInstance();
994 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
995 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
998 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
999 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions, genCtx.get(module));
1002 final ParameterizedType listType = Types.listTypeFor(returnType);
1003 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
1008 * Converts <code>caseNodes</code> set to list of corresponding generated
1011 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1012 * created generated type builder. The package names for the builder is
1013 * created as concatenation of the module package (
1014 * <code>basePackageName</code>) and names of all parents nodes of the
1015 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1016 * between every case builder and <i>choice</i> type
1020 * @param schemaContext
1021 * current schema context
1023 * actual generated context
1024 * @param basePackageName
1025 * string with the module package name
1026 * @param refChoiceType
1027 * type which represents superior <i>case</i>
1029 * choice case node which is mapped to generated type
1030 * @param verboseClassComments
1031 * Javadoc verbosity switch
1032 * @throws IllegalArgumentException
1034 * <li>if <code>basePackageName</code> equals null</li>
1035 * <li>if <code>refChoiceType</code> equals null</li>
1036 * <li>if <code>caseNodes</code> equals null</li>
1039 private static void generateTypesFromChoiceCases(final Module module, final SchemaContext schemaContext,
1040 final Map<Module, ModuleContext> genCtx, final String basePackageName, final Type refChoiceType,
1041 final ChoiceSchemaNode choiceNode, final boolean verboseClassComments, final TypeProvider typeProvider,
1042 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final BindingNamespaceType namespaceType) {
1043 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1044 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1045 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1047 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1048 if (caseNodes == null) {
1052 for (final ChoiceCaseNode caseNode : caseNodes) {
1053 if (caseNode != null && resolveDataSchemaNodesCheck(module, schemaContext, caseNode)) {
1054 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(basePackageName, caseNode,
1055 module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1056 caseTypeBuilder.addImplementsType(refChoiceType);
1057 caseTypeBuilder.setParentTypeForBuilder(refChoiceType);
1058 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1059 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1060 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1061 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1062 if (caseChildNodes != null) {
1063 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1065 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1066 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1068 if (parent instanceof AugmentationSchema) {
1069 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1070 final SchemaPath targetPath = augSchema.getTargetPath();
1071 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1072 if (targetSchemaNode instanceof DataSchemaNode
1073 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1074 if (targetSchemaNode instanceof DerivableSchemaNode) {
1075 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1077 if (targetSchemaNode == null) {
1078 throw new IllegalStateException(
1079 "Failed to find target node from grouping for augmentation " + augSchema
1080 + " in module " + module.getName());
1083 parent = targetSchemaNode;
1086 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1087 choiceNodeParentPath);
1088 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath(), genCtx);
1089 if (childOfType == null) {
1090 childOfType = findGroupingByPath(parent.getPath(), genCtx);
1092 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes,
1093 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1095 final GeneratedTypeBuilder moduleType = genCtx.get(module).getModuleNode();
1096 Preconditions.checkNotNull(moduleType, "Module type can not be null.");
1097 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleType, caseChildNodes,
1098 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1100 processUsesImplements(caseNode, module, schemaContext, genCtx, namespaceType);
1106 private static Type resolveAnyNodeAsMethod(final SchemaContext schemaContext, final GeneratedTypeBuilder
1107 typeBuilder, final Map<Module, ModuleContext> genCtx, final DataSchemaNode node, final Module module,
1108 final TypeProvider typeProvider) {
1110 final String anyName = node.getQName().getLocalName();
1111 if (anyName == null) {
1115 String anyDesc = node.getDescription();
1116 if (anyDesc == null) {
1120 Type returnType = Types.DOCUMENT;
1122 constructGetter(typeBuilder, anyName, anyDesc, returnType, node.getStatus());
1127 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1128 * or to <code>genTOBuilder</code> as property.
1131 * string contains the name of list
1132 * @param basePackageName
1133 * string contains the module package name
1135 * data schema node which should be added as getter method to
1136 * <code>typeBuilder</code> or as a property to
1137 * <code>genTOBuilder</code> if is part of the list key
1138 * @param typeBuilder
1139 * generated type builder for the list schema node
1140 * @param genTOBuilder
1141 * generated TO builder for the list keys
1143 * list of string which contains QNames of the list keys
1146 * @param typeProvider
1147 * provider that defines contract for generated types
1148 * @param schemaContext
1151 * map of generated entities in context of YANG modules
1152 * @param genTypeBuilders
1153 * map of generated type builders
1154 * @param verboseClassComments
1155 * generate verbose comments
1156 * @throws IllegalArgumentException
1158 * <li>if <code>schemaNode</code> equals null</li>
1159 * <li>if <code>typeBuilder</code> equals null</li>
1162 private static void addSchemaNodeToListBuilders(final String nodeName, final String basePackageName,
1163 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1164 final GeneratedTOBuilder genTOBuilder, final List<QName> listKeys, final Module module,
1165 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1166 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1167 final BindingNamespaceType namespaceType) {
1168 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1169 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1171 if (schemaNode instanceof LeafSchemaNode) {
1172 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1173 final QName leafQName = leaf.getQName();
1175 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1177 if (listKeys.contains(leafQName)) {
1179 resolveLeafSchemaNodeAsProperty(nodeName, schemaContext, typeProvider, genCtx, genTOBuilder, leaf, true,
1182 AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, genTOBuilder, leaf, type, true);
1186 if (schemaNode instanceof LeafListSchemaNode) {
1187 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1188 typeProvider, genCtx);
1189 } else if (schemaNode instanceof ContainerSchemaNode) {
1190 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1191 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1192 } else if (schemaNode instanceof ListSchemaNode) {
1193 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1194 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1195 } else if (schemaNode instanceof ChoiceSchemaNode) {
1196 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1197 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1202 private static void addSchemaNodeToListTypeBuilders(final String nodeName, final String basePackageName,
1203 final DataSchemaNode schemaNode, final GeneratedTypeBuilder typeBuilder,
1204 final GeneratedTypeBuilder genTypeBuilder, final List<QName> listKeys, final Module module,
1205 final TypeProvider typeProvider, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1206 final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
1207 final BindingNamespaceType namespaceType) {
1208 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1209 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1211 if (schemaNode instanceof LeafSchemaNode) {
1212 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1213 final QName leafQName = leaf.getQName();
1214 final Type type = resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, typeBuilder, genCtx, leaf, module,
1216 if (listKeys.contains(leafQName)) {
1217 resolveLeafSchemaNodeAsMethod(nodeName, schemaContext, genTypeBuilder, genCtx, leaf, module,
1221 if (schemaNode instanceof LeafListSchemaNode) {
1222 resolveLeafListSchemaNode(schemaContext, typeBuilder, (LeafListSchemaNode) schemaNode, module,
1223 typeProvider, genCtx);
1224 } else if (schemaNode instanceof ContainerSchemaNode) {
1225 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode,
1226 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1227 } else if (schemaNode instanceof ListSchemaNode) {
1228 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode,
1229 schemaContext, verboseClassComments, genCtx, genTypeBuilders, typeProvider, namespaceType);
1230 } else if (schemaNode instanceof ChoiceSchemaNode) {
1231 choiceToGenType(module, schemaContext, verboseClassComments, basePackageName, typeBuilder,
1232 (ChoiceSchemaNode) schemaNode, genTypeBuilders, genCtx, typeProvider, namespaceType);
1237 private static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, final SchemaContext schemaContext, final TypeProvider
1238 typeProvider, final Map<Module, ModuleContext> genCtx, final GeneratedTOBuilder
1239 toBuilder, final LeafSchemaNode leaf, final boolean isReadOnly, final Module module) {
1241 if (leaf != null && toBuilder != null) {
1243 final TypeDefinition<?> typeDef = leaf.getType();
1244 if (typeDef instanceof UnionTypeDefinition) {
1245 // GeneratedType for this type definition should be already
1247 final QName qname = typeDef.getQName();
1248 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1249 qname.getRevision());
1250 final ModuleContext mc = genCtx.get(unionModule);
1251 returnType = mc.getTypedefs().get(typeDef.getPath());
1252 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1253 // Annonymous enumeration (already generated, since it is inherited via uses).
1254 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1255 QName qname = originalLeaf.getQName();
1256 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1257 qname.getRevision());
1258 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1260 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, genCtx.get(module));
1262 return AuxiliaryGenUtils.resolveLeafSchemaNodeAsProperty(nodeName, toBuilder, leaf, returnType, isReadOnly);
1267 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1268 final TypeDefinition<?> baseType = typeDef.getBaseType();
1269 return baseType != null && baseType.getBaseType() != null ? baseType : typeDef;
1272 @SuppressWarnings({ "rawtypes", "unchecked" })
1273 private static GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
1274 final GeneratedTypeBuilder childOf, final DataSchemaNode node, final SchemaContext schemaContext,
1275 final boolean verboseClassComments, final Map<Module, ModuleContext> genCtx, final Map<String, Map<String,
1276 GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider, final BindingNamespaceType namespaceType) {
1278 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, node, childOf, module,
1279 genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider, namespaceType);
1280 genType.addComment(node.getDescription());
1281 annotateDeprecatedIfNecessary(node.getStatus(), genType);
1282 genType.setDescription(createDescription(node, genType.getFullyQualifiedName(), schemaContext,
1283 verboseClassComments, namespaceType));
1284 genType.setModuleName(module.getName());
1285 genType.setReference(node.getReference());
1286 genType.setSchemaPath((List) node.getPath().getPathFromRoot());
1287 genType.setParentTypeForBuilder(childOf);
1288 if (node instanceof DataNodeContainer) {
1289 genCtx.get(module).addChildNodeType(node, genType);
1295 * Converts all <b>groupings</b> of the module to the list of
1296 * <code>Type</code> objects. Firstly are groupings sorted according mutual
1297 * dependencies. At least dependent (independent) groupings are in the list
1298 * saved at first positions. For every grouping the record is added to map
1299 * {@link ModuleContext#groupings allGroupings}
1304 * collection of groupings from which types will be generated
1305 * @param typeProvider
1306 * provider that defines contract for generated types
1307 * @param schemaContext
1310 * map of generated entities in context of YANG modules
1311 * @param genTypeBuilders
1312 * map of generated type builders
1313 * @param verboseClassComments
1314 * generate verbose comments
1317 static Map<Module, ModuleContext> groupingsToGenTypes(final Module module, final Collection<GroupingDefinition>
1318 groupings, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1319 verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1320 final String basePackageName = BindingMapping.getRootPackageName(module);
1321 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
1323 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
1324 genCtx = groupingToGenType(basePackageName, grouping, module, genCtx, schemaContext,
1325 verboseClassComments, genTypeBuilders, typeProvider);
1331 * Converts individual grouping to GeneratedType. Firstly generated type
1332 * builder is created and every child node of grouping is resolved to the
1335 * @param basePackageName
1336 * string contains the module package name
1338 * GroupingDefinition which contains data about grouping
1341 * @param typeProvider
1342 * provider that defines contract for generated types
1343 * @param schemaContext
1346 * map of generated entities in context of YANG modules
1347 * @param genTypeBuilders
1348 * map of generated type builders
1349 * @param verboseClassComments
1350 * generate verbose comments
1352 * @return GeneratedType which is generated from grouping (object of type
1353 * <code>GroupingDefinition</code>)
1355 private static Map<Module, ModuleContext> groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module
1356 module, Map<Module, ModuleContext> genCtx, final SchemaContext schemaContext, final boolean
1357 verboseClassComments, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
1358 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(basePackageName, grouping, module, genCtx,
1359 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1360 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
1361 genCtx.get(module).addGroupingType(grouping, genType);
1362 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes(), genCtx,
1363 schemaContext, verboseClassComments, genTypeBuilders, typeProvider, BindingNamespaceType.Grouping);
1364 genCtx = processUsesImplements(grouping, module, schemaContext, genCtx, BindingNamespaceType.Grouping);
1369 * //TODO: add information about multiple base identities in YANG 1.1
1370 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
1371 * created transport object builder. If identity contains base identity then
1372 * reference to base identity is added to superior identity as its extend.
1373 * If identity doesn't contain base identity then only reference to abstract
1374 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
1375 * BaseIdentity} is added
1379 * @param basePackageName
1380 * string contains the module package name
1382 * IdentitySchemaNode which contains data about identity
1383 * @param schemaContext
1384 * SchemaContext which is used to get package and name
1385 * information about base of identity
1386 * @param genCtx generated context
1387 * @return returns generated context
1389 static Map<Module, ModuleContext> identityToGenType(final Module module, final String basePackageName,
1390 final IdentitySchemaNode identity, final SchemaContext schemaContext, final Map<Module, ModuleContext> genCtx,
1391 final boolean verboseClassComments) {
1393 resolveIdentitySchemaNode(basePackageName, schemaContext, identity, module, verboseClassComments, genCtx);
1397 private static GeneratedTOBuilder resolveIdentitySchemaNode(final String basePackageName, final SchemaContext schemaContext,
1398 final IdentitySchemaNode identity, final Module module, final boolean verboseClassComments,
1399 final Map<Module, ModuleContext> genCtx) {
1400 Preconditions.checkNotNull(identity,"Identity can not be null!");
1402 //check first if identity has been resolved as base identity of some other one
1403 GeneratedTOBuilder newType = findIdentityByQname(identity.getQName(), genCtx);
1404 if (newType == null) {
1405 final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, identity);
1406 Preconditions.checkState(module.equals(parentModule),
1407 "If the type is null ,it must be in the same module, otherwise it must has been"
1408 + "resolved by an imported module.");
1410 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, identity.getPath(),
1411 BindingNamespaceType.Identity);
1412 newType = new GeneratedTOBuilderImpl(packageName, identity.getQName().getLocalName(), true, false,
1413 genCtx.get(module));
1415 final Set<IdentitySchemaNode> baseIdentities = identity.getBaseIdentities();
1416 if (baseIdentities.size() == 0) {
1417 //no base - abstract
1418 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
1419 BaseIdentity.class.getSimpleName(), genCtx.get(module));
1420 newType.setExtendsType(gto.toInstance());
1422 //one base - inheritance
1423 final IdentitySchemaNode baseIdentity = baseIdentities.iterator().next();
1424 GeneratedTOBuilder baseType = resolveIdentitySchemaNode(basePackageName, schemaContext,
1425 baseIdentity, module, verboseClassComments, genCtx);
1426 newType.setExtendsType(baseType.toInstance());
1429 newType.setAbstract(true);
1430 newType.addComment(identity.getDescription());
1431 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName(), schemaContext,
1432 verboseClassComments, BindingNamespaceType.Identity));
1433 newType.setReference(identity.getReference());
1434 newType.setModuleName(module.getName());
1435 newType.setSchemaPath((List) identity.getPath().getPathFromRoot());
1437 qNameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, identity.getQName());
1439 genCtx.get(module).addIdentityType(identity.getQName(), newType);