2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
\r
4 * This program and the accompanying materials are made available under the
\r
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
\r
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
\r
8 package org.opendaylight.yangtools.sal.binding.generator.impl;
10 import static com.google.common.base.Preconditions.*;
\r
11 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
\r
12 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
\r
13 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
\r
14 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
\r
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.HashMap;
19 import java.util.List;
21 import java.util.Set;
\r
22 import java.util.Iterator
\r
23 import java.util.Collection
24 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
25 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
26 import org.opendaylight.yangtools.binding.generator.util.Types;
27 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
28 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
29 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
30 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
31 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
32 import org.opendaylight.yangtools.sal.binding.model.api.Type;
33 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
34 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
35 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
36 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
37 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
38 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
39 import org.opendaylight.yangtools.yang.binding.RpcService;
40 import org.opendaylight.yangtools.yang.common.RpcResult;
41 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
42 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
43 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
44 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
46 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
48 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
50 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
52 import org.opendaylight.yangtools.yang.model.api.Module;
53 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
54 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
55 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
56 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
57 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
58 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
59 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
60 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
61 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
62 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
63 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
64 import org.opendaylight.yangtools.yang.model.util.UnionType;
65 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort
66 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
67 import org.opendaylight.yangtools.yang.model.api.UsesNode
68 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext
69 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder
70 import org.opendaylight.yangtools.yang.model.api.ModuleImport
71 import org.opendaylight.yangtools.yang.binding.DataContainer
72 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget
73 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition
74 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil
75 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions
76 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder
77 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl
78 import org.opendaylight.yangtools.yang.common.QName
\rimport org.opendaylight.yangtools.yang.binding.BindingMapping
79 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase
81 import com.google.common.collect.Sets
85 public class BindingGeneratorImpl implements BindingGenerator {
87 private final Map<Module, ModuleContext> genCtx = new HashMap()
90 * Outer key represents the package name. Outer value represents map of
\r
91 * all builders in the same package. Inner key represents the schema node
\r
92 * name (in JAVA class/interface name format). Inner value represents
\r
93 * instance of builder for schema node specified in key part.
\r
95 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
98 * Provide methods for converting YANG types to JAVA types.
\r
100 private var TypeProvider typeProvider;
103 * Holds reference to schema context to resolve data of augmented element
\r
104 * when creating augmentation builder
\r
106 private var SchemaContext schemaContext;
109 * Constant with the concrete name of namespace.
\r
111 private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
114 * Constant with the concrete name of identifier.
\r
116 private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
119 * Resolves generated types from <code>context</code> schema nodes of all
\r
122 * Generated types are created for modules, groupings, types, containers,
\r
123 * lists, choices, augments, rpcs, notification, identities.
\r
126 * schema context which contains data about all schema nodes
\r
128 * @return list of types (usually <code>GeneratedType</code>
\r
129 * <code>GeneratedTransferObject</code>which are generated from
\r
130 * <code>context</code> data.
\r
131 * @throws IllegalArgumentException
\r
132 * if param <code>context</code> is null
\r
133 * @throws IllegalStateException
\r
134 * if <code>context</code> contain no modules
\r
136 override generateTypes(SchemaContext context) {
137 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
138 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
139 schemaContext = context;
140 typeProvider = new TypeProviderImpl(context);
141 val Set<Module> modules = context.modules;
142 return generateTypes(context, modules);
146 * Resolves generated types from <code>context</code> schema nodes only for
\r
147 * modules specified in <code>modules</code>
\r
149 * Generated types are created for modules, groupings, types, containers,
\r
150 * lists, choices, augments, rpcs, notification, identities.
\r
153 * schema context which contains data about all schema nodes
\r
156 * set of modules for which schema nodes should be generated
\r
158 * @return list of types (usually <code>GeneratedType</code> or
\r
159 * <code>GeneratedTransferObject</code>) which:
\r
161 * <li>are generated from <code>context</code> schema nodes and</li>
\r
162 * <li>are also part of some of the module in <code>modules</code>
\r
165 * @throws IllegalArgumentException
\r
167 * <li>if param <code>context</code> is null or</li>
\r
168 * <li>if param <code>modules</code> is null</li>
\r
170 * @throws IllegalStateException
\r
171 * if <code>context</code> contain no modules
\r
173 override generateTypes(SchemaContext context, Set<Module> modules) {
174 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
175 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
176 checkArgument(modules !== null, "Set of Modules cannot be NULL.");
178 schemaContext = context;
179 typeProvider = new TypeProviderImpl(context);
180 val contextModules = ModuleDependencySort.sort(context.modules);
181 genTypeBuilders = new HashMap();
183 for (contextModule : contextModules) {
184 moduleToGenTypes(contextModule, context);
186 for (contextModule : contextModules) {
187 allAugmentsToGenTypes(contextModule);
190 val List<Type> filteredGenTypes = new ArrayList();
191 for (Module m : modules) {
192 filteredGenTypes.addAll(genCtx.get(m).generatedTypes);
\r
193 val Set<Type> additionalTypes = (typeProvider as TypeProviderImpl).additionalTypes.get(m)
\r
194 if (additionalTypes != null) {
\r
195 filteredGenTypes.addAll(additionalTypes)
\r
199 return filteredGenTypes;
202 private def void moduleToGenTypes(Module m, SchemaContext context) {
203 genCtx.put(m, new ModuleContext)
204 allTypeDefinitionsToGenTypes(m)
205 groupingsToGenTypes(m, m.groupings)
206 rpcMethodsToGenType(m)
207 allIdentitiesToGenTypes(m, context)
208 notificationsToGenType(m)
210 if (!m.childNodes.isEmpty()) {
211 val moduleType = moduleToDataType(m)
212 genCtx.get(m).addModuleNode(moduleType)
213 val basePackageName = moduleNamespaceToPackageName(m);
214 resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.childNodes)
219 * Converts all extended type definitions of module to the list of
\r
220 * <code>Type</code> objects.
\r
223 * module from which is obtained set of type definitions
\r
224 * @throws IllegalArgumentException
\r
226 * <li>if module equals null</li>
\r
227 * <li>if name of module equals null</li>
\r
228 * <li>if type definitions of module equal null</li>
\r
232 private def void allTypeDefinitionsToGenTypes(Module module) {
233 checkArgument(module !== null, "Module reference cannot be NULL.");
234 checkArgument(module.name !== null, "Module name cannot be NULL.");
235 val it = new DataNodeIterator(module);
236 val List<TypeDefinition<?>> typeDefinitions = it.allTypedefs;
237 checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');
239 for (TypeDefinition<?> typedef : typeDefinitions) {
240 if (typedef !== null) {
241 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
243 genCtx.get(module).addTypedefType(typedef.path, type)
249 private def GeneratedTypeBuilder processDataSchemaNode(Module module, String basePackageName,
250 GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, DataSchemaNode node) {
251 if (node.augmenting || node.addedByUses) {
254 val packageName = packageNameForGeneratedType(basePackageName, node.path)
255 val genType = addDefaultInterfaceDefinition(packageName, node, childOf)
256 if (node instanceof DataNodeContainer) {
257 genCtx.get(module).addChildNodeType(node.path, genType)
258 groupingsToGenTypes(module, (node as DataNodeContainer).groupings)
259 processUsesAugments(node as DataNodeContainer, module)
264 private def void containerToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
265 GeneratedTypeBuilder childOf, ContainerSchemaNode node) {
266 val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
267 if (genType != null) {
268 constructGetter(parent, node.QName.localName, node.description, genType)
269 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.childNodes)
273 private def void listToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
274 GeneratedTypeBuilder childOf, ListSchemaNode node) {
275 val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
276 if (genType != null) {
277 constructGetter(parent, node.QName.localName, node.description, Types.listTypeFor(genType))
279 val List<String> listKeys = listKeys(node);
280 val packageName = packageNameForGeneratedType(basePackageName, (node).path)
281 val genTOBuilder = resolveListKeyTOBuilder(packageName, node);
282 if (genTOBuilder !== null) {
283 val identifierMarker = IDENTIFIER.parameterizedTypeFor(genType);
284 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
285 genTOBuilder.addImplementsType(identifierMarker);
286 genType.addImplementsType(identifiableMarker);
289 for (schemaNode : node.childNodes) {
290 if (!schemaNode.augmenting) {
291 addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
295 // serialVersionUID
\r
296 if (genTOBuilder !== null) {
297 val GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
298 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder as GeneratedTOBuilderImpl)));
299 genTOBuilder.setSUID(prop);
302 typeBuildersToGenTypes(module, genType, genTOBuilder);
306 private def void processUsesAugments(DataNodeContainer node, Module module) {
307 val basePackageName = moduleNamespaceToPackageName(module);
308 for (usesNode : node.uses) {
309 for (augment : usesNode.augmentations) {
310 augmentationToGenTypes(basePackageName, augment, module, usesNode);
311 processUsesAugments(augment, module);
317 * Converts all <b>augmentation</b> of the module to the list
\r
318 * <code>Type</code> objects.
\r
321 * module from which is obtained list of all augmentation objects
\r
322 * to iterate over them
\r
323 * @throws IllegalArgumentException
\r
325 * <li>if the module equals null</li>
\r
326 * <li>if the name of module equals null</li>
\r
327 * <li>if the set of child nodes equals null</li>
\r
331 private def void allAugmentsToGenTypes(Module module) {
332 checkArgument(module !== null, "Module reference cannot be NULL.");
333 checkArgument(module.name !== null, "Module name cannot be NULL.");
334 if (module.childNodes === null) {
335 throw new IllegalArgumentException(
336 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
339 val basePackageName = moduleNamespaceToPackageName(module);
340 val List<AugmentationSchema> augmentations = resolveAugmentations(module);
341 for (augment : augmentations) {
342 augmentationToGenTypes(basePackageName, augment, module, null);
347 * Returns list of <code>AugmentationSchema</code> objects. The objects are
\r
348 * sorted according to the length of their target path from the shortest to
\r
352 * module from which is obtained list of all augmentation objects
\r
353 * @return list of sorted <code>AugmentationSchema</code> objects obtained
\r
354 * from <code>module</code>
\r
355 * @throws IllegalArgumentException
\r
357 * <li>if the module equals null</li>
\r
358 * <li>if the set of augmentation equals null</li>
\r
362 private def List<AugmentationSchema> resolveAugmentations(Module module) {
363 checkArgument(module !== null, "Module reference cannot be NULL.");
364 checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
366 val Set<AugmentationSchema> augmentations = module.augmentations;
367 val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
368 Collections.sort(sortedAugmentations,
369 [ augSchema1, augSchema2 |
370 if (augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
372 } else if (augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
377 return sortedAugmentations;
381 * Converts whole <b>module</b> to <code>GeneratedType</code> object.
\r
382 * Firstly is created the module builder object from which is vally
\r
383 * obtained reference to <code>GeneratedType</code> object.
\r
386 * module from which are obtained the module name, child nodes,
\r
387 * uses and is derived package name
\r
388 * @return <code>GeneratedType</code> which is internal representation of
\r
390 * @throws IllegalArgumentException
\r
391 * if the module equals null
\r
394 private def GeneratedTypeBuilder moduleToDataType(Module module) {
395 checkArgument(module !== null, "Module reference cannot be NULL.");
397 val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
398 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
399 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
400 return moduleDataTypeBuilder;
404 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
\r
405 * to the list of <code>Type</code> objects. In addition are to containers
\r
406 * and lists which belong to input or output also part of returning list.
\r
409 * module from which is obtained set of all rpc objects to
\r
410 * iterate over them
\r
411 * @throws IllegalArgumentException
\r
413 * <li>if the module equals null</li>
\r
414 * <li>if the name of module equals null</li>
\r
415 * <li>if the set of child nodes equals null</li>
\r
419 private def void rpcMethodsToGenType(Module module) {
420 checkArgument(module !== null, "Module reference cannot be NULL.");
421 checkArgument(module.name !== null, "Module name cannot be NULL.");
422 checkArgument(module.childNodes !== null,
423 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
425 val basePackageName = moduleNamespaceToPackageName(module);
426 val Set<RpcDefinition> rpcDefinitions = module.rpcs;
427 if (rpcDefinitions.isEmpty()) {
431 val interfaceBuilder = moduleTypeBuilder(module, "Service");
432 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
433 for (rpc : rpcDefinitions) {
435 val rpcName = BindingMapping.getClassName(rpc.QName);
436 val rpcMethodName = parseToValidParamName(rpcName);
437 val method = interfaceBuilder.addMethod(rpcMethodName);
438 val input = rpc.input;
439 val output = rpc.output;
441 if (input !== null) {
442 val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
443 addImplementedInterfaceFromUses(input, inType);
444 inType.addImplementsType(DATA_OBJECT);
445 inType.addImplementsType(augmentable(inType));
446 resolveDataSchemaNodes(module, basePackageName, inType, inType, input.childNodes);
447 genCtx.get(module).addChildNodeType(input.path, inType)
448 val inTypeInstance = inType.toInstance();
449 method.addParameter(inTypeInstance, "input");
452 var Type outTypeInstance = VOID;
453 if (output !== null) {
454 val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
455 addImplementedInterfaceFromUses(output, outType);
456 outType.addImplementsType(DATA_OBJECT);
457 outType.addImplementsType(augmentable(outType));
458 resolveDataSchemaNodes(module, basePackageName, outType, outType, output.childNodes);
459 genCtx.get(module).addChildNodeType(output.path, outType)
460 outTypeInstance = outType.toInstance();
463 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
464 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
468 genCtx.get(module).addTopLevelNodeType(interfaceBuilder)
472 * Converts all <b>notifications</b> of the module to the list of
\r
473 * <code>Type</code> objects. In addition are to this list added containers
\r
474 * and lists which are part of this notification.
\r
477 * module from which is obtained set of all notification objects
\r
478 * to iterate over them
\r
479 * @throws IllegalArgumentException
\r
481 * <li>if the module equals null</li>
\r
482 * <li>if the name of module equals null</li>
\r
483 * <li>if the set of child nodes equals null</li>
\r
487 private def void notificationsToGenType(Module module) {
488 checkArgument(module !== null, "Module reference cannot be NULL.");
489 checkArgument(module.name !== null, "Module name cannot be NULL.");
491 if (module.childNodes === null) {
492 throw new IllegalArgumentException(
493 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
495 val notifications = module.notifications;
496 if(notifications.empty) return;
498 val listenerInterface = moduleTypeBuilder(module, "Listener");
499 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
500 val basePackageName = moduleNamespaceToPackageName(module);
502 for (notification : notifications) {
503 if (notification !== null) {
504 processUsesAugments(notification, module);
506 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification,
507 BindingTypes.DATA_OBJECT);
508 notificationInterface.addImplementsType(NOTIFICATION);
509 genCtx.get(module).addChildNodeType(notification.path, notificationInterface)
511 // Notification object
\r
512 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
513 notification.childNodes);
515 listenerInterface.addMethod("on" + notificationInterface.name) //
\r
516 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
517 setReturnType(Types.VOID);
521 genCtx.get(module).addTopLevelNodeType(listenerInterface)
525 * Converts all <b>identities</b> of the module to the list of
\r
526 * <code>Type</code> objects.
\r
529 * module from which is obtained set of all identity objects to
\r
530 * iterate over them
\r
532 * schema context only used as input parameter for method
\r
533 * {@link identityToGenType}
\r
536 private def void allIdentitiesToGenTypes(Module module, SchemaContext context) {
537 val Set<IdentitySchemaNode> schemaIdentities = module.identities;
538 val basePackageName = moduleNamespaceToPackageName(module);
540 if (schemaIdentities !== null && !schemaIdentities.isEmpty()) {
541 for (identity : schemaIdentities) {
542 identityToGenType(module, basePackageName, identity, context);
548 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
\r
549 * created transport object builder. If identity contains base identity then
\r
550 * reference to base identity is added to superior identity as its extend.
\r
551 * If identity doesn't contain base identity then only reference to abstract
\r
552 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
\r
553 * BaseIdentity} is added
\r
555 * @param module current module
\r
556 * @param basePackageName
\r
557 * string contains the module package name
\r
559 * IdentitySchemaNode which contains data about identity
\r
561 * SchemaContext which is used to get package and name
\r
562 * information about base of identity
\r
565 private def void identityToGenType(Module module, String basePackageName, IdentitySchemaNode identity,
566 SchemaContext context) {
567 if (identity === null) {
570 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
571 val genTypeName = BindingMapping.getClassName(identity.QName);
572 val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
573 val baseIdentity = identity.baseIdentity;
574 if (baseIdentity === null) {
575 newType.setExtendsType(Types.baseIdentityTO);
577 val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
578 val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
579 val returnTypeName = BindingMapping.getClassName(baseIdentity.QName);
580 val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
581 newType.setExtendsType(gto);
583 newType.setAbstract(true);
\r
584 val qname = identity.QName;
\r
586 newType.qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,qname);
\r
588 genCtx.get(module).addIdentityType(identity.QName,newType)
591 private static def qnameConstant(GeneratedTypeBuilderBase<?> toBuilder, String constantName, QName name) {
592 toBuilder.addConstant(QName.typeForClass,constantName,'''
\r
593 org.opendaylight.yangtools.yang.common.QName.create("«name.namespace»","«name.formattedRevision»","«name.localName»")
\r
598 * Converts all <b>groupings</b> of the module to the list of
\r
599 * <code>Type</code> objects. Firstly are groupings sorted according mutual
\r
600 * dependencies. At least dependent (independent) groupings are in the list
\r
601 * saved at first positions. For every grouping the record is added to map
\r
602 * {@link BindingGeneratorImpl#allGroupings allGroupings}
\r
606 * @param collection of groupings from which types will be generated
\r
609 private def void groupingsToGenTypes(Module module, Collection<GroupingDefinition> groupings) {
610 val basePackageName = moduleNamespaceToPackageName(module);
611 val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
613 for (grouping : groupingsSortedByDependencies) {
614 groupingToGenType(basePackageName, grouping, module);
619 * Converts individual grouping to GeneratedType. Firstly generated type
\r
620 * builder is created and every child node of grouping is resolved to the
\r
623 * @param basePackageName
\r
624 * string contains the module package name
\r
626 * GroupingDefinition which contains data about grouping
\r
627 * @param module current module
\r
628 * @return GeneratedType which is generated from grouping (object of type
\r
629 * <code>GroupingDefinition</code>)
\r
631 private def void groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
632 val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
633 val genType = addDefaultInterfaceDefinition(packageName, grouping);
634 genCtx.get(module).addGroupingType(grouping.path, genType)
635 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.childNodes);
636 groupingsToGenTypes(module, grouping.groupings);
637 processUsesAugments(grouping, module);
641 * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
\r
642 * type of <code>typeDefinition</code> is of the type ExtendedType then this
\r
643 * method is recursively called with this base type.
\r
645 * @param typeDefinition
\r
646 * TypeDefinition in which should be EnumTypeDefinition found as
\r
648 * @return EnumTypeDefinition if it is found inside
\r
649 * <code>typeDefinition</code> or <code>null</code> in other case
\r
651 private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
652 if (typeDefinition !== null) {
653 if (typeDefinition.baseType instanceof EnumTypeDefinition) {
654 return typeDefinition.baseType as EnumTypeDefinition;
655 } else if (typeDefinition.baseType instanceof ExtendedType) {
656 return enumTypeDefFromExtendedType(typeDefinition.baseType);
663 * Adds enumeration builder created from <code>enumTypeDef</code> to
\r
664 * <code>typeBuilder</code>.
\r
666 * Each <code>enumTypeDef</code> item is added to builder with its name and
\r
669 * @param enumTypeDef
\r
670 * EnumTypeDefinition contains enum data
\r
672 * string contains name which will be assigned to enumeration
\r
674 * @param typeBuilder
\r
675 * GeneratedTypeBuilder to which will be enum builder assigned
\r
676 * @return enumeration builder which contains data from
\r
677 * <code>enumTypeDef</code>
\r
679 private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, QName enumName,
680 GeneratedTypeBuilder typeBuilder) {
681 if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
682 (enumTypeDef.QName.localName !== null)) {
683 val enumerationName = BindingMapping.getClassName(enumName);
684 val enumBuilder = typeBuilder.addEnumeration(enumerationName);
685 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
692 * Generates type builder for <code>module</code>.
\r
695 * Module which is source of package name for generated type
\r
698 * string which is added to the module class name representation
\r
700 * @return instance of GeneratedTypeBuilder which represents
\r
701 * <code>module</code>.
\r
702 * @throws IllegalArgumentException
\r
703 * if <code>module</code> equals null
\r
705 private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
706 checkArgument(module !== null, "Module reference cannot be NULL.");
707 val packageName = moduleNamespaceToPackageName(module);
708 val moduleName = BindingMapping.getClassName(module.name) + postfix;
709 return new GeneratedTypeBuilderImpl(packageName, moduleName);
713 * Converts <code>augSchema</code> to list of <code>Type</code> which
\r
714 * contains generated type for augmentation. In addition there are also
\r
715 * generated types for all containers, list and choices which are child of
\r
716 * <code>augSchema</code> node or a generated types for cases are added if
\r
717 * augmented node is choice.
\r
719 * @param augmentPackageName
\r
720 * string with the name of the package to which the augmentation
\r
723 * AugmentationSchema which is contains data about augmentation
\r
724 * (target path, childs...)
\r
725 * @param module current module
\r
726 * @param parentUsesNode parent uses node of this augment (can be null if this augment is not defined under uses statement)
\r
727 * @throws IllegalArgumentException
\r
729 * <li>if <code>augmentPackageName</code> equals null</li>
\r
730 * <li>if <code>augSchema</code> equals null</li>
\r
731 * <li>if target path of <code>augSchema</code> equals null</li>
\r
734 private def void augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
735 UsesNode parentUsesNode) {
736 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
737 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
738 checkState(augSchema.targetPath !== null,
739 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
741 processUsesAugments(augSchema, module);
743 val targetPath = augSchema.targetPath;
744 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
\r
745 if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
746 if (parentUsesNode == null) {
747 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
749 targetSchemaNode = findOriginalTargetFromGrouping(targetSchemaNode.QName.localName, parentUsesNode);
751 if (targetSchemaNode == null) {
752 throw new NullPointerException(
753 "Failed to find target node from grouping for augmentation " + augSchema + " in module " +
758 if (targetSchemaNode == null) {
\r
759 throw new IllegalArgumentException("augment target not found")
\r
762 if (targetSchemaNode !== null) {
763 var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
764 if (targetTypeBuilder === null) {
765 targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
767 if (targetTypeBuilder === null) {
768 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
770 if (!(targetSchemaNode instanceof ChoiceNode)) {
771 var packageName = augmentPackageName;
772 if (parentUsesNode != null) {
773 packageName = packageNameForGeneratedType(augmentPackageName, augSchema.targetPath);
775 val augTypeBuilder = addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
776 targetTypeBuilder.toInstance, augSchema);
777 genCtx.get(module).addAugmentType(augTypeBuilder)
\r
778 genCtx.get(module).addTypeToAugmentation(augTypeBuilder,augSchema);
780 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
781 targetSchemaNode as ChoiceNode, augSchema.childNodes);
787 * Utility method which search for original node defined in grouping.
\r
789 private def DataSchemaNode findOriginal(DataSchemaNode node) {
790 var DataSchemaNode result = findCorrectTargetFromGrouping(node);
791 if (result == null) {
792 result = findCorrectTargetFromAugment(node);
793 if (result != null) {
794 if (result.addedByUses) {
795 result = findOriginal(result);
802 private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
803 if (!node.augmenting) {
807 var String currentName = node.QName.localName
\r
808 var Object currentNode = node
809 var Object parent = node;
\r
810 val tmpPath = new ArrayList<String>()
\r
811 val tmpTree = new ArrayList<SchemaNode>()
\r
813 var AugmentationSchema augment = null;
815 val SchemaPath sp = (parent as SchemaNode).path
\r
816 val List<QName> names = sp.path
\r
817 val List<QName> newNames = new ArrayList(names)
\r
818 newNames.remove(newNames.size - 1)
\r
819 val SchemaPath newSp = new SchemaPath(newNames, sp.absolute)
\r
820 parent = findDataSchemaNode(schemaContext, newSp)
\r
821 if (parent instanceof AugmentationTarget) {
822 tmpPath.add(currentName);
\r
823 tmpTree.add(currentNode as SchemaNode)
\r
824 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
825 if (augment == null) {
826 currentName = (parent as DataSchemaNode).QName.localName;
\r
830 } while ((parent as DataSchemaNode).augmenting && augment == null);
832 if (augment == null) {
835 Collections.reverse(tmpPath);
\r
836 Collections.reverse(tmpTree);
837 var Object actualParent = augment;
838 var DataSchemaNode result = null;
839 for (name : tmpPath) {
840 if (actualParent instanceof DataNodeContainer) {
841 result = (actualParent as DataNodeContainer).getDataChildByName(name);
842 actualParent = (actualParent as DataNodeContainer).getDataChildByName(name);
844 if (actualParent instanceof ChoiceNode) {
845 result = (actualParent as ChoiceNode).getCaseNodeByName(name);
846 actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name);
851 if (result.addedByUses) {
\r
852 result = findCorrectTargetFromAugmentGrouping(result, augment, tmpTree);
859 private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, String name) {
860 for (augment : augments) {
861 if (augment.getDataChildByName(name) != null) {
868 private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {
\r
869 if (node.path.path.size == 1) {
\r
870 // uses is under module statement
\r
871 val Module m = findParentModule(schemaContext, node);
\r
872 var DataSchemaNode result = null;
\r
874 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
\r
875 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
876 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
\r
878 var gr = targetGrouping as GroupingDefinition;
\r
879 result = gr.getDataChildByName(node.QName.localName);
\r
881 if (result == null) {
\r
882 throw new IllegalArgumentException("Failed to generate code for augment")
\r
886 var DataSchemaNode result = null;
\r
887 var String currentName = node.QName.localName
\r
888 var tmpPath = new ArrayList<String>()
\r
889 var Object parent = null
\r
891 val SchemaPath sp = node.path
892 val List<QName> names = sp.path
893 val List<QName> newNames = new ArrayList(names)
894 newNames.remove(newNames.size - 1)
895 val SchemaPath newSp = new SchemaPath(newNames, sp.absolute)
896 parent = findDataSchemaNode(schemaContext, newSp)
899 tmpPath.add(currentName);
\r
900 val dataNodeParent = parent as DataNodeContainer;
\r
901 for (u : dataNodeParent.uses) {
\r
902 if (result == null) {
\r
903 result = getResultFromUses(u, currentName)
\r
906 if (result == null) {
907 currentName = (parent as SchemaNode).QName.localName
908 if (parent instanceof DataSchemaNode) {
909 val SchemaPath nodeSp = (parent as DataSchemaNode).path
910 val List<QName> nodeNames = nodeSp.path
911 val List<QName> nodeNewNames = new ArrayList(nodeNames)
912 nodeNewNames.remove(nodeNewNames.size - 1)
913 if (nodeNewNames.empty) {
914 parent = getParentModule(parent as SchemaNode)
916 val SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.absolute)
917 parent = findDataSchemaNode(schemaContext, nodeNewSp)
920 throw new IllegalArgumentException("Failed to generate code for augment")
923 } while (result == null && !(parent instanceof Module));
\r
925 if (result != null) {
\r
926 result = getTargetNode(tmpPath, result)
\r
932 private def DataSchemaNode findCorrectTargetFromAugmentGrouping(DataSchemaNode node, AugmentationSchema parentNode,
933 List<SchemaNode> dataTree) {
\r
935 var DataSchemaNode result = null;
936 var String currentName = node.QName.localName
937 var tmpPath = new ArrayList<String>()
\r
938 tmpPath.add(currentName)
\r
940 var Object parent = null
943 if (dataTree.size < 2 || dataTree.size == i) {
946 parent = dataTree.get(dataTree.size - (i+1))
947 tmpPath.add((parent as SchemaNode).QName.localName);
950 val dataNodeParent = parent as DataNodeContainer;
951 for (u : dataNodeParent.uses) {
952 if (result == null) {
\r
953 result = getResultFromUses(u, currentName)
956 if (result == null) {
958 currentName = (parent as SchemaNode).QName.localName
960 } while (result == null);
962 if (result != null) {
963 result = getTargetNode(tmpPath, result)
\r
968 private def getResultFromUses(UsesNode u, String currentName) {
969 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path)
970 if (!(targetGrouping instanceof GroupingDefinition)) {
971 throw new IllegalArgumentException("Failed to generate code for augment in " + u)
973 var gr = targetGrouping as GroupingDefinition
974 return gr.getDataChildByName(currentName)
977 private def getTargetNode(List<String> tmpPath, DataSchemaNode node) {
978 var DataSchemaNode result = node
979 if (tmpPath.size == 1) {
980 if (result != null && result.addedByUses) {
981 result = findOriginal(result);
985 var DataSchemaNode newParent = result;
986 Collections.reverse(tmpPath);
989 for (name : tmpPath) {
990 newParent = (newParent as DataNodeContainer).getDataChildByName(name);
992 if (newParent != null && newParent.addedByUses) {
993 newParent = findOriginal(newParent);
1001 * Convenient method to find node added by uses statement.
\r
1003 private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
1004 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
1005 if (!(targetGrouping instanceof GroupingDefinition)) {
1006 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
1009 var grouping = targetGrouping as GroupingDefinition;
1010 var result = grouping.getDataChildByName(targetSchemaNodeName);
1011 if (result == null) {
1014 var boolean fromUses = result.addedByUses;
1016 var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
1018 if (groupingUses.hasNext()) {
1019 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
1020 result = grouping.getDataChildByName(targetSchemaNodeName);
1021 fromUses = result.addedByUses;
1023 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
1031 * Returns a generated type builder for an augmentation.
\r
1033 * The name of the type builder is equal to the name of augmented node with
\r
1034 * serial number as suffix.
\r
1036 * @param module current module
\r
1037 * @param augmentPackageName
\r
1038 * string with contains the package name to which the augment
\r
1040 * @param basePackageName
\r
1041 * string with the package name to which the augmented node
\r
1043 * @param targetTypeRef
\r
1045 * @param augSchema
\r
1046 * augmentation schema which contains data about the child nodes
\r
1047 * and uses of augment
\r
1048 * @return generated type builder for augment
\r
1050 private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
1051 String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
1052 var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
1053 if (augmentBuilders === null) {
1054 augmentBuilders = new HashMap();
1055 genTypeBuilders.put(augmentPackageName, augmentBuilders);
1057 val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
1059 val augTypeName = if (augIdentifier !== null) {
1060 BindingMapping.getClassName(augIdentifier)
1062 augGenTypeName(augmentBuilders, targetTypeRef.name);
1065 val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
1067 augTypeBuilder.addImplementsType(DATA_OBJECT);
1068 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
1069 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
1071 augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
1072 augmentBuilders.put(augTypeName, augTypeBuilder);
1073 return augTypeBuilder;
1078 * @param unknownSchemaNodes
\r
1079 * @return nodeParameter of UnknownSchemaNode
\r
1081 private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
1082 for (unknownSchemaNode : unknownSchemaNodes) {
1083 val nodeType = unknownSchemaNode.nodeType;
1084 if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
1085 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
1086 return unknownSchemaNode.nodeParameter;
1093 * Returns first unique name for the augment generated type builder. The
\r
1094 * generated type builder name for augment consists from name of augmented
\r
1095 * node and serial number of its augmentation.
\r
1098 * map of builders which were created in the package to which the
\r
1099 * augmentation belongs
\r
1100 * @param genTypeName
\r
1101 * string with name of augmented node
\r
1102 * @return string with unique name for augmentation builder
\r
1104 private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
1106 while ((builders !== null) && builders.containsKey(genTypeName + index)) {
1109 return genTypeName + index;
1113 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
\r
1114 * node for which <code>typeBuilder</code> was created.
\r
1116 * The subnodes aren't mapped to the methods if they are part of grouping or
\r
1117 * augment (in this case are already part of them).
\r
1119 * @param module current module
\r
1120 * @param basePackageName
\r
1121 * string contains the module package name
\r
1123 * generated type builder which represents any node. The subnodes
\r
1124 * of this node are added to the <code>typeBuilder</code> as
\r
1125 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1126 * container, choice.
\r
1127 * @param childOf parent type
\r
1128 * @param schemaNodes
\r
1129 * set of data schema nodes which are the children of the node
\r
1130 * for which <code>typeBuilder</code> was created
\r
1131 * @return generated type builder which is the same builder as input
\r
1132 * parameter. The getter methods (representing child nodes) could be
\r
1135 private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
1136 GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1137 if ((schemaNodes !== null) && (parent !== null)) {
1138 for (schemaNode : schemaNodes) {
1139 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
1140 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1148 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
\r
1149 * node for which <code>typeBuilder</code> was created.
\r
1151 * @param module current module
\r
1152 * @param basePackageName
\r
1153 * string contains the module package name
\r
1154 * @param typeBuilder
\r
1155 * generated type builder which represents any node. The subnodes
\r
1156 * of this node are added to the <code>typeBuilder</code> as
\r
1157 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1158 * container, choice.
\r
1159 * @param childOf parent type
\r
1160 * @param schemaNodes
\r
1161 * set of data schema nodes which are the children of the node
\r
1162 * for which <code>typeBuilder</code> was created
\r
1163 * @return generated type builder which is the same object as the input
\r
1164 * parameter <code>typeBuilder</code>. The getter method could be
\r
1167 private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1168 GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1169 if ((schemaNodes !== null) && (typeBuilder !== null)) {
1170 for (schemaNode : schemaNodes) {
1171 if (!schemaNode.isAugmenting()) {
1172 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1180 * Adds to <code>typeBuilder</code> a method which is derived from
\r
1181 * <code>schemaNode</code>.
\r
1183 * @param basePackageName
\r
1184 * string with the module package name
\r
1186 * data schema node which is added to <code>typeBuilder</code> as
\r
1188 * @param typeBuilder
\r
1189 * generated type builder to which is <code>schemaNode</code>
\r
1190 * added as a method.
\r
1191 * @param childOf parent type
\r
1192 * @param module current module
\r
1194 private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1195 GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1196 if (node !== null && typeBuilder !== null) {
1198 case node instanceof LeafSchemaNode:
1199 resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1200 case node instanceof LeafListSchemaNode:
1201 resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1202 case node instanceof ContainerSchemaNode:
1203 containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1204 case node instanceof ListSchemaNode:
1205 listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1206 case node instanceof ChoiceNode:
1207 choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1213 * Converts <code>choiceNode</code> to the list of generated types for
\r
1214 * choice and its cases.
\r
1216 * The package names for choice and for its cases are created as
\r
1217 * concatenation of the module package (<code>basePackageName</code>) and
\r
1218 * names of all parents node.
\r
1220 * @param module current module
\r
1221 * @param basePackageName
\r
1222 * string with the module package name
\r
1223 * @param parent parent type
\r
1224 * @param childOf concrete parent for case child nodes
\r
1225 * @param choiceNode
\r
1226 * choice node which is mapped to generated type. Also child
\r
1227 * nodes - cases are mapped to generated types.
\r
1228 * @throws IllegalArgumentException
\r
1230 * <li>if <code>basePackageName</code> equals null</li>
\r
1231 * <li>if <code>choiceNode</code> equals null</li>
\r
1235 private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1236 ChoiceNode choiceNode) {
1237 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1238 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1240 if (!choiceNode.addedByUses) {
1241 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1242 val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1243 constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1244 choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1245 genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1246 generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1251 * Converts <code>caseNodes</code> set to list of corresponding generated
\r
1254 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
\r
1255 * created generated type builder. The package names for the builder is
\r
1256 * created as concatenation of the module package (
\r
1257 * <code>basePackageName</code>) and names of all parents nodes of the
\r
1258 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
\r
1259 * between every case builder and <i>choice</i> type
\r
1261 * @param basePackageName
\r
1262 * string with the module package name
\r
1263 * @param refChoiceType
\r
1264 * type which represents superior <i>case</i>
\r
1265 * @param caseNodes
\r
1266 * set of choice case nodes which are mapped to generated types
\r
1267 * @return list of generated types for <code>caseNodes</code>.
\r
1268 * @throws IllegalArgumentException
\r
1270 * <li>if <code>basePackageName</code> equals null</li>
\r
1271 * <li>if <code>refChoiceType</code> equals null</li>
\r
1272 * <li>if <code>caseNodes</code> equals null</li>
\r
1276 private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1277 GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1278 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1279 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1280 checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1282 val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1283 if (caseNodes == null) {
1287 for (caseNode : caseNodes) {
1288 if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1289 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1290 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1291 caseTypeBuilder.addImplementsType(refChoiceType)
1292 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1293 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1294 if (caseChildNodes !== null) {
1295 var Object parentNode = null
\r
1296 val SchemaPath nodeSp = choiceNode.path
\r
1297 val List<QName> nodeNames = nodeSp.path
\r
1298 val List<QName> nodeNewNames = new ArrayList(nodeNames)
\r
1299 nodeNewNames.remove(nodeNewNames.size - 1)
\r
1300 val SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.absolute)
\r
1301 parentNode = findDataSchemaNode(schemaContext, nodeNewSp)
\r
1303 var SchemaNode parent
1304 if (parentNode instanceof AugmentationSchema) {
1305 val augSchema = parentNode as AugmentationSchema;
1306 val targetPath = augSchema.targetPath;
1307 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1308 if (targetSchemaNode instanceof DataSchemaNode &&
1309 (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1310 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
1311 if (targetSchemaNode == null) {
1312 throw new NullPointerException(
1313 "Failed to find target node from grouping for augmentation " + augSchema +
1314 " in module " + module.name);
1317 parent = targetSchemaNode
1319 val SchemaPath sp = choiceNode.path
\r
1320 val List<QName> names = sp.path
\r
1321 val List<QName> newNames = new ArrayList(names)
\r
1322 newNames.remove(newNames.size - 1)
\r
1323 val SchemaPath newSp = new SchemaPath(newNames, sp.absolute)
\r
1324 parent = findDataSchemaNode(schemaContext, newSp)
\r
1326 var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1327 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1331 processUsesAugments(caseNode, module);
1336 * Generates list of generated types for all the cases of a choice which are
\r
1337 * added to the choice through the augment.
\r
1340 * @param basePackageName
\r
1341 * string contains name of package to which augment belongs. If
\r
1342 * an augmented choice is from an other package (pcg1) than an
\r
1343 * augmenting choice (pcg2) then case's of the augmenting choice
\r
1344 * will belong to pcg2.
\r
1345 * @param refChoiceType
\r
1346 * Type which represents the choice to which case belongs. Every
\r
1347 * case has to contain its choice in extend part.
\r
1348 * @param caseNodes
\r
1349 * set of choice case nodes for which is checked if are/aren't
\r
1350 * added to choice through augmentation
\r
1351 * @return list of generated types which represents augmented cases of
\r
1352 * choice <code>refChoiceType</code>
\r
1353 * @throws IllegalArgumentException
\r
1355 * <li>if <code>basePackageName</code> equals null</li>
\r
1356 * <li>if <code>refChoiceType</code> equals null</li>
\r
1357 * <li>if <code>caseNodes</code> equals null</li>
\r
1360 private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1361 ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1362 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1363 checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1364 checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1366 for (caseNode : augmentedNodes) {
1367 if (caseNode !== null) {
1368 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1369 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1370 caseTypeBuilder.addImplementsType(targetType);
1372 var SchemaNode parent = null
\r
1373 val SchemaPath nodeSp = targetNode.path
\r
1374 val List<QName> nodeNames = nodeSp.path
\r
1375 val List<QName> nodeNewNames = new ArrayList(nodeNames)
\r
1376 nodeNewNames.remove(nodeNewNames.size - 1)
\r
1377 val SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.absolute)
\r
1378 parent = findDataSchemaNode(schemaContext, nodeNewSp)
\r
1380 var GeneratedTypeBuilder childOfType = null;
1381 if (parent instanceof Module) {
1382 childOfType = genCtx.get(parent as Module).moduleNode
1383 } else if (parent instanceof ChoiceCaseNode) {
1384 childOfType = findCaseByPath(parent.path)
1385 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1386 childOfType = findChildNodeByPath(parent.path)
1387 } else if (parent instanceof GroupingDefinition) {
1388 childOfType = findGroupingByPath(parent.path);
1391 if (childOfType == null) {
1392 throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1395 if (caseNode instanceof DataNodeContainer) {
1396 val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
1397 val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
1398 if (childNodes !== null) {
1399 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1402 val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1403 val Set<DataSchemaNode> childNodes = node.childNodes;
1404 if (childNodes !== null) {
1405 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1409 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1416 * Converts <code>leaf</code> to the getter method which is added to
\r
1417 * <code>typeBuilder</code>.
\r
1419 * @param typeBuilder
\r
1420 * generated type builder to which is added getter method as
\r
1421 * <code>leaf</code> mapping
\r
1423 * leaf schema node which is mapped as getter method which is
\r
1424 * added to <code>typeBuilder</code>
\r
1425 * @return boolean value
\r
1427 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
\r
1429 * <li>true - in other cases</li>
\r
1432 private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1433 if ((leaf !== null) && (typeBuilder !== null)) {
1434 val leafName = leaf.QName.localName;
1435 var String leafDesc = leaf.description;
1436 if (leafDesc === null) {
1440 val parentModule = findParentModule(schemaContext, leaf);
1441 if (leafName !== null && !leaf.isAddedByUses()) {
1442 val TypeDefinition<?> typeDef = leaf.type;
1444 var Type returnType = null;
1445 var GeneratedTOBuilder genTOBuilder;
1446 if (typeDef instanceof EnumTypeDefinition) {
1447 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1448 val enumTypeDef = typeDef as EnumTypeDefinition;
1449 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.QName, typeBuilder);
1451 if (enumBuilder !== null) {
1452 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1454 (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1455 } else if (typeDef instanceof UnionType) {
1456 genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
\r
1457 if (genTOBuilder !== null) {
\r
1458 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)
\r
1460 } else if (typeDef instanceof BitsTypeDefinition) {
1461 genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
\r
1462 if (genTOBuilder !== null) {
\r
1463 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1466 val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1467 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1469 if (returnType !== null) {
1470 val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1471 processContextRefExtension(leaf, getter, parentModule);
1479 private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1480 for (node : leaf.unknownSchemaNodes) {
1481 val nodeType = node.nodeType;
1482 if ("context-reference".equals(nodeType.localName)) {
1483 val nodeParam = node.nodeParameter;
1484 var IdentitySchemaNode identity = null;
1485 var String basePackageName = null;
1486 val String[] splittedElement = nodeParam.split(":");
1487 if (splittedElement.length == 1) {
1488 identity = findIdentityByName(module.identities, splittedElement.get(0));
1489 basePackageName = moduleNamespaceToPackageName(module);
1490 } else if (splittedElement.length == 2) {
1491 var prefix = splittedElement.get(0);
1492 val Module dependentModule = findModuleFromImports(module.imports, prefix)
1493 if (dependentModule == null) {
1494 throw new IllegalArgumentException(
1495 "Failed to process context-reference: unknown prefix " + prefix);
1497 identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1498 basePackageName = moduleNamespaceToPackageName(dependentModule);
1500 throw new IllegalArgumentException(
1501 "Failed to process context-reference: unknown identity " + nodeParam);
1503 if (identity == null) {
1504 throw new IllegalArgumentException(
1505 "Failed to process context-reference: unknown identity " + nodeParam);
1508 val Class<RoutingContext> clazz = typeof(RoutingContext);
1509 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1510 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1511 val genTypeName = BindingMapping.getClassName(identity.QName.localName);
1512 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1517 private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1518 for (id : identities) {
1519 if (id.QName.localName.equals(name)) {
1526 private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1527 for (imp : imports) {
1528 if (imp.prefix.equals(prefix)) {
1529 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1536 * Converts <code>leaf</code> schema node to property of generated TO
\r
1539 * @param toBuilder
\r
1540 * generated TO builder to which is <code>leaf</code> added as
\r
1543 * leaf schema node which is added to <code>toBuilder</code> as
\r
1545 * @param isReadOnly
\r
1546 * boolean value which says if leaf property is|isn't read only
\r
1547 * @return boolean value
\r
1549 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
\r
1550 * name equals null or if leaf is added by <i>uses</i>.</li>
\r
1551 * <li>true - other cases</li>
\r
1554 private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1555 boolean isReadOnly) {
1556 if ((leaf !== null) && (toBuilder !== null)) {
1557 val leafName = leaf.QName.localName;
1558 var String leafDesc = leaf.description;
1559 if (leafDesc === null) {
1563 if (leafName !== null) {
1564 val TypeDefinition<?> typeDef = leaf.type;
1566 // TODO: properly resolve enum types
\r
1567 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1568 if (returnType !== null) {
1569 val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1570 propBuilder.setReadOnly(isReadOnly);
1571 propBuilder.setReturnType(returnType);
1572 propBuilder.setComment(leafDesc);
1573 toBuilder.addEqualsIdentity(propBuilder);
1574 toBuilder.addHashIdentity(propBuilder);
1575 toBuilder.addToStringProperty(propBuilder);
1584 * Converts <code>node</code> leaf list schema node to getter method of
\r
1585 * <code>typeBuilder</code>.
\r
1587 * @param typeBuilder
\r
1588 * generated type builder to which is <code>node</code> added as
\r
1591 * leaf list schema node which is added to
\r
1592 * <code>typeBuilder</code> as getter method
\r
1593 * @return boolean value
\r
1595 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
\r
1596 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
\r
1597 * <li>false - other cases</li>
\r
1600 private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1601 if ((node !== null) && (typeBuilder !== null)) {
1602 val nodeName = node.QName;
1603 var String nodeDesc = node.description;
1604 if (nodeDesc === null) {
1607 if (nodeName !== null && !node.isAddedByUses()) {
1608 val TypeDefinition<?> typeDef = node.type;
\r
1609 val parentModule = findParentModule(schemaContext, node);
\r
1611 var Type returnType = null;
\r
1612 if (typeDef instanceof EnumTypeDefinition) {
\r
1613 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
\r
1614 val enumTypeDef = typeDef as EnumTypeDefinition;
\r
1615 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, typeBuilder);
\r
1616 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
\r
1617 (typeProvider as TypeProviderImpl).putReferencedType(node.path, returnType);
\r
1618 } else if (typeDef instanceof UnionType) {
\r
1619 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
\r
1620 if (genTOBuilder !== null) {
\r
1621 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)
\r
1623 } else if (typeDef instanceof BitsTypeDefinition) {
\r
1624 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
\r
1625 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1627 val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
\r
1628 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
\r
1631 val listType = Types.listTypeFor(returnType);
1632 constructGetter(typeBuilder, nodeName.localName, nodeDesc, listType);
1639 private def Type createReturnTypeForUnion(GeneratedTOBuilder genTOBuilder, TypeDefinition<?> typeDef,
1640 GeneratedTypeBuilder typeBuilder, Module parentModule) {
1641 val Type returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1642 genTOBuilder.setTypedef(true);
1643 genTOBuilder.setIsUnion(true);
1644 (typeProvider as TypeProviderImpl).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1647 val GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
1648 genTOBuilder.getName() + "Builder");
1649 unionBuilder.setIsUnionBuilder(true);
1650 val MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1651 method.setReturnType(returnType);
1652 method.addParameter(Types.STRING, "defaultValue");
1653 method.setAccessModifier(AccessModifier.PUBLIC);
1654 method.setStatic(true);
1656 val Set<Type> types = (typeProvider as TypeProviderImpl).additionalTypes.get(parentModule);
1657 if (types == null) {
1658 (typeProvider as TypeProviderImpl).additionalTypes.put(parentModule,
1659 Sets.newHashSet(unionBuilder.toInstance))
1661 types.add(unionBuilder.toInstance)
1666 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1667 return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1671 * Instantiates generated type builder with <code>packageName</code> and
\r
1672 * <code>schemaNode</code>.
\r
1674 * The new builder always implements
\r
1675 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
\r
1676 * If <code>schemaNode</code> is instance of GroupingDefinition it also
\r
1677 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
\r
1678 * Augmentable}.<br />
\r
1679 * If <code>schemaNode</code> is instance of
\r
1680 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
\r
1681 * DataNodeContainer} it can also implement nodes which are specified in
\r
1684 * @param packageName
\r
1685 * string with the name of the package to which
\r
1686 * <code>schemaNode</code> belongs.
\r
1687 * @param schemaNode
\r
1688 * schema node for which is created generated type builder
\r
1689 * @param parent parent type (can be null)
\r
1690 * @return generated type builder <code>schemaNode</code>
\r
1692 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1694 val it = addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1695 qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,schemaNode.QName);
\r
1696 if (parent === null) {
1697 addImplementsType(DATA_OBJECT);
1699 addImplementsType(BindingTypes.childOf(parent));
1701 if (!(schemaNode instanceof GroupingDefinition)) {
1702 addImplementsType(augmentable(it));
1705 if (schemaNode instanceof DataNodeContainer) {
1706 addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1713 * Wraps the calling of the same overloaded method.
\r
1715 * @param packageName
\r
1716 * string with the package name to which returning generated type
\r
1718 * @param schemaNode
\r
1719 * schema node which provide data about the schema node name
\r
1720 * @return generated type builder for <code>schemaNode</code>
\r
1722 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1723 return addRawInterfaceDefinition(packageName, schemaNode, "");
1727 * Returns reference to generated type builder for specified
\r
1728 * <code>schemaNode</code> with <code>packageName</code>.
\r
1730 * Firstly the generated type builder is searched in
\r
1731 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
\r
1732 * found it is created and added to <code>genTypeBuilders</code>.
\r
1734 * @param packageName
\r
1735 * string with the package name to which returning generated type
\r
1737 * @param schemaNode
\r
1738 * schema node which provide data about the schema node name
\r
1739 * @param prefix return type name prefix
\r
1740 * @return generated type builder for <code>schemaNode</code>
\r
1741 * @throws IllegalArgumentException
\r
1743 * <li>if <code>schemaNode</code> equals null</li>
\r
1744 * <li>if <code>packageName</code> equals null</li>
\r
1745 * <li>if Q name of schema node is null</li>
\r
1746 * <li>if schema node name is null</li>
\r
1750 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1752 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1753 checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1754 checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1755 val schemaNodeName = schemaNode.QName.localName;
1756 checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1758 var String genTypeName;
1759 if (prefix === null) {
1760 genTypeName = BindingMapping.getClassName(schemaNodeName);
1762 genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1765 //FIXME: Validation of name conflict
\r
1766 val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1767 if (!genTypeBuilders.containsKey(packageName)) {
1768 val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1769 builders.put(genTypeName, newType);
1770 genTypeBuilders.put(packageName, builders);
1772 val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1773 if (!builders.containsKey(genTypeName)) {
1774 builders.put(genTypeName, newType);
1781 * Creates the name of the getter method from <code>methodName</code>.
\r
1783 * @param methodName
\r
1784 * string with the name of the getter method
\r
1785 * @param returnType return type
\r
1786 * @return string with the name of the getter method for
\r
1787 * <code>methodName</code> in JAVA method format
\r
1789 public static def String getterMethodName(String localName, Type returnType) {
1790 val method = new StringBuilder();
1791 if (BOOLEAN.equals(returnType)) {
1792 method.append("is");
1794 method.append("get");
1796 method.append(BindingMapping.getClassName(localName));
1797 return method.toString();
1801 * Created a method signature builder as part of
\r
1802 * <code>interfaceBuilder</code>.
\r
1804 * The method signature builder is created for the getter method of
\r
1805 * <code>schemaNodeName</code>. Also <code>comment</code> and
\r
1806 * <code>returnType</code> information are added to the builder.
\r
1808 * @param interfaceBuilder
\r
1809 * generated type builder for which the getter method should be
\r
1811 * @param schemaNodeName
\r
1812 * string with schema node name. The name will be the part of the
\r
1813 * getter method name.
\r
1815 * string with comment for the getter method
\r
1816 * @param returnType
\r
1817 * type which represents the return type of the getter method
\r
1818 * @return method signature builder which represents the getter method of
\r
1819 * <code>interfaceBuilder</code>
\r
1821 private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1822 String comment, Type returnType) {
1823 val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1824 getMethod.setComment(comment);
1825 getMethod.setReturnType(returnType);
1830 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
\r
1831 * or to <code>genTOBuilder</code> as property.
\r
1833 * @param basePackageName
\r
1834 * string contains the module package name
\r
1835 * @param schemaNode
\r
1836 * data schema node which should be added as getter method to
\r
1837 * <code>typeBuilder</code> or as a property to
\r
1838 * <code>genTOBuilder</code> if is part of the list key
\r
1839 * @param typeBuilder
\r
1840 * generated type builder for the list schema node
\r
1841 * @param genTOBuilder
\r
1842 * generated TO builder for the list keys
\r
1844 * list of string which contains names of the list keys
\r
1845 * @param module current module
\r
1846 * @throws IllegalArgumentException
\r
1848 * <li>if <code>schemaNode</code> equals null</li>
\r
1849 * <li>if <code>typeBuilder</code> equals null</li>
\r
1852 private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1853 GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1854 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1855 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1857 if (schemaNode instanceof LeafSchemaNode) {
1858 val leaf = schemaNode as LeafSchemaNode;
1859 val leafName = leaf.QName.localName;
\r
1860 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1861 if (listKeys.contains(leafName)) {
1862 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
1864 } else if (!schemaNode.addedByUses) {
1865 if (schemaNode instanceof LeafListSchemaNode) {
1866 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1867 } else if (schemaNode instanceof ContainerSchemaNode) {
1868 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1869 } else if (schemaNode instanceof ChoiceNode) {
1870 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1871 } else if (schemaNode instanceof ListSchemaNode) {
1872 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1877 private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1878 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1880 if (genTOBuilder !== null) {
1881 val genTO = genTOBuilder.toInstance();
1882 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1883 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1888 * Selects the names of the list keys from <code>list</code> and returns
\r
1889 * them as the list of the strings
\r
1892 * of string with names of the list keys
\r
1893 * @return list of string which represents names of the list keys. If the
\r
1894 * <code>list</code> contains no keys then the empty list is
\r
1897 private def listKeys(ListSchemaNode list) {
1898 val List<String> listKeys = new ArrayList();
1900 if (list.keyDefinition !== null) {
1901 val keyDefinitions = list.keyDefinition;
1902 for (keyDefinition : keyDefinitions) {
1903 listKeys.add(keyDefinition.localName);
1910 * Generates for the <code>list</code> which contains any list keys special
\r
1911 * generated TO builder.
\r
1913 * @param packageName
\r
1914 * string with package name to which the list belongs
\r
1916 * list schema node which is source of data about the list name
\r
1917 * @return generated TO builder which represents the keys of the
\r
1918 * <code>list</code> or null if <code>list</code> is null or list of
\r
1919 * key definitions is null or empty.
\r
1921 private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1922 var GeneratedTOBuilder genTOBuilder = null;
1923 if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1924 val listName = list.QName.localName + "Key";
1925 val String genTOName = BindingMapping.getClassName(listName);
1926 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1928 return genTOBuilder;
1932 * Builds generated TO builders for <code>typeDef</code> of type
\r
1933 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
\r
1934 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
\r
1935 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
\r
1936 * enclosing transfer object.
\r
1938 * If more then one generated TO builder is created for enclosing then all
\r
1939 * of the generated TO builders are added to <code>typeBuilder</code> as
\r
1940 * enclosing transfer objects.
\r
1943 * type definition which can be of type <code>UnionType</code> or
\r
1944 * <code>BitsTypeDefinition</code>
\r
1945 * @param typeBuilder
\r
1946 * generated type builder to which is added generated TO created
\r
1947 * from <code>typeDef</code>
\r
1949 * string with name for generated TO builder
\r
1951 * @param parentModule
\r
1952 * @return generated TO builder for <code>typeDef</code>
\r
1954 private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
1955 DataSchemaNode leaf, Module parentModule) {
1956 val classNameFromLeaf = BindingMapping.getClassName(leaf.QName);
1957 val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
1958 val packageName = typeBuilder.fullyQualifiedName;
1959 if (typeDef instanceof UnionTypeDefinition) {
\r
1960 val List<GeneratedTOBuilder> types = (typeProvider as TypeProviderImpl).
\r
1961 provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
\r
1962 classNameFromLeaf, leaf);
1963 genTOBuilders.addAll(types);
\r
1966 var GeneratedTOBuilder resultTOBuilder = null;
\r
1967 if (!types.isEmpty()) {
\r
1968 resultTOBuilder = types.remove(0);
\r
1969 for (GeneratedTOBuilder genTOBuilder : types) {
\r
1970 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
\r
1974 val GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
\r
1975 genPropBuilder.setReturnType(Types.primitiveType("char[]", null));
\r
1976 resultTOBuilder.addEqualsIdentity(genPropBuilder);
\r
1977 resultTOBuilder.addHashIdentity(genPropBuilder);
\r
1978 resultTOBuilder.addToStringProperty(genPropBuilder);
\r
1980 } else if (typeDef instanceof BitsTypeDefinition) {
1982 ((typeProvider as TypeProviderImpl) ).
1983 provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
1985 if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
1986 for (genTOBuilder : genTOBuilders) {
1987 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1989 return genTOBuilders.get(0);
1996 * Adds the implemented types to type builder.
\r
1998 * The method passes through the list of <i>uses</i> in
\r
1999 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
\r
2000 * generated type from {@link BindingGeneratorImpl#allGroupings
\r
2001 * allGroupings} which is added as <i>implements type</i> to
\r
2002 * <code>builder</code>
\r
2004 * @param dataNodeContainer
\r
2005 * element which contains the list of used YANG groupings
\r
2007 * builder to which are added implemented types according to
\r
2008 * <code>dataNodeContainer</code>
\r
2009 * @return generated type builder with all implemented types
\r
2011 private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
2012 for (usesNode : dataNodeContainer.uses) {
2013 if (usesNode.groupingPath !== null) {
2014 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
2015 if (genType === null) {
2016 throw new IllegalStateException(
2017 "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
2019 builder.addImplementsType(genType);
2025 private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
2026 for (ctx : genCtx.values) {
2027 var result = ctx.getChildNode(path)
2028 if (result !== null) {
2035 private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
2036 for (ctx : genCtx.values) {
2037 var result = ctx.getGrouping(path)
2038 if (result !== null) {
2045 private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
2046 for (ctx : genCtx.values) {
2047 var result = ctx.getCase(path)
2048 if (result !== null) {
2055 private def Module getParentModule(SchemaNode node) {
\r
2056 val QName qname = node.getPath().getPath().get(0);
\r
2057 val URI namespace = qname.getNamespace();
\r
2058 val Date revision = qname.getRevision();
\r
2059 return schemaContext.findModuleByNamespaceAndRevision(namespace, revision);
\r
2062 public def getModuleContexts() {
\r