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;
\r
10 import java.util.ArrayList;
\r
11 import java.util.Collections;
\r
12 import java.util.HashMap;
\r
13 import java.util.List;
\r
14 import java.util.Map;
\r
15 import java.util.Set;
\r
16 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
\r
17 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
\r
18 import org.opendaylight.yangtools.binding.generator.util.Types;
\r
19 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
\r
20 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
\r
21 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
\r
22 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
\r
23 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
\r
24 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
\r
25 import org.opendaylight.yangtools.sal.binding.model.api.Type;
\r
26 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
\r
27 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
\r
28 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
\r
29 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
\r
30 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
\r
31 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
\r
32 import org.opendaylight.yangtools.yang.binding.RpcService;
\r
33 import org.opendaylight.yangtools.yang.common.RpcResult;
\r
34 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
\r
35 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
\r
36 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
\r
37 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
\r
38 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
\r
39 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
\r
40 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
\r
41 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
\r
42 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
\r
43 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
\r
44 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
\r
45 import org.opendaylight.yangtools.yang.model.api.Module;
\r
46 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
\r
47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
\r
48 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
\r
49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
\r
50 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
\r
51 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
\r
52 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
\r
53 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
\r
54 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
\r
55 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
\r
56 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
\r
57 import org.opendaylight.yangtools.yang.model.util.UnionType;
\r
58 import static com.google.common.base.Preconditions.*;
\r
59 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
\r
60 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
\r
61 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
\r
62 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
\r
63 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort
\r
64 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
\r
66 public class BindingGeneratorImpl implements BindingGenerator {
\r
68 * Outter key represents the package name. Outter value represents map of
\r
69 * all builders in the same package. Inner key represents the schema node
\r
70 * name (in JAVA class/interface name format). Inner value represents
\r
71 * instance of builder for schema node specified in key part.
\r
73 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
\r
76 * Provide methods for converting YANG types to JAVA types.
\r
78 private var TypeProvider typeProvider;
\r
81 * Holds reference to schema context to resolve data of augmented elemnt
\r
82 * when creating augmentation builder
\r
84 private var SchemaContext schemaContext;
\r
87 * Each grouping which is converted from schema node to generated type is
\r
88 * added to this map with its Schema path as key to make it easier to get
\r
89 * reference to it. In schema nodes in <code>uses</code> attribute there is
\r
90 * only Schema Path but when building list of implemented interfaces for
\r
91 * Schema node the object of type <code>Type</code> is required. So in this
\r
92 * case is used this map.
\r
94 private val allGroupings = new HashMap<SchemaPath, GeneratedType>();
\r
96 private val yangToJavaMapping = new HashMap<SchemaPath, Type>();
\r
99 * Constant with the concrete name of namespace.
\r
101 private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
\r
104 * Constant with the concrete name of identifier.
\r
106 private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
\r
109 * Resolves generated types from <code>context</code> schema nodes of all
\r
112 * Generated types are created for modules, groupings, types, containers,
\r
113 * lists, choices, augments, rpcs, notification, identities.
\r
116 * schema context which contains data about all schema nodes
\r
118 * @return list of types (usually <code>GeneratedType</code>
\r
119 * <code>GeneratedTransferObject</code>which are generated from
\r
120 * <code>context</code> data.
\r
121 * @throws IllegalArgumentException
\r
122 * if param <code>context</code> is null
\r
123 * @throws IllegalStateException
\r
124 * if <code>context</code> contain no modules
\r
126 override generateTypes(SchemaContext context) {
\r
127 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
\r
128 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
\r
129 schemaContext = context;
\r
130 typeProvider = new TypeProviderImpl(context);
\r
131 val Set<Module> modules = context.modules;
\r
132 return generateTypes(context, modules);
\r
136 * Resolves generated types from <code>context</code> schema nodes only for
\r
137 * modules specified in <code>modules</code>
\r
139 * Generated types are created for modules, groupings, types, containers,
\r
140 * lists, choices, augments, rpcs, notification, identities.
\r
143 * schema context which contains data about all schema nodes
\r
146 * set of modules for which schema nodes should be generated
\r
148 * @return list of types (usually <code>GeneratedType</code> or
\r
149 * <code>GeneratedTransferObject</code>) which:
\r
151 * <li>are generated from <code>context</code> schema nodes and</li>
\r
152 * <li>are also part of some of the module in <code>modules</code>
\r
155 * @throws IllegalArgumentException
\r
157 * <li>if param <code>context</code> is null or</li>
\r
158 * <li>if param <code>modules</code> is null</li>
\r
160 * @throws IllegalStateException
\r
161 * if <code>context</code> contain no modules
\r
163 override generateTypes(SchemaContext context, Set<Module> modules) {
\r
164 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
\r
165 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
\r
166 checkArgument(modules !== null, "Set of Modules cannot be NULL.");
\r
168 val List<Type> filteredGenTypes = new ArrayList();
\r
170 schemaContext = context;
\r
171 typeProvider = new TypeProviderImpl(context);
\r
172 val contextModules = ModuleDependencySort.sort(context.modules);
\r
173 genTypeBuilders = new HashMap();
\r
175 for (contextModule : contextModules) {
\r
176 val List<Type> generatedTypes = new ArrayList();
\r
177 generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));
\r
178 generatedTypes.addAll(allGroupingsToGenTypes(contextModule));
\r
179 if(false == contextModule.childNodes.isEmpty()) {
\r
180 generatedTypes.add(moduleToDataType(contextModule));
\r
182 generatedTypes.addAll(allContainersToGenTypes(contextModule));
\r
183 generatedTypes.addAll(allListsToGenTypes(contextModule));
\r
184 generatedTypes.addAll(allChoicesToGenTypes(contextModule));
\r
185 generatedTypes.addAll(allRPCMethodsToGenType(contextModule));
\r
186 generatedTypes.addAll(allNotificationsToGenType(contextModule));
\r
187 generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));
\r
189 if(modules.contains(contextModule)) {
\r
190 filteredGenTypes.addAll(generatedTypes);
\r
193 for (contextModule : contextModules) {
\r
194 val generatedTypes = (allAugmentsToGenTypes(contextModule));
\r
195 if(modules.contains(contextModule)) {
\r
196 filteredGenTypes.addAll(generatedTypes);
\r
200 return filteredGenTypes;
\r
204 * Converts all extended type definitions of module to the list of
\r
205 * <code>Type</code> objects.
\r
208 * module from which is obtained set of type definitions
\r
209 * @return list of <code>Type</code> which are generated from extended
\r
210 * definition types (object of type <code>ExtendedType</code>)
\r
211 * @throws IllegalArgumentException
\r
213 * <li>if module equals null</li>
\r
214 * <li>if name of module equals null</li>
\r
215 * <li>if type definitions of module equal null</li>
\r
219 private def List<Type> allTypeDefinitionsToGenTypes(Module module) {
\r
220 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
221 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
222 val Set<TypeDefinition<?>> typeDefinitions = module.typeDefinitions;
\r
223 checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');
\r
225 val List<Type> generatedTypes = new ArrayList();
\r
226 for (TypeDefinition<?> typedef : typeDefinitions) {
\r
227 if(typedef !== null) {
\r
228 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
\r
229 if((type !== null) && !generatedTypes.contains(type)) {
\r
230 generatedTypes.add(type);
\r
234 return generatedTypes;
\r
238 * Converts all <b>containers</b> of the module to the list of
\r
239 * <code>Type</code> objects.
\r
242 * module from which is obtained DataNodeIterator to iterate over
\r
244 * @return list of <code>Type</code> which are generated from containers
\r
245 * (objects of type <code>ContainerSchemaNode</code>)
\r
246 * @throws IllegalArgumentException
\r
248 * <li>if the module equals null</li>
\r
249 * <li>if the name of module equals null</li>
\r
250 * <li>if the set of child nodes equals null</li>
\r
254 private def List<Type> allContainersToGenTypes(Module module) {
\r
255 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
257 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
259 if(module.childNodes === null) {
\r
260 throw new IllegalArgumentException(
\r
261 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");
\r
264 val List<Type> generatedTypes = new ArrayList();
\r
265 val it = new DataNodeIterator(module);
\r
266 val List<ContainerSchemaNode> schemaContainers = it.allContainers();
\r
267 val basePackageName = moduleNamespaceToPackageName(module);
\r
268 for (container : schemaContainers) {
\r
269 if(!container.isAddedByUses()) {
\r
270 generatedTypes.add(containerToGenType(basePackageName, container));
\r
273 return generatedTypes;
\r
277 * Converts all <b>lists</b> of the module to the list of <code>Type</code>
\r
281 * module from which is obtained DataNodeIterator to iterate over
\r
283 * @return list of <code>Type</code> which are generated from lists (objects
\r
284 * of type <code>ListSchemaNode</code>)
\r
285 * @throws IllegalArgumentException
\r
287 * <li>if the module equals null</li>
\r
288 * <li>if the name of module equals null</li>
\r
289 * <li>if the set of child nodes equals null</li>
\r
293 private def List<Type> allListsToGenTypes(Module module) {
\r
294 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
295 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
297 if(module.childNodes === null) {
\r
298 throw new IllegalArgumentException(
\r
299 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");
\r
302 val List<Type> generatedTypes = new ArrayList();
\r
303 val it = new DataNodeIterator(module);
\r
304 val List<ListSchemaNode> schemaLists = it.allLists();
\r
305 val basePackageName = moduleNamespaceToPackageName(module);
\r
306 if(schemaLists !== null) {
\r
307 for (list : schemaLists) {
\r
308 if(!list.isAddedByUses()) {
\r
309 generatedTypes.addAll(listToGenType(basePackageName, list));
\r
313 return generatedTypes;
\r
317 * Converts all <b>choices</b> of the module to the list of
\r
318 * <code>Type</code> objects.
\r
321 * module from which is obtained DataNodeIterator to iterate over
\r
323 * @return list of <code>Type</code> which are generated from choices
\r
324 * (objects of type <code>ChoiceNode</code>)
\r
325 * @throws IllegalArgumentException
\r
327 * <li>if the module equals null</li>
\r
328 * <li>if the name of module equals null</li> *
\r
332 private def List<GeneratedType> allChoicesToGenTypes(Module module) {
\r
333 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
334 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
336 val it = new DataNodeIterator(module);
\r
337 val choiceNodes = it.allChoices();
\r
338 val basePackageName = moduleNamespaceToPackageName(module);
\r
340 val List<GeneratedType> generatedTypes = new ArrayList();
\r
341 for (choice : choiceNodes) {
\r
342 if((choice !== null) && !choice.isAddedByUses()) {
\r
343 generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice));
\r
346 return generatedTypes;
\r
350 * Converts all <b>augmentation</b> of the module to the list
\r
351 * <code>Type</code> objects.
\r
354 * module from which is obtained list of all augmentation objects
\r
355 * to iterate over them
\r
356 * @return list of <code>Type</code> which are generated from augments
\r
357 * (objects of type <code>AugmentationSchema</code>)
\r
358 * @throws IllegalArgumentException
\r
360 * <li>if the module equals null</li>
\r
361 * <li>if the name of module equals null</li>
\r
362 * <li>if the set of child nodes equals null</li>
\r
366 private def List<Type> allAugmentsToGenTypes(Module module) {
\r
367 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
368 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
369 if(module.childNodes === null) {
\r
370 throw new IllegalArgumentException(
\r
371 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
\r
374 val List<Type> generatedTypes = new ArrayList();
\r
375 val basePackageName = moduleNamespaceToPackageName(module);
\r
376 val List<AugmentationSchema> augmentations = resolveAugmentations(module);
\r
377 for (augment : augmentations) {
\r
378 generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment));
\r
380 return generatedTypes;
\r
384 * Returns list of <code>AugmentationSchema</code> objects. The objects are
\r
385 * sorted according to the length of their target path from the shortest to
\r
389 * module from which is obtained list of all augmentation objects
\r
390 * @return list of sorted <code>AugmentationSchema</code> objects obtained
\r
391 * from <code>module</code>
\r
392 * @throws IllegalArgumentException
\r
394 * <li>if the module equals null</li>
\r
395 * <li>if the set of augmentation equals null</li>
\r
399 private def List<AugmentationSchema> resolveAugmentations(Module module) {
\r
400 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
401 checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
\r
403 val Set<AugmentationSchema> augmentations = module.augmentations;
\r
404 val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
\r
405 Collections.sort(sortedAugmentations,
\r
406 [ augSchema1, augSchema2 |
\r
407 if(augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
\r
409 } else if(augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
\r
414 return sortedAugmentations;
\r
418 * Converts whole <b>module</b> to <code>GeneratedType</code> object.
\r
419 * Firstly is created the module builder object from which is vally
\r
420 * obtained reference to <code>GeneratedType</code> object.
\r
423 * module from which are obtained the module name, child nodes,
\r
424 * uses and is derived package name
\r
425 * @return <code>GeneratedType</code> which is internal representation of
\r
427 * @throws IllegalArgumentException
\r
428 * if the module equals null
\r
431 private def GeneratedType moduleToDataType(Module module) {
\r
432 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
434 val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
\r
435 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
\r
436 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
\r
438 val basePackageName = moduleNamespaceToPackageName(module);
\r
439 if(moduleDataTypeBuilder !== null) {
\r
440 val Set<DataSchemaNode> dataNodes = module.childNodes;
\r
441 resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);
\r
443 return moduleDataTypeBuilder.toInstance();
\r
447 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
\r
448 * to the list of <code>Type</code> objects. In addition are to containers
\r
449 * and lists which belong to input or output also part of returning list.
\r
452 * module from which is obtained set of all rpc objects to
\r
453 * iterate over them
\r
454 * @return list of <code>Type</code> which are generated from rpcs inputs,
\r
455 * outputs + container and lists which are part of inputs or outputs
\r
456 * @throws IllegalArgumentException
\r
458 * <li>if the module equals null</li>
\r
459 * <li>if the name of module equals null</li>
\r
460 * <li>if the set of child nodes equals null</li>
\r
464 private def List<Type> allRPCMethodsToGenType(Module module) {
\r
465 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
467 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
469 if(module.childNodes === null) {
\r
470 throw new IllegalArgumentException(
\r
471 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
\r
474 val basePackageName = moduleNamespaceToPackageName(module);
\r
475 val Set<RpcDefinition> rpcDefinitions = module.rpcs;
\r
477 if(rpcDefinitions.isEmpty()) {
\r
478 return Collections.emptyList();
\r
481 val List<Type> genRPCTypes = new ArrayList();
\r
482 val interfaceBuilder = moduleTypeBuilder(module, "Service");
\r
483 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
\r
484 for (rpc : rpcDefinitions) {
\r
487 val rpcName = parseToClassName(rpc.QName.localName);
\r
488 val rpcMethodName = parseToValidParamName(rpcName);
\r
489 val method = interfaceBuilder.addMethod(rpcMethodName);
\r
491 val rpcInOut = new ArrayList();
\r
493 val input = rpc.input;
\r
494 val output = rpc.output;
\r
496 if(input !== null) {
\r
497 rpcInOut.add(new DataNodeIterator(input));
\r
498 val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
\r
499 addImplementedInterfaceFromUses(input, inType);
\r
500 inType.addImplementsType(DATA_OBJECT);
\r
501 inType.addImplementsType(augmentable(inType));
\r
502 resolveDataSchemaNodes(basePackageName, inType, input.childNodes);
\r
503 val inTypeInstance = inType.toInstance();
\r
504 genRPCTypes.add(inTypeInstance);
\r
505 method.addParameter(inTypeInstance, "input");
\r
508 var Type outTypeInstance = VOID;
\r
509 if(output !== null) {
\r
510 rpcInOut.add(new DataNodeIterator(output));
\r
511 val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
\r
512 addImplementedInterfaceFromUses(output, outType);
\r
513 outType.addImplementsType(DATA_OBJECT);
\r
514 outType.addImplementsType(augmentable(outType));
\r
516 resolveDataSchemaNodes(basePackageName, outType, output.childNodes);
\r
517 outTypeInstance = outType.toInstance();
\r
518 genRPCTypes.add(outTypeInstance);
\r
522 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
\r
523 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
\r
524 for (iter : rpcInOut) {
\r
525 val List<ContainerSchemaNode> nContainers = iter.allContainers();
\r
526 if((nContainers !== null) && !nContainers.isEmpty()) {
\r
527 for (container : nContainers) {
\r
528 if(!container.isAddedByUses()) {
\r
529 genRPCTypes.add(containerToGenType(basePackageName, container));
\r
533 val List<ListSchemaNode> nLists = iter.allLists();
\r
534 if((nLists !== null) && !nLists.isEmpty()) {
\r
535 for (list : nLists) {
\r
536 if(!list.isAddedByUses()) {
\r
537 genRPCTypes.addAll(listToGenType(basePackageName, list));
\r
544 genRPCTypes.add(interfaceBuilder.toInstance());
\r
545 return genRPCTypes;
\r
549 * Converts all <b>notifications</b> of the module to the list of
\r
550 * <code>Type</code> objects. In addition are to this list added containers
\r
551 * and lists which are part of this notification.
\r
554 * module from which is obtained set of all notification objects
\r
555 * to iterate over them
\r
556 * @return list of <code>Type</code> which are generated from notification
\r
557 * (object of type <code>NotificationDefinition</code>
\r
558 * @throws IllegalArgumentException
\r
560 * <li>if the module equals null</li>
\r
561 * <li>if the name of module equals null</li>
\r
562 * <li>if the set of child nodes equals null</li>
\r
566 private def List<Type> allNotificationsToGenType(Module module) {
\r
567 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
569 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
571 if(module.childNodes === null) {
\r
572 throw new IllegalArgumentException(
\r
573 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
\r
575 val notifications = module.notifications;
\r
576 if(notifications.isEmpty()) return Collections.emptyList();
\r
578 val listenerInterface = moduleTypeBuilder(module, "Listener");
\r
579 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
\r
581 val basePackageName = moduleNamespaceToPackageName(module);
\r
582 val List<Type> generatedTypes = new ArrayList();
\r
584 for (notification : notifications) {
\r
585 if(notification !== null) {
\r
586 val iter = new DataNodeIterator(notification);
\r
589 for (node : iter.allContainers()) {
\r
590 if(!node.isAddedByUses()) {
\r
591 generatedTypes.add(containerToGenType(basePackageName, node));
\r
596 for (node : iter.allLists()) {
\r
597 if(!node.isAddedByUses()) {
\r
598 generatedTypes.addAll(listToGenType(basePackageName, node));
\r
601 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification);
\r
602 notificationInterface.addImplementsType(NOTIFICATION);
\r
604 // Notification object
\r
605 resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);
\r
607 listenerInterface.addMethod("on" + notificationInterface.name) //
\r
608 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
\r
609 setReturnType(Types.VOID);
\r
611 generatedTypes.add(notificationInterface.toInstance());
\r
614 generatedTypes.add(listenerInterface.toInstance());
\r
615 return generatedTypes;
\r
619 * Converts all <b>identities</b> of the module to the list of
\r
620 * <code>Type</code> objects.
\r
623 * module from which is obtained set of all identity objects to
\r
624 * iterate over them
\r
626 * schema context only used as input parameter for method
\r
627 * {@link identityToGenType}
\r
628 * @return list of <code>Type</code> which are generated from identities
\r
629 * (object of type <code>IdentitySchemaNode</code>
\r
632 private def List<Type> allIdentitiesToGenTypes(Module module, SchemaContext context) {
\r
633 val List<Type> genTypes = new ArrayList();
\r
635 val Set<IdentitySchemaNode> schemaIdentities = module.identities;
\r
637 val basePackageName = moduleNamespaceToPackageName(module);
\r
639 if(schemaIdentities !== null && !schemaIdentities.isEmpty()) {
\r
640 for (identity : schemaIdentities) {
\r
641 genTypes.add(identityToGenType(basePackageName, identity, context));
\r
648 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
\r
649 * created transport object builder. If identity contains base identity then
\r
650 * reference to base identity is added to superior identity as its extend.
\r
651 * If identity doesn't contain base identity then only reference to abstract
\r
652 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
\r
653 * BaseIdentity} is added
\r
655 * @param basePackageName
\r
656 * string contains the module package name
\r
658 * IdentitySchemaNode which contains data about identity
\r
660 * SchemaContext which is used to get package and name
\r
661 * information about base of identity
\r
663 * @return GeneratedType which is generated from identity (object of type
\r
664 * <code>IdentitySchemaNode</code>
\r
667 private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,
\r
668 SchemaContext context) {
\r
669 if(identity === null) {
\r
673 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
\r
674 val genTypeName = parseToClassName(identity.QName.localName);
\r
675 val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
\r
677 val baseIdentity = identity.baseIdentity;
\r
678 if(baseIdentity !== null) {
\r
679 val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
\r
681 val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
\r
682 val returnTypeName = parseToClassName(baseIdentity.QName.localName);
\r
684 val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
\r
685 newType.setExtendsType(gto);
\r
687 newType.setExtendsType(Types.baseIdentityTO);
\r
689 newType.setAbstract(true);
\r
690 return newType.toInstance();
\r
694 * Converts all <b>groupings</b> of the module to the list of
\r
695 * <code>Type</code> objects. Firstly are groupings sorted according mutual
\r
696 * dependencies. At least dependend (indepedent) groupings are in the list
\r
697 * saved at first positions. For every grouping the record is added to map
\r
698 * {@link BindingGeneratorImpl#allGroupings allGroupings}
\r
701 * module from which is obtained set of all grouping objects to
\r
702 * iterate over them
\r
703 * @return list of <code>Type</code> which are generated from groupings
\r
704 * (object of type <code>GroupingDefinition</code>)
\r
707 private def List<Type> allGroupingsToGenTypes(Module module) {
\r
708 checkArgument(module !== null, "Module parameter can not be null");
\r
709 val List<Type> genTypes = new ArrayList();
\r
710 val basePackageName = moduleNamespaceToPackageName(module);
\r
711 val Set<GroupingDefinition> groupings = module.groupings;
\r
712 val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
\r
715 for (grouping : groupingsSortedByDependencies) {
\r
716 val genType = groupingToGenType(basePackageName, grouping);
\r
717 genTypes.add(genType);
\r
718 val schemaPath = grouping.path;
\r
719 allGroupings.put(schemaPath, genType);
\r
725 * Converts individual grouping to GeneratedType. Firstly generated type
\r
726 * builder is created and every child node of grouping is resolved to the
\r
729 * @param basePackageName
\r
730 * string contains the module package name
\r
732 * GroupingDefinition which contains data about grouping
\r
733 * @return GeneratedType which is generated from grouping (object of type
\r
734 * <code>GroupingDefinition</code>)
\r
736 private def GeneratedType groupingToGenType(String basePackageName, GroupingDefinition grouping) {
\r
737 if(grouping === null) {
\r
741 val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
\r
742 val Set<DataSchemaNode> schemaNodes = grouping.childNodes;
\r
743 val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);
\r
745 resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
\r
746 return typeBuilder.toInstance();
\r
750 * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
\r
751 * type of <code>typeDefinition</code> is of the type ExtendedType then this
\r
752 * method is recursivelly called with this base type.
\r
754 * @param typeDefinition
\r
755 * TypeDefinition in which should be EnumTypeDefinition found as
\r
757 * @return EnumTypeDefinition if it is found inside
\r
758 * <code>typeDefinition</code> or <code>null</code> in other case
\r
760 private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
\r
761 if(typeDefinition !== null) {
\r
762 if(typeDefinition.baseType instanceof EnumTypeDefinition) {
\r
763 return typeDefinition.baseType as EnumTypeDefinition;
\r
764 } else if(typeDefinition.baseType instanceof ExtendedType) {
\r
765 return enumTypeDefFromExtendedType(typeDefinition.baseType);
\r
772 * Adds enumeration builder created from <code>enumTypeDef</code> to
\r
773 * <code>typeBuilder</code>.
\r
775 * Each <code>enumTypeDef</code> item is added to builder with its name and
\r
778 * @param enumTypeDef
\r
779 * EnumTypeDefinition contains enum data
\r
781 * string contains name which will be assigned to enumeration
\r
783 * @param typeBuilder
\r
784 * GeneratedTypeBuilder to which will be enum builder assigned
\r
785 * @return enumeration builder which contais data from
\r
786 * <code>enumTypeDef</code>
\r
788 private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, String enumName,
\r
789 GeneratedTypeBuilder typeBuilder) {
\r
790 if((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
\r
791 (enumTypeDef.QName.localName !== null)) {
\r
793 val enumerationName = parseToClassName(enumName);
\r
794 val enumBuilder = typeBuilder.addEnumeration(enumerationName);
\r
795 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
\r
797 return enumBuilder;
\r
803 * Generates type builder for <code>module</code>.
\r
806 * Module which is source of package name for generated type
\r
809 * string which is added to the module class name representation
\r
811 * @return instance of GeneratedTypeBuilder which represents
\r
812 * <code>module</code>.
\r
813 * @throws IllegalArgumentException
\r
814 * if <code>module</code> equals null
\r
816 private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
\r
817 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
818 val packageName = moduleNamespaceToPackageName(module);
\r
819 val moduleName = parseToClassName(module.name) + postfix;
\r
821 return new GeneratedTypeBuilderImpl(packageName, moduleName);
\r
826 * Converts <code>augSchema</code> to list of <code>Type</code> which
\r
827 * contains generated type for augmentation. In addition there are also
\r
828 * generated types for all containers, list and choices which are child of
\r
829 * <code>augSchema</code> node or a generated types for cases are added if
\r
830 * augmented node is choice.
\r
832 * @param augmentPackageName
\r
833 * string with the name of the package to which the augmentation
\r
836 * AugmentationSchema which is contains data about agumentation
\r
837 * (target path, childs...)
\r
838 * @return list of <code>Type</code> objects which contains generated type
\r
839 * for augmentation and for container, list and choice child nodes
\r
840 * @throws IllegalArgumentException
\r
842 * <li>if <code>augmentPackageName</code> equals null</li>
\r
843 * <li>if <code>augSchema</code> equals null</li>
\r
844 * <li>if target path of <code>augSchema</code> equals null</li>
\r
847 private def List<Type> augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema) {
\r
848 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
\r
849 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
\r
850 checkState(augSchema.targetPath !== null,
\r
851 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
\r
852 val List<Type> genTypes = new ArrayList();
\r
854 // EVERY augmented interface will extends Augmentation<T> interface
\r
855 // and DataObject interface!!!
\r
856 val targetPath = augSchema.targetPath;
\r
857 val targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
\r
858 if(targetSchemaNode !== null) {
\r
859 var targetType = yangToJavaMapping.get(targetSchemaNode.path);
\r
860 if(targetType == null) {
\r
862 // FIXME: augmentation should be added as last, all types should already be generated
\r
863 // and have assigned Java Types,
\r
864 val targetModule = findParentModule(schemaContext, targetSchemaNode);
\r
865 val targetBasePackage = moduleNamespaceToPackageName(targetModule);
\r
866 val typePackage = packageNameForGeneratedType(targetBasePackage, targetSchemaNode.getPath());
\r
867 val targetSchemaNodeName = targetSchemaNode.getQName().getLocalName();
\r
868 val typeName = parseToClassName(targetSchemaNodeName);
\r
869 targetType = new ReferencedTypeImpl(typePackage, typeName);
\r
871 val augChildNodes = augSchema.childNodes;
\r
872 if(!(targetSchemaNode instanceof ChoiceNode)) {
\r
873 val augTypeBuilder = addRawAugmentGenTypeDefinition(augmentPackageName, targetType, augSchema);
\r
874 val augType = augTypeBuilder.toInstance();
\r
875 genTypes.add(augType);
\r
877 val choiceTarget = targetSchemaNode as ChoiceNode;
\r
878 val choiceCaseNodes = choiceTarget.cases;
\r
880 generateTypesFromAugmentedChoiceCases(augmentPackageName, targetType, choiceCaseNodes));
\r
882 genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes));
\r
889 * Returns a generated type builder for an augmentation.
\r
891 * The name of the type builder is equal to the name of augmented node with
\r
892 * serial number as suffix.
\r
894 * @param augmentPackageName
\r
895 * string with contains the package name to which the augment
\r
897 * @param targetPackageName
\r
898 * string with the package name to which the augmented node
\r
900 * @param targetSchemaNodeName
\r
901 * string with the name of the augmented node
\r
903 * augmentation schema which contains data about the child nodes
\r
904 * and uses of augment
\r
905 * @return generated type builder for augment
\r
907 private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(String augmentPackageName, Type targetTypeRef,
\r
908 AugmentationSchema augSchema) {
\r
909 var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
\r
910 if(augmentBuilders === null) {
\r
911 augmentBuilders = new HashMap();
\r
912 genTypeBuilders.put(augmentPackageName, augmentBuilders);
\r
914 val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
\r
916 val augTypeName = if(augIdentifier !== null) {
\r
917 parseToClassName(augIdentifier)
\r
919 augGenTypeName(augmentBuilders, targetTypeRef.name);
\r
921 val Set<DataSchemaNode> augChildNodes = augSchema.childNodes;
\r
923 val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
\r
925 augTypeBuilder.addImplementsType(DATA_OBJECT);
\r
926 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
\r
927 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
\r
929 augSchemaNodeToMethods(augmentPackageName, augTypeBuilder, augChildNodes);
\r
930 augmentBuilders.put(augTypeName, augTypeBuilder);
\r
931 return augTypeBuilder;
\r
936 * @param unknownSchemaNodes
\r
937 * @return nodeParameter of UnknownSchemaNode
\r
939 private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
\r
940 for (unknownSchemaNode : unknownSchemaNodes) {
\r
941 val nodeType = unknownSchemaNode.nodeType;
\r
942 if(AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
\r
943 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
\r
944 return unknownSchemaNode.nodeParameter;
\r
951 * Convert a container, list and choice subnodes (and recursivelly their
\r
952 * subnodes) of augment to generated types
\r
954 * @param augBasePackageName
\r
955 * string with the augment package name
\r
956 * @param augChildNodes
\r
957 * set of data schema nodes which represents child nodes of the
\r
960 * @return list of <code>Type</code> which represents container, list and
\r
961 * choice subnodes of augment
\r
963 private def List<Type> augmentationBodyToGenTypes(String augBasePackageName, Set<DataSchemaNode> augChildNodes) {
\r
964 val List<Type> genTypes = new ArrayList();
\r
965 val List<DataNodeIterator> augSchemaIts = new ArrayList();
\r
966 for (childNode : augChildNodes) {
\r
967 if(childNode instanceof DataNodeContainer) {
\r
968 augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));
\r
970 if(childNode instanceof ContainerSchemaNode) {
\r
971 genTypes.add(containerToGenType(augBasePackageName, childNode as ContainerSchemaNode));
\r
972 } else if(childNode instanceof ListSchemaNode) {
\r
973 genTypes.addAll(listToGenType(augBasePackageName, childNode as ListSchemaNode));
\r
975 } else if(childNode instanceof ChoiceNode) {
\r
976 val choice = childNode as ChoiceNode;
\r
977 for (caseNode : choice.cases) {
\r
978 augSchemaIts.add(new DataNodeIterator(caseNode));
\r
980 genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode));
\r
984 for (it : augSchemaIts) {
\r
985 val List<ContainerSchemaNode> augContainers = it.allContainers();
\r
986 val List<ListSchemaNode> augLists = it.allLists();
\r
987 val List<ChoiceNode> augChoices = it.allChoices();
\r
989 if(augContainers !== null) {
\r
990 for (container : augContainers) {
\r
991 genTypes.add(containerToGenType(augBasePackageName, container));
\r
994 if(augLists !== null) {
\r
995 for (list : augLists) {
\r
996 genTypes.addAll(listToGenType(augBasePackageName, list));
\r
999 if(augChoices !== null) {
\r
1000 for (choice : augChoices) {
\r
1001 genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice));
\r
1009 * Returns first unique name for the augment generated type builder. The
\r
1010 * generated type builder name for augment consists from name of augmented
\r
1011 * node and serial number of its augmentation.
\r
1014 * map of builders which were created in the package to which the
\r
1015 * augmentation belongs
\r
1016 * @param genTypeName
\r
1017 * string with name of augmented node
\r
1018 * @return string with unique name for augmentation builder
\r
1020 private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
\r
1022 while((builders !== null) && builders.containsKey(genTypeName + index)) {
\r
1023 index = index + 1;
\r
1025 return genTypeName + index;
\r
1029 * Converts <code>containerNode</code> to generated type. Firstly the
\r
1030 * generated type builder is created. The subnodes of
\r
1031 * <code>containerNode</code> are added as methods and the instance of
\r
1032 * <code>GeneratedType</code> is returned.
\r
1034 * @param basePackageName
\r
1035 * string contains the module package name
\r
1036 * @param containerNode
\r
1037 * container schema node with the data about childs nodes and
\r
1039 * @return generated type for <code>containerNode</code>
\r
1041 private def GeneratedType containerToGenType(String basePackageName, ContainerSchemaNode containerNode) {
\r
1042 if(containerNode === null) {
\r
1046 val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);
\r
1047 val schemaNodes = containerNode.childNodes;
\r
1048 val typeBuilder = addDefaultInterfaceDefinition(packageName, containerNode);
\r
1050 resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
\r
1051 return typeBuilder.toInstance();
\r
1055 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
\r
1056 * node for which <code>typeBuilder</code> was created.
\r
1058 * The subnodes aren't mapped to the methods if they are part of grouping or
\r
1059 * augment (in this case are already part of them).
\r
1061 * @param basePackageName
\r
1062 * string contains the module package name
\r
1063 * @param typeBuilder
\r
1064 * generated type builder which represents any node. The subnodes
\r
1065 * of this node are added to the <code>typeBuilder</code> as
\r
1066 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1067 * container, choice.
\r
1068 * @param schemaNodes
\r
1069 * set of data schema nodes which are the children of the node
\r
1070 * for which <code>typeBuilder</code> was created
\r
1071 * @return generated type builder which is the same builder as input
\r
1072 * parameter. The getter methods (representing child nodes) could be
\r
1075 private def GeneratedTypeBuilder resolveDataSchemaNodes(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1076 Set<DataSchemaNode> schemaNodes) {
\r
1077 if((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1078 for (schemaNode : schemaNodes) {
\r
1079 if(!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
\r
1080 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1085 return typeBuilder;
\r
1088 private def GeneratedTypeBuilder resolveDataSchemaNodesAugmented(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1089 Set<DataSchemaNode> schemaNodes) {
\r
1090 if ((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1091 for (schemaNode : schemaNodes) {
\r
1092 if (!schemaNode.isAddedByUses()) {
\r
1093 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1097 return typeBuilder;
\r
1101 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
\r
1102 * node for which <code>typeBuilder</code> was created.
\r
1104 * @param basePackageName
\r
1105 * string contains the module package name
\r
1106 * @param typeBuilder
\r
1107 * generated type builder which represents any node. The subnodes
\r
1108 * of this node are added to the <code>typeBuilder</code> as
\r
1109 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1110 * container, choice.
\r
1111 * @param schemaNodes
\r
1112 * set of data schema nodes which are the children of the node
\r
1113 * for which <code>typeBuilder</code> was created
\r
1114 * @return generated type builder which is the same object as the input
\r
1115 * parameter <code>typeBuilder</code>. The getter method could be
\r
1118 private def GeneratedTypeBuilder augSchemaNodeToMethods(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1119 Set<DataSchemaNode> schemaNodes) {
\r
1120 if((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1121 for (schemaNode : schemaNodes) {
\r
1122 if (!schemaNode.isAugmenting()) {
\r
1123 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1127 return typeBuilder;
\r
1131 * Adds to <code>typeBuilder</code> a method which is derived from
\r
1132 * <code>schemaNode</code>.
\r
1134 * @param basePackageName
\r
1135 * string with the module package name
\r
1136 * @param schemaNode
\r
1137 * data schema node which is added to <code>typeBuilder</code> as
\r
1139 * @param typeBuilder
\r
1140 * generated type builder to which is <code>schemaNode</code>
\r
1141 * added as a method.
\r
1143 private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
\r
1144 GeneratedTypeBuilder typeBuilder) {
\r
1145 if(node !== null && typeBuilder !== null) {
\r
1147 case node instanceof LeafSchemaNode:
\r
1148 resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
\r
1149 case node instanceof LeafListSchemaNode:
\r
1150 resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
\r
1151 case node instanceof ContainerSchemaNode:
\r
1152 resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)
\r
1153 case node instanceof ListSchemaNode:
\r
1154 resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)
\r
1155 case node instanceof ChoiceNode:
\r
1156 resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)
\r
1162 * Creates a getter method for a choice node.
\r
1164 * Firstly generated type builder for choice is created or found in
\r
1165 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1166 * in the builder is created as concatenation of module package name and
\r
1167 * names of all parent nodes. In the end the getter method for choice is
\r
1168 * added to <code>typeBuilder</code> and return type is set to choice
\r
1171 * @param basePackageName
\r
1172 * string with the module package name
\r
1173 * @param typeBuilder
\r
1174 * generated type builder to which is <code>choiceNode</code>
\r
1175 * added as getter method
\r
1176 * @param choiceNode
\r
1177 * choice node which is mapped as a getter method
\r
1178 * @throws IllegalArgumentException
\r
1180 * <li>if <code>basePackageName</code> equals null</li>
\r
1181 * <li>if <code>typeBuilder</code> equals null</li>
\r
1182 * <li>if <code>choiceNode</code> equals null</li>
\r
1186 private def void resolveChoiceSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1187 ChoiceNode choiceNode) {
\r
1188 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1189 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
1190 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
\r
1192 val choiceName = choiceNode.QName.localName;
\r
1193 if(choiceName !== null && !choiceNode.isAddedByUses()) {
\r
1194 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
\r
1195 val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);
\r
1196 constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);
\r
1201 * Converts <code>choiceNode</code> to the list of generated types for
\r
1202 * choice and its cases.
\r
1204 * The package names for choice and for its cases are created as
\r
1205 * concatenation of the module package (<code>basePackageName</code>) and
\r
1206 * names of all parents node.
\r
1208 * @param basePackageName
\r
1209 * string with the module package name
\r
1210 * @param choiceNode
\r
1211 * choice node which is mapped to generated type. Also child
\r
1212 * nodes - cases are mapped to generated types.
\r
1213 * @return list of generated types which contains generated type for choice
\r
1214 * and generated types for all cases which aren't added do choice
\r
1215 * through <i>uses</i>.
\r
1216 * @throws IllegalArgumentException
\r
1218 * <li>if <code>basePackageName</code> equals null</li>
\r
1219 * <li>if <code>choiceNode</code> equals null</li>
\r
1223 private def List<GeneratedType> choiceToGeneratedType(String basePackageName, ChoiceNode choiceNode) {
\r
1224 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1225 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
\r
1227 val List<GeneratedType> generatedTypes = new ArrayList();
\r
1228 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
\r
1229 val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
\r
1231 //choiceTypeBuilder.addImplementsType(DATA_OBJECT);
\r
1232 val choiceType = choiceTypeBuilder.toInstance();
\r
1234 generatedTypes.add(choiceType);
\r
1235 val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
\r
1236 if((caseNodes !== null) && !caseNodes.isEmpty()) {
\r
1237 generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes));
\r
1239 return generatedTypes;
\r
1243 * Converts <code>caseNodes</code> set to list of corresponding generated
\r
1246 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
\r
1247 * created generated type builder. The package names for the builder is
\r
1248 * created as concatenation of the module package (
\r
1249 * <code>basePackageName</code>) and names of all parents nodes of the
\r
1250 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
\r
1251 * between every case builder and <i>choice</i> type
\r
1253 * @param basePackageName
\r
1254 * string with the module package name
\r
1255 * @param refChoiceType
\r
1256 * type which represents superior <i>case</i>
\r
1257 * @param caseNodes
\r
1258 * set of choice case nodes which are mapped to generated types
\r
1259 * @return list of generated types for <code>caseNodes</code>.
\r
1260 * @throws IllegalArgumentException
\r
1262 * <li>if <code>basePackageName</code> equals null</li>
\r
1263 * <li>if <code>refChoiceType</code> equals null</li>
\r
1264 * <li>if <code>caseNodes</code> equals null</li>
\r
1268 private def List<GeneratedType> generateTypesFromChoiceCases(String basePackageName, Type refChoiceType,
\r
1269 Set<ChoiceCaseNode> caseNodes) {
\r
1270 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1271 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
\r
1272 checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
\r
1274 val List<GeneratedType> generatedTypes = new ArrayList();
\r
1275 for (caseNode : caseNodes) {
\r
1276 if(caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
\r
1277 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
\r
1278 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
\r
1279 caseTypeBuilder.addImplementsType(refChoiceType);
\r
1281 val Set<DataSchemaNode> childNodes = caseNode.childNodes;
\r
1282 if(childNodes !== null) {
\r
1283 resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);
\r
1285 generatedTypes.add(caseTypeBuilder.toInstance());
\r
1289 return generatedTypes;
\r
1293 * Generates list of generated types for all the cases of a choice which are
\r
1294 * added to the choice through the augment.
\r
1297 * @param basePackageName
\r
1298 * string contains name of package to which augment belongs. If
\r
1299 * an augmented choice is from an other package (pcg1) than an
\r
1300 * augmenting choice (pcg2) then case's of the augmenting choice
\r
1301 * will belong to pcg2.
\r
1302 * @param refChoiceType
\r
1303 * Type which represents the choice to which case belongs. Every
\r
1304 * case has to contain its choice in extend part.
\r
1305 * @param caseNodes
\r
1306 * set of choice case nodes for which is checked if are/aren't
\r
1307 * added to choice through augmentation
\r
1308 * @return list of generated types which represents augmented cases of
\r
1309 * choice <code>refChoiceType</code>
\r
1310 * @throws IllegalArgumentException
\r
1312 * <li>if <code>basePackageName</code> equals null</li>
\r
1313 * <li>if <code>refChoiceType</code> equals null</li>
\r
1314 * <li>if <code>caseNodes</code> equals null</li>
\r
1317 private def List<GeneratedType> generateTypesFromAugmentedChoiceCases(String basePackageName, Type refChoiceType,
\r
1318 Set<ChoiceCaseNode> caseNodes) {
\r
1319 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1320 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
\r
1321 checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
\r
1323 val List<GeneratedType> generatedTypes = new ArrayList();
\r
1324 for (caseNode : caseNodes) {
\r
1325 if(caseNode !== null && caseNode.isAugmenting()) {
\r
1326 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
\r
1327 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
\r
1328 caseTypeBuilder.addImplementsType(refChoiceType);
\r
1330 val Set<DataSchemaNode> childNodes = caseNode.childNodes;
\r
1331 if(childNodes !== null) {
\r
1332 resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);
\r
1334 generatedTypes.add(caseTypeBuilder.toInstance());
\r
1338 return generatedTypes;
\r
1342 * Converts <code>leaf</code> to the getter method which is added to
\r
1343 * <code>typeBuilder</code>.
\r
1345 * @param typeBuilder
\r
1346 * generated type builder to which is added getter method as
\r
1347 * <code>leaf</code> mapping
\r
1349 * leaf schema node which is mapped as getter method which is
\r
1350 * added to <code>typeBuilder</code>
\r
1351 * @return boolean value
\r
1353 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
\r
1355 * <li>true - in other cases</li>
\r
1358 private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
\r
1359 if((leaf !== null) && (typeBuilder !== null)) {
\r
1360 val leafName = leaf.QName.localName;
\r
1361 var String leafDesc = leaf.description;
\r
1362 if(leafDesc === null) {
\r
1366 val parentModule = findParentModule(schemaContext, leaf);
\r
1367 if(leafName !== null && !leaf.isAddedByUses()) {
\r
1368 val TypeDefinition<?> typeDef = leaf.type;
\r
1370 var Type returnType = null;
\r
1371 if(typeDef instanceof EnumTypeDefinition) {
\r
1372 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1373 val enumTypeDef = typeDef as EnumTypeDefinition;
\r
1374 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);
\r
1376 if(enumBuilder !== null) {
\r
1377 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
\r
1379 (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
\r
1380 } else if(typeDef instanceof UnionType) {
\r
1381 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
\r
1382 if(genTOBuilder !== null) {
\r
1383 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1385 } else if(typeDef instanceof BitsTypeDefinition) {
\r
1386 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
\r
1387 if(genTOBuilder !== null) {
\r
1388 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1391 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1393 if(returnType !== null) {
\r
1394 constructGetter(typeBuilder, leafName, leafDesc, returnType);
\r
1403 * Converts <code>leaf</code> schema node to property of generated TO
\r
1406 * @param toBuilder
\r
1407 * generated TO builder to which is <code>leaf</code> added as
\r
1410 * leaf schema node which is added to <code>toBuilder</code> as
\r
1412 * @param isReadOnly
\r
1413 * boolean value which says if leaf property is|isn't read only
\r
1414 * @return boolean value
\r
1416 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
\r
1417 * name equals null or if leaf is added by <i>uses</i>.</li>
\r
1418 * <li>true - other cases</li>
\r
1421 private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
\r
1422 boolean isReadOnly) {
\r
1423 if((leaf !== null) && (toBuilder !== null)) {
\r
1424 val leafName = leaf.QName.localName;
\r
1425 var String leafDesc = leaf.description;
\r
1426 if(leafDesc === null) {
\r
1430 if(leafName !== null) {
\r
1431 val TypeDefinition<?> typeDef = leaf.type;
\r
1433 // TODO: properly resolve enum types
\r
1434 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1436 if(returnType !== null) {
\r
1437 val propBuilder = toBuilder.addProperty(parseToClassName(leafName));
\r
1439 propBuilder.setReadOnly(isReadOnly);
\r
1440 propBuilder.setReturnType(returnType);
\r
1441 propBuilder.setComment(leafDesc);
\r
1443 toBuilder.addEqualsIdentity(propBuilder);
\r
1444 toBuilder.addHashIdentity(propBuilder);
\r
1445 toBuilder.addToStringProperty(propBuilder);
\r
1455 * Converts <code>node</code> leaf list schema node to getter method of
\r
1456 * <code>typeBuilder</code>.
\r
1458 * @param typeBuilder
\r
1459 * generated type builder to which is <code>node</code> added as
\r
1462 * leaf list schema node which is added to
\r
1463 * <code>typeBuilder</code> as getter method
\r
1464 * @return boolean value
\r
1466 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
\r
1467 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
\r
1468 * <li>false - other cases</li>
\r
1471 private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
\r
1472 if((node !== null) && (typeBuilder !== null)) {
\r
1473 val nodeName = node.QName.localName;
\r
1474 var String nodeDesc = node.description;
\r
1475 if(nodeDesc === null) {
\r
1479 if(nodeName !== null && !node.isAddedByUses()) {
\r
1480 val TypeDefinition<?> type = node.type;
\r
1481 val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));
\r
1483 constructGetter(typeBuilder, nodeName, nodeDesc, listType);
\r
1491 * Creates a getter method for a container node.
\r
1493 * Firstly generated type builder for container is created or found in
\r
1494 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1495 * in the builder is created as concatenation of module package name and
\r
1496 * names of all parent nodes. In the end the getter method for container is
\r
1497 * added to <code>typeBuilder</code> and return type is set to container
\r
1500 * @param basePackageName
\r
1501 * string with the module package name
\r
1502 * @param typeBuilder
\r
1503 * generated type builder to which is <code>containerNode</code>
\r
1504 * added as getter method
\r
1505 * @param containerNode
\r
1506 * container schema node which is mapped as getter method to
\r
1507 * <code>typeBuilder</code>
\r
1508 * @return boolean value
\r
1510 * <li>false - if <code>containerNode</code>,
\r
1511 * <code>typeBuilder</code>, container node name equal null or
\r
1512 * <code>containerNode</code> is added by uses</li>
\r
1513 * <li>true - other cases</li>
\r
1516 private def boolean resolveContainerSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1517 ContainerSchemaNode containerNode) {
\r
1518 if((containerNode !== null) && (typeBuilder !== null)) {
\r
1519 val nodeName = containerNode.QName.localName;
\r
1521 if(nodeName !== null && !containerNode.isAddedByUses()) {
\r
1522 val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);
\r
1524 val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);
\r
1525 constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);
\r
1534 * Creates a getter method for a list node.
\r
1536 * Firstly generated type builder for list is created or found in
\r
1537 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1538 * in the builder is created as concatenation of module package name and
\r
1539 * names of all parent nodes. In the end the getter method for list is added
\r
1540 * to <code>typeBuilder</code> and return type is set to list type builder.
\r
1542 * @param basePackageName
\r
1543 * string with the module package name
\r
1544 * @param typeBuilder
\r
1545 * generated type builder to which is <code></code> added as
\r
1548 * list schema node which is mapped as getter method to
\r
1549 * <code>typeBuilder</code>
\r
1550 * @return boolean value
\r
1552 * <li>false - if <code>listNode</code>, <code>typeBuilder</code>,
\r
1553 * list node name equal null or <code>listNode</code> is added by
\r
1555 * <li>true - other cases</li>
\r
1558 private def boolean resolveListSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1559 ListSchemaNode listNode) {
\r
1560 if((listNode !== null) && (typeBuilder !== null)) {
\r
1561 val listName = listNode.QName.localName;
\r
1563 if(listName !== null && !listNode.isAddedByUses()) {
\r
1564 val packageName = packageNameForGeneratedType(basePackageName, listNode.path);
\r
1565 val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);
\r
1566 constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));
\r
1574 * Instantiates generated type builder with <code>packageName</code> and
\r
1575 * <code>schemaNode</code>.
\r
1577 * The new builder always implements
\r
1578 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
\r
1579 * If <code>schemaNode</code> is instance of GroupingDefinition it also
\r
1580 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
\r
1581 * Augmentable}.<br />
\r
1582 * If <code>schemaNode</code> is instance of
\r
1583 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
\r
1584 * DataNodeContainer} it can also implement nodes which are specified in
\r
1587 * @param packageName
\r
1588 * string with the name of the package to which
\r
1589 * <code>schemaNode</code> belongs.
\r
1590 * @param schemaNode
\r
1591 * schema node for which is created generated type builder
\r
1592 * @return generated type builder <code>schemaNode</code>
\r
1594 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
\r
1595 val builder = addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1596 builder.addImplementsType(DATA_OBJECT);
\r
1597 if(!(schemaNode instanceof GroupingDefinition)) {
\r
1598 builder.addImplementsType(augmentable(builder));
\r
1601 if(schemaNode instanceof DataNodeContainer) {
\r
1602 addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, builder);
\r
1609 * Wraps the calling of the same overloaded method.
\r
1611 * @param packageName
\r
1612 * string with the package name to which returning generated type
\r
1614 * @param schemaNode
\r
1615 * schema node which provide data about the schema node name
\r
1616 * @return generated type builder for <code>schemaNode</code>
\r
1618 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
\r
1619 return addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1623 * Returns reference to generated type builder for specified
\r
1624 * <code>schemaNode</code> with <code>packageName</code>.
\r
1626 * Firstly the generated type builder is searched in
\r
1627 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
\r
1628 * found it is created and added to <code>genTypeBuilders</code>.
\r
1630 * @param packageName
\r
1631 * string with the package name to which returning generated type
\r
1633 * @param schemaNode
\r
1634 * schema node which provide data about the schema node name
\r
1635 * @return generated type builder for <code>schemaNode</code>
\r
1636 * @throws IllegalArgumentException
\r
1638 * <li>if <code>schemaNode</code> equals null</li>
\r
1639 * <li>if <code>packageName</code> equals null</li>
\r
1640 * <li>if Q name of schema node is null</li>
\r
1641 * <li>if schema node name is nul</li>
\r
1645 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
\r
1647 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
\r
1648 checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
\r
1649 checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
\r
1650 val schemaNodeName = schemaNode.QName.localName;
\r
1651 checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
\r
1653 var String genTypeName;
\r
1654 if(prefix === null) {
\r
1655 genTypeName = parseToClassName(schemaNodeName);
\r
1657 genTypeName = prefix + parseToClassName(schemaNodeName);
\r
1660 //FIXME: Validation of name conflict
\r
1661 val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
\r
1662 yangToJavaMapping.put(schemaNode.path, newType);
\r
1663 if(!genTypeBuilders.containsKey(packageName)) {
\r
1664 val Map<String, GeneratedTypeBuilder> builders = new HashMap();
\r
1665 builders.put(genTypeName, newType);
\r
1666 genTypeBuilders.put(packageName, builders);
\r
1668 val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
\r
1669 if(!builders.containsKey(genTypeName)) {
\r
1670 builders.put(genTypeName, newType);
\r
1677 * Creates the name of the getter method from <code>methodName</code>.
\r
1679 * @param methodName
\r
1680 * string with the name of the getter method
\r
1681 * @return string with the name of the getter method for
\r
1682 * <code>methodName</code> in JAVA method format
\r
1684 private def String getterMethodName(String methodName, Type returnType) {
\r
1685 val method = new StringBuilder();
\r
1686 if(BOOLEAN.equals(returnType)) {
\r
1687 method.append("is");
\r
1689 method.append("get");
\r
1691 method.append(parseToClassName(methodName));
\r
1692 return method.toString();
\r
1696 * Created a method signature builder as part of
\r
1697 * <code>interfaceBuilder</code>.
\r
1699 * The method signature builder is created for the getter method of
\r
1700 * <code>schemaNodeName</code>. Also <code>comment</code> and
\r
1701 * <code>returnType</code> information are added to the builder.
\r
1703 * @param interfaceBuilder
\r
1704 * generated type builder for which the getter method should be
\r
1706 * @param schemaNodeName
\r
1707 * string with schema node name. The name will be the part of the
\r
1708 * getter method name.
\r
1710 * string with comment for the getter method
\r
1711 * @param returnType
\r
1712 * type which represents the return type of the getter method
\r
1713 * @return method signature builder which represents the getter method of
\r
1714 * <code>interfaceBuilder</code>
\r
1716 private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
\r
1717 String comment, Type returnType) {
\r
1719 val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
\r
1721 getMethod.setComment(comment);
\r
1722 getMethod.setReturnType(returnType);
\r
1727 private def listToGenType(String basePackageName, ListSchemaNode list) {
\r
1728 checkArgument(basePackageName !== null, "Package Name for Generated Type cannot be NULL.");
\r
1729 checkArgument(list !== null, "List Schema Node cannot be NULL.");
\r
1731 val packageName = packageNameForGeneratedType(basePackageName, list.path);
\r
1733 // val typeBuilder =
\r
1734 // resolveListTypeBuilder(packageName, list);
\r
1735 val typeBuilder = addDefaultInterfaceDefinition(packageName, list);
\r
1737 val List<String> listKeys = listKeys(list);
\r
1738 val genTOBuilder = resolveListKeyTOBuilder(packageName, list);
\r
1740 if(genTOBuilder !== null) {
\r
1741 val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);
\r
1742 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
\r
1743 genTOBuilder.addImplementsType(identifierMarker);
\r
1744 typeBuilder.addImplementsType(identifiableMarker);
\r
1746 val schemaNodes = list.childNodes;
\r
1748 for (schemaNode : schemaNodes) {
\r
1749 if(!schemaNode.isAugmenting()) {
\r
1750 addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);
\r
1753 return typeBuildersToGenTypes(typeBuilder, genTOBuilder);
\r
1757 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
\r
1758 * or to <code>genTOBuilder</code> as property.
\r
1760 * @param basePackageName
\r
1761 * string contains the module package name
\r
1762 * @param schemaNode
\r
1763 * data schema node which should be added as getter method to
\r
1764 * <code>typeBuilder</code> or as a property to
\r
1765 * <code>genTOBuilder</code> if is part of the list key
\r
1766 * @param typeBuilder
\r
1767 * generated type builder for the list schema node
\r
1768 * @param genTOBuilder
\r
1769 * generated TO builder for the list keys
\r
1771 * list of string which contains names of the list keys
\r
1772 * @throws IllegalArgumentException
\r
1774 * <li>if <code>schemaNode</code> equals null</li>
\r
1775 * <li>if <code>typeBuilder</code> equals null</li>
\r
1778 private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
\r
1779 GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {
\r
1780 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
\r
1782 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
1784 if(schemaNode instanceof LeafSchemaNode) {
\r
1785 val leaf = schemaNode as LeafSchemaNode;
\r
1786 val leafName = leaf.QName.localName;
\r
1787 if(!listKeys.contains(leafName)) {
\r
1788 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
\r
1790 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
\r
1792 } else if(schemaNode instanceof LeafListSchemaNode) {
\r
1793 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
\r
1794 } else if(schemaNode instanceof ContainerSchemaNode) {
\r
1795 resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);
\r
1796 } else if(schemaNode instanceof ChoiceNode) {
\r
1797 resolveChoiceSchemaNode(basePackageName,typeBuilder,schemaNode as ChoiceNode);
\r
1798 } else if(schemaNode instanceof ListSchemaNode) {
\r
1799 resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);
\r
1803 private def typeBuildersToGenTypes(GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
\r
1804 val List<Type> genTypes = new ArrayList();
\r
1805 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
1807 if(genTOBuilder !== null) {
\r
1808 val genTO = genTOBuilder.toInstance();
\r
1809 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
\r
1810 genTypes.add(genTO);
\r
1812 genTypes.add(typeBuilder.toInstance());
\r
1817 * Selects the names of the list keys from <code>list</code> and returns
\r
1818 * them as the list of the strings
\r
1821 * of string with names of the list keys
\r
1822 * @return list of string which represents names of the list keys. If the
\r
1823 * <code>list</code> contains no keys then the empty list is
\r
1826 private def listKeys(ListSchemaNode list) {
\r
1827 val List<String> listKeys = new ArrayList();
\r
1829 if(list.keyDefinition !== null) {
\r
1830 val keyDefinitions = list.keyDefinition;
\r
1831 for (keyDefinition : keyDefinitions) {
\r
1832 listKeys.add(keyDefinition.localName);
\r
1839 * Generates for the <code>list</code> which contains any list keys special
\r
1840 * generated TO builder.
\r
1842 * @param packageName
\r
1843 * string with package name to which the list belongs
\r
1845 * list schema node which is source of data about the list name
\r
1846 * @return generated TO builder which represents the keys of the
\r
1847 * <code>list</code> or null if <code>list</code> is null or list of
\r
1848 * key definitions is null or empty.
\r
1850 private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
\r
1851 var GeneratedTOBuilder genTOBuilder = null;
\r
1852 if((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
\r
1853 if(list !== null) {
\r
1854 val listName = list.QName.localName + "Key";
\r
1855 val String genTOName = parseToClassName(listName);
\r
1856 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
\r
1859 return genTOBuilder;
\r
1864 * Builds generated TO builders for <code>typeDef</code> of type
\r
1865 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
\r
1866 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
\r
1867 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
\r
1868 * enclosing transfer object.
\r
1870 * If more then one generated TO builder is created for enclosing then all
\r
1871 * of the generated TO builders are added to <code>typeBuilder</code> as
\r
1872 * enclosing transfer objects.
\r
1875 * type definition which can be of type <code>UnionType</code> or
\r
1876 * <code>BitsTypeDefinition</code>
\r
1877 * @param typeBuilder
\r
1878 * generated type builder to which is added generated TO created
\r
1879 * from <code>typeDef</code>
\r
1881 * string with name for generated TO builder
\r
1882 * @return generated TO builder for <code>typeDef</code>
\r
1884 private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
\r
1885 String leafName, LeafSchemaNode leaf, Module parentModule) {
\r
1886 val classNameFromLeaf = parseToClassName(leafName);
\r
1887 val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
\r
1888 val packageName = typeBuilder.fullyQualifiedName;
\r
1889 if(typeDef instanceof UnionTypeDefinition) {
\r
1890 genTOBuilders.addAll(
\r
1891 (typeProvider as TypeProviderImpl).
\r
1892 provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
\r
1893 classNameFromLeaf, leaf));
\r
1894 } else if(typeDef instanceof BitsTypeDefinition) {
\r
1895 genTOBuilders.add(
\r
1896 ((typeProvider as TypeProviderImpl) ).
\r
1897 provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
\r
1899 if(genTOBuilders !== null && !genTOBuilders.isEmpty()) {
\r
1900 for (genTOBuilder : genTOBuilders) {
\r
1901 typeBuilder.addEnclosingTransferObject(genTOBuilder);
\r
1903 return genTOBuilders.get(0);
\r
1910 * Adds the implemented types to type builder.
\r
1912 * The method passes through the list of <i>uses</i> in
\r
1913 * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding
\r
1914 * generated type from {@link BindingGeneratorImpl#allGroupings
\r
1915 * allGroupings} which is added as <i>implements type</i> to
\r
1916 * <code>builder</code>
\r
1918 * @param dataNodeContainer
\r
1919 * element which contains the list of used YANG groupings
\r
1921 * builder to which are added implemented types according to
\r
1922 * <code>dataNodeContainer</code>
\r
1923 * @return generated type builder with all implemented types
\r
1925 private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
\r
1926 for (usesNode : dataNodeContainer.uses) {
\r
1927 if(usesNode.groupingPath !== null) {
\r
1928 val genType = allGroupings.get(usesNode.groupingPath);
\r
1929 if(genType === null) {
\r
1930 throw new IllegalStateException(
\r
1931 "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
\r
1933 builder.addImplementsType(genType);
\r