2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.sal.binding.generator.impl;
10 import static com.google.common.base.Preconditions.*;
11 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
12 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
13 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
14 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.HashMap;
19 import java.util.List;
22 import java.util.Iterator
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.NotificationDefinition
73 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil
74 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions
75 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder
76 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl
77 import org.opendaylight.yangtools.yang.common.QName
78 import 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
82 import java.util.TreeSet
84 public class BindingGeneratorImpl implements BindingGenerator {
86 private final Map<Module, ModuleContext> genCtx = new HashMap()
89 * Outer key represents the package name. Outer value represents map of
90 * all builders in the same package. Inner key represents the schema node
91 * name (in JAVA class/interface name format). Inner value represents
92 * instance of builder for schema node specified in key part.
94 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
97 * Provide methods for converting YANG types to JAVA types.
99 private var TypeProvider typeProvider;
102 * Holds reference to schema context to resolve data of augmented element
103 * when creating augmentation builder
105 private var SchemaContext schemaContext;
108 * Constant with the concrete name of namespace.
110 private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
113 * Constant with the concrete name of identifier.
115 private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
118 * Resolves generated types from <code>context</code> schema nodes of all
121 * Generated types are created for modules, groupings, types, containers,
122 * lists, choices, augments, rpcs, notification, identities.
125 * schema context which contains data about all schema nodes
127 * @return list of types (usually <code>GeneratedType</code>
128 * <code>GeneratedTransferObject</code>which are generated from
129 * <code>context</code> data.
130 * @throws IllegalArgumentException
131 * if param <code>context</code> is null
132 * @throws IllegalStateException
133 * if <code>context</code> contain no modules
135 override generateTypes(SchemaContext context) {
136 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
137 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
138 schemaContext = context;
139 typeProvider = new TypeProviderImpl(context);
140 val Set<Module> modules = context.modules;
141 return generateTypes(context, modules);
145 * Resolves generated types from <code>context</code> schema nodes only for
146 * modules specified in <code>modules</code>
148 * Generated types are created for modules, groupings, types, containers,
149 * lists, choices, augments, rpcs, notification, identities.
152 * schema context which contains data about all schema nodes
155 * set of modules for which schema nodes should be generated
157 * @return list of types (usually <code>GeneratedType</code> or
158 * <code>GeneratedTransferObject</code>) which:
160 * <li>are generated from <code>context</code> schema nodes and</li>
161 * <li>are also part of some of the module in <code>modules</code>
164 * @throws IllegalArgumentException
166 * <li>if param <code>context</code> is null or</li>
167 * <li>if param <code>modules</code> is null</li>
169 * @throws IllegalStateException
170 * if <code>context</code> contain no modules
172 override generateTypes(SchemaContext context, Set<Module> modules) {
173 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
174 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
175 checkArgument(modules !== null, "Set of Modules cannot be NULL.");
177 schemaContext = context;
178 typeProvider = new TypeProviderImpl(context);
179 val contextModules = ModuleDependencySort.sort(context.modules);
180 genTypeBuilders = new HashMap();
182 for (contextModule : contextModules) {
183 moduleToGenTypes(contextModule, context);
185 for (contextModule : contextModules) {
186 allAugmentsToGenTypes(contextModule);
189 val List<Type> filteredGenTypes = new ArrayList();
190 for (Module m : modules) {
191 val ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m)
192 filteredGenTypes.addAll(ctx.generatedTypes);
193 val Set<Type> additionalTypes = (typeProvider as TypeProviderImpl).additionalTypes.get(m)
194 if (additionalTypes != null) {
195 filteredGenTypes.addAll(additionalTypes)
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
220 * <code>Type</code> objects.
223 * module from which is obtained set of type definitions
224 * @throws IllegalArgumentException
226 * <li>if module equals null</li>
227 * <li>if name of module equals null</li>
228 * <li>if type definitions of module equal null</li>
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 genType.addComment(node.getDescription());
257 if (node instanceof DataNodeContainer) {
258 genCtx.get(module).addChildNodeType(node.path, genType)
259 groupingsToGenTypes(module, (node as DataNodeContainer).groupings)
260 processUsesAugments(node as DataNodeContainer, module)
265 private def void containerToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
266 GeneratedTypeBuilder childOf, ContainerSchemaNode node) {
267 val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
268 if (genType != null) {
269 constructGetter(parent, node.QName.localName, node.description, genType)
270 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.childNodes)
274 private def void listToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
275 GeneratedTypeBuilder childOf, ListSchemaNode node) {
276 val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
277 if (genType != null) {
278 constructGetter(parent, node.QName.localName, node.description, Types.listTypeFor(genType))
280 val List<String> listKeys = listKeys(node);
281 val packageName = packageNameForGeneratedType(basePackageName, (node).path)
282 val genTOBuilder = resolveListKeyTOBuilder(packageName, node);
283 if (genTOBuilder !== null) {
284 val identifierMarker = IDENTIFIER.parameterizedTypeFor(genType);
285 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
286 genTOBuilder.addImplementsType(identifierMarker);
287 genType.addImplementsType(identifiableMarker);
290 for (schemaNode : node.childNodes) {
291 if (!schemaNode.augmenting) {
292 addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
297 if (genTOBuilder !== null) {
298 val GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
299 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder as GeneratedTOBuilderImpl)));
300 genTOBuilder.setSUID(prop);
303 typeBuildersToGenTypes(module, genType, genTOBuilder);
307 private def void processUsesAugments(DataNodeContainer node, Module module) {
308 val basePackageName = moduleNamespaceToPackageName(module);
309 for (usesNode : node.uses) {
310 for (augment : usesNode.augmentations) {
311 usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
312 processUsesAugments(augment, module);
318 * Converts all <b>augmentation</b> of the module to the list
319 * <code>Type</code> objects.
322 * module from which is obtained list of all augmentation objects
323 * to iterate over them
324 * @throws IllegalArgumentException
326 * <li>if the module equals null</li>
327 * <li>if the name of module equals null</li>
328 * <li>if the set of child nodes equals null</li>
332 private def void allAugmentsToGenTypes(Module module) {
333 checkArgument(module !== null, "Module reference cannot be NULL.");
334 checkArgument(module.name !== null, "Module name cannot be NULL.");
335 if (module.childNodes === null) {
336 throw new IllegalArgumentException(
337 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
340 val basePackageName = moduleNamespaceToPackageName(module);
341 val List<AugmentationSchema> augmentations = resolveAugmentations(module);
342 for (augment : augmentations) {
343 augmentationToGenTypes(basePackageName, augment, module);
348 * Returns list of <code>AugmentationSchema</code> objects. The objects are
349 * sorted according to the length of their target path from the shortest to
353 * module from which is obtained list of all augmentation objects
354 * @return list of sorted <code>AugmentationSchema</code> objects obtained
355 * from <code>module</code>
356 * @throws IllegalArgumentException
358 * <li>if the module equals null</li>
359 * <li>if the set of augmentation equals null</li>
363 private def List<AugmentationSchema> resolveAugmentations(Module module) {
364 checkArgument(module !== null, "Module reference cannot be NULL.");
365 checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
367 val Set<AugmentationSchema> augmentations = module.augmentations;
368 var List<AugmentationSchema> sortedAugmentations = getSortedOrNull(augmentations)
369 if (sortedAugmentations != null) {
370 return sortedAugmentations
372 sortedAugmentations = new ArrayList(augmentations);
373 Collections.sort(sortedAugmentations,
374 [ augSchema1, augSchema2 |
375 val Iterator<QName> thisIt = augSchema1.targetPath.getPath().iterator();
376 val Iterator<QName> otherIt = augSchema2.getTargetPath().getPath().iterator();
377 while (thisIt.hasNext()) {
378 if (otherIt.hasNext()) {
379 val int comp = thisIt.next().compareTo(otherIt.next());
387 if (otherIt.hasNext()) {
392 return sortedAugmentations;
395 private def List<AugmentationSchema> getSortedOrNull(Collection<AugmentationSchema> collection) {
396 val TreeSet<AugmentationSchema> set = new TreeSet()
397 for (e : collection) {
398 if (e instanceof Comparable<?>) {
404 return new ArrayList(set.toArray)
408 * Converts whole <b>module</b> to <code>GeneratedType</code> object.
409 * Firstly is created the module builder object from which is vally
410 * obtained reference to <code>GeneratedType</code> object.
413 * module from which are obtained the module name, child nodes,
414 * uses and is derived package name
415 * @return <code>GeneratedType</code> which is internal representation of
417 * @throws IllegalArgumentException
418 * if the module equals null
421 private def GeneratedTypeBuilder moduleToDataType(Module module) {
422 checkArgument(module !== null, "Module reference cannot be NULL.");
424 val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
425 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
426 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
427 moduleDataTypeBuilder.addComment(module.getDescription());
428 return moduleDataTypeBuilder;
432 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
433 * to the list of <code>Type</code> objects. In addition are to containers
434 * and lists which belong to input or output also part of returning list.
437 * module from which is obtained set of all rpc objects to
439 * @throws IllegalArgumentException
441 * <li>if the module equals null</li>
442 * <li>if the name of module equals null</li>
443 * <li>if the set of child nodes equals null</li>
447 private def void rpcMethodsToGenType(Module module) {
448 checkArgument(module !== null, "Module reference cannot be NULL.");
449 checkArgument(module.name !== null, "Module name cannot be NULL.");
450 checkArgument(module.childNodes !== null,
451 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
453 val basePackageName = moduleNamespaceToPackageName(module);
454 val Set<RpcDefinition> rpcDefinitions = module.rpcs;
455 if (rpcDefinitions.isEmpty()) {
459 val interfaceBuilder = moduleTypeBuilder(module, "Service");
460 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
461 for (rpc : rpcDefinitions) {
463 val rpcName = BindingMapping.getClassName(rpc.QName);
464 val rpcMethodName = parseToValidParamName(rpcName);
465 val rpcComment = rpc.getDescription();
466 val method = interfaceBuilder.addMethod(rpcMethodName);
468 val input = rpc.input;
469 val output = rpc.output;
471 if (input !== null) {
472 val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
473 addImplementedInterfaceFromUses(input, inType);
474 inType.addImplementsType(DATA_OBJECT);
475 inType.addImplementsType(augmentable(inType));
476 resolveDataSchemaNodes(module, basePackageName, inType, inType, input.childNodes);
477 genCtx.get(module).addChildNodeType(input.path, inType)
478 val inTypeInstance = inType.toInstance();
479 method.addParameter(inTypeInstance, "input");
482 var Type outTypeInstance = VOID;
483 if (output !== null) {
484 val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
485 addImplementedInterfaceFromUses(output, outType);
486 outType.addImplementsType(DATA_OBJECT);
487 outType.addImplementsType(augmentable(outType));
488 resolveDataSchemaNodes(module, basePackageName, outType, outType, output.childNodes);
489 genCtx.get(module).addChildNodeType(output.path, outType)
490 outTypeInstance = outType.toInstance();
493 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
494 method.setComment(rpcComment);
495 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
500 genCtx.get(module).addTopLevelNodeType(interfaceBuilder)
504 * Converts all <b>notifications</b> of the module to the list of
505 * <code>Type</code> objects. In addition are to this list added containers
506 * and lists which are part of this notification.
509 * module from which is obtained set of all notification objects
510 * to iterate over them
511 * @throws IllegalArgumentException
513 * <li>if the module equals null</li>
514 * <li>if the name of module equals null</li>
515 * <li>if the set of child nodes equals null</li>
519 private def void notificationsToGenType(Module module) {
520 checkArgument(module !== null, "Module reference cannot be NULL.");
521 checkArgument(module.name !== null, "Module name cannot be NULL.");
523 if (module.childNodes === null) {
524 throw new IllegalArgumentException(
525 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
527 val notifications = module.notifications;
528 if(notifications.empty) return;
530 val listenerInterface = moduleTypeBuilder(module, "Listener");
531 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
532 val basePackageName = moduleNamespaceToPackageName(module);
534 for (notification : notifications) {
535 if (notification !== null) {
536 processUsesAugments(notification, module);
538 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification,
539 BindingTypes.DATA_OBJECT);
540 notificationInterface.addImplementsType(NOTIFICATION);
541 genCtx.get(module).addChildNodeType(notification.path, notificationInterface)
543 // Notification object
544 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
545 notification.childNodes);
547 listenerInterface.addMethod("on" + notificationInterface.name) //
548 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
549 setComment(notification.getDescription()).setReturnType(Types.VOID);
553 genCtx.get(module).addTopLevelNodeType(listenerInterface)
557 * Converts all <b>identities</b> of the module to the list of
558 * <code>Type</code> objects.
561 * module from which is obtained set of all identity objects to
564 * schema context only used as input parameter for method
565 * {@link identityToGenType}
568 private def void allIdentitiesToGenTypes(Module module, SchemaContext context) {
569 val Set<IdentitySchemaNode> schemaIdentities = module.identities;
570 val basePackageName = moduleNamespaceToPackageName(module);
572 if (schemaIdentities !== null && !schemaIdentities.isEmpty()) {
573 for (identity : schemaIdentities) {
574 identityToGenType(module, basePackageName, identity, context);
580 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
581 * created transport object builder. If identity contains base identity then
582 * reference to base identity is added to superior identity as its extend.
583 * If identity doesn't contain base identity then only reference to abstract
584 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
585 * BaseIdentity} is added
587 * @param module current module
588 * @param basePackageName
589 * string contains the module package name
591 * IdentitySchemaNode which contains data about identity
593 * SchemaContext which is used to get package and name
594 * information about base of identity
597 private def void identityToGenType(Module module, String basePackageName, IdentitySchemaNode identity,
598 SchemaContext context) {
599 if (identity === null) {
602 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
603 val genTypeName = BindingMapping.getClassName(identity.QName);
604 val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
605 val baseIdentity = identity.baseIdentity;
606 if (baseIdentity === null) {
607 newType.setExtendsType(Types.baseIdentityTO);
609 val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
610 val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
611 val returnTypeName = BindingMapping.getClassName(baseIdentity.QName);
612 val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
613 newType.setExtendsType(gto);
615 newType.setAbstract(true);
616 newType.addComment(identity.getDescription());
617 val qname = identity.QName;
619 newType.qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,qname);
621 genCtx.get(module).addIdentityType(identity.QName,newType)
624 private static def qnameConstant(GeneratedTypeBuilderBase<?> toBuilder, String constantName, QName name) {
625 toBuilder.addConstant(QName.typeForClass,constantName,'''
626 org.opendaylight.yangtools.yang.common.QName.create("«name.namespace»","«name.formattedRevision»","«name.localName»")
631 * Converts all <b>groupings</b> of the module to the list of
632 * <code>Type</code> objects. Firstly are groupings sorted according mutual
633 * dependencies. At least dependent (independent) groupings are in the list
634 * saved at first positions. For every grouping the record is added to map
635 * {@link BindingGeneratorImpl#allGroupings allGroupings}
639 * @param collection of groupings from which types will be generated
642 private def void groupingsToGenTypes(Module module, Collection<GroupingDefinition> groupings) {
643 val basePackageName = moduleNamespaceToPackageName(module);
644 val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
646 for (grouping : groupingsSortedByDependencies) {
647 groupingToGenType(basePackageName, grouping, module);
652 * Converts individual grouping to GeneratedType. Firstly generated type
653 * builder is created and every child node of grouping is resolved to the
656 * @param basePackageName
657 * string contains the module package name
659 * GroupingDefinition which contains data about grouping
660 * @param module current module
661 * @return GeneratedType which is generated from grouping (object of type
662 * <code>GroupingDefinition</code>)
664 private def void groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
665 val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
666 val genType = addDefaultInterfaceDefinition(packageName, grouping);
667 genCtx.get(module).addGroupingType(grouping.path, genType)
668 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.childNodes);
669 groupingsToGenTypes(module, grouping.groupings);
670 processUsesAugments(grouping, module);
674 * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
675 * type of <code>typeDefinition</code> is of the type ExtendedType then this
676 * method is recursively called with this base type.
678 * @param typeDefinition
679 * TypeDefinition in which should be EnumTypeDefinition found as
681 * @return EnumTypeDefinition if it is found inside
682 * <code>typeDefinition</code> or <code>null</code> in other case
684 private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
685 if (typeDefinition !== null) {
686 if (typeDefinition.baseType instanceof EnumTypeDefinition) {
687 return typeDefinition.baseType as EnumTypeDefinition;
688 } else if (typeDefinition.baseType instanceof ExtendedType) {
689 return enumTypeDefFromExtendedType(typeDefinition.baseType);
696 * Adds enumeration builder created from <code>enumTypeDef</code> to
697 * <code>typeBuilder</code>.
699 * Each <code>enumTypeDef</code> item is added to builder with its name and
703 * EnumTypeDefinition contains enum data
705 * string contains name which will be assigned to enumeration
708 * GeneratedTypeBuilder to which will be enum builder assigned
709 * @return enumeration builder which contains data from
710 * <code>enumTypeDef</code>
712 private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, QName enumName,
713 GeneratedTypeBuilder typeBuilder) {
714 if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
715 (enumTypeDef.QName.localName !== null)) {
716 val enumerationName = BindingMapping.getClassName(enumName);
717 val enumBuilder = typeBuilder.addEnumeration(enumerationName);
718 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
725 * Generates type builder for <code>module</code>.
728 * Module which is source of package name for generated type
731 * string which is added to the module class name representation
733 * @return instance of GeneratedTypeBuilder which represents
734 * <code>module</code>.
735 * @throws IllegalArgumentException
736 * if <code>module</code> equals null
738 private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
739 checkArgument(module !== null, "Module reference cannot be NULL.");
740 val packageName = moduleNamespaceToPackageName(module);
741 val moduleName = BindingMapping.getClassName(module.name) + postfix;
742 return new GeneratedTypeBuilderImpl(packageName, moduleName);
746 * Converts <code>augSchema</code> to list of <code>Type</code> which
747 * contains generated type for augmentation. In addition there are also
748 * generated types for all containers, list and choices which are child of
749 * <code>augSchema</code> node or a generated types for cases are added if
750 * augmented node is choice.
752 * @param augmentPackageName
753 * string with the name of the package to which the augmentation
756 * AugmentationSchema which is contains data about augmentation
757 * (target path, childs...)
758 * @param module current module
759 * @param parentUsesNode parent uses node of this augment (can be null if this augment is not defined under uses statement)
760 * @throws IllegalArgumentException
762 * <li>if <code>augmentPackageName</code> equals null</li>
763 * <li>if <code>augSchema</code> equals null</li>
764 * <li>if target path of <code>augSchema</code> equals null</li>
767 private def void augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module) {
768 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
769 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
770 checkState(augSchema.targetPath !== null,
771 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
773 processUsesAugments(augSchema, module);
774 val targetPath = augSchema.targetPath;
775 var SchemaNode targetSchemaNode = null
777 targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
778 if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
779 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode, schemaContext);
780 if (targetSchemaNode == null) {
781 throw new NullPointerException(
782 "Failed to find target node from grouping in augmentation " + augSchema + " in module " +
786 if (targetSchemaNode == null) {
787 throw new IllegalArgumentException("augment target not found: " + targetPath)
790 var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
791 if (targetTypeBuilder === null) {
792 targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
794 if (targetTypeBuilder === null) {
795 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
798 if (!(targetSchemaNode instanceof ChoiceNode)) {
799 var packageName = augmentPackageName;
800 val targetType = new ReferencedTypeImpl(targetTypeBuilder.packageName,targetTypeBuilder.name);
801 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,targetType, augSchema);
804 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
805 targetSchemaNode as ChoiceNode, augSchema.childNodes);
809 private def void usesAugmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
810 UsesNode usesNode, DataNodeContainer usesNodeParent) {
811 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
812 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
813 checkState(augSchema.targetPath !== null,
814 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
816 processUsesAugments(augSchema, module);
817 val targetPath = augSchema.targetPath;
818 var SchemaNode targetSchemaNode = null
819 targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
820 if (targetSchemaNode == null) {
821 throw new IllegalArgumentException("augment target not found: " + targetPath)
824 var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
825 if (targetTypeBuilder === null) {
826 targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
828 if (targetTypeBuilder === null) {
829 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
832 if (!(targetSchemaNode instanceof ChoiceNode)) {
833 var packageName = augmentPackageName;
834 if (usesNodeParent instanceof SchemaNode) {
835 packageName = packageNameForGeneratedType(augmentPackageName, (usesNodeParent as SchemaNode).path, true)
837 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
838 targetTypeBuilder.toInstance, augSchema);
840 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
841 targetSchemaNode as ChoiceNode, augSchema.childNodes);
846 * Convenient method to find node added by uses statement.
848 private def DataSchemaNode findOriginalTargetFromGrouping(SchemaPath targetPath, UsesNode parentUsesNode) {
849 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
850 if (!(targetGrouping instanceof GroupingDefinition)) {
851 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
854 var grouping = targetGrouping as GroupingDefinition;
855 var SchemaNode result = grouping;
856 val List<QName> path = targetPath.path
858 // finding by local name is valid, grouping cannot contain nodes with same name and different namespace
859 if (result instanceof DataNodeContainer) {
860 result = (result as DataNodeContainer).getDataChildByName(node.localName)
861 } else if (result instanceof ChoiceNode) {
862 result = (result as ChoiceNode).getCaseNodeByName(node.localName)
865 if (result == null) {
869 var boolean fromUses = (result as DataSchemaNode).addedByUses
870 var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
871 while (groupingUses.hasNext && fromUses) {
872 result = findOriginalTargetFromGrouping(targetPath, groupingUses.next);
873 if (result != null) {
874 fromUses = (result as DataSchemaNode).addedByUses
878 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
881 return result as DataSchemaNode
885 * Returns a generated type builder for an augmentation.
887 * The name of the type builder is equal to the name of augmented node with
888 * serial number as suffix.
890 * @param module current module
891 * @param augmentPackageName
892 * string with contains the package name to which the augment
894 * @param basePackageName
895 * string with the package name to which the augmented node
897 * @param targetTypeRef
900 * augmentation schema which contains data about the child nodes
901 * and uses of augment
902 * @return generated type builder for augment
904 private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
905 String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
906 var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
907 if (augmentBuilders === null) {
908 augmentBuilders = new HashMap();
909 genTypeBuilders.put(augmentPackageName, augmentBuilders);
911 val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
913 val augTypeName = if (augIdentifier !== null) {
914 BindingMapping.getClassName(augIdentifier)
916 augGenTypeName(augmentBuilders, targetTypeRef.name);
919 val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
921 augTypeBuilder.addImplementsType(DATA_OBJECT);
922 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
923 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
925 augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
926 augmentBuilders.put(augTypeName, augTypeBuilder);
928 genCtx.get(module).addTargetToAugmentation(targetTypeRef,augTypeBuilder);
929 genCtx.get(module).addAugmentType(augTypeBuilder);
930 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
931 return augTypeBuilder;
936 * @param unknownSchemaNodes
937 * @return nodeParameter of UnknownSchemaNode
939 private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
940 for (unknownSchemaNode : unknownSchemaNodes) {
941 val nodeType = unknownSchemaNode.nodeType;
942 if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
943 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
944 return unknownSchemaNode.nodeParameter;
951 * Returns first unique name for the augment generated type builder. The
952 * generated type builder name for augment consists from name of augmented
953 * node and serial number of its augmentation.
956 * map of builders which were created in the package to which the
957 * augmentation belongs
959 * string with name of augmented node
960 * @return string with unique name for augmentation builder
962 private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
964 while ((builders !== null) && builders.containsKey(genTypeName + index)) {
967 return genTypeName + index;
971 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
972 * node for which <code>typeBuilder</code> was created.
974 * The subnodes aren't mapped to the methods if they are part of grouping or
975 * augment (in this case are already part of them).
977 * @param module current module
978 * @param basePackageName
979 * string contains the module package name
981 * generated type builder which represents any node. The subnodes
982 * of this node are added to the <code>typeBuilder</code> as
983 * methods. The subnode can be of type leaf, leaf-list, list,
985 * @param childOf parent type
987 * set of data schema nodes which are the children of the node
988 * for which <code>typeBuilder</code> was created
989 * @return generated type builder which is the same builder as input
990 * parameter. The getter methods (representing child nodes) could be
993 private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
994 GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
995 if ((schemaNodes !== null) && (parent !== null)) {
996 for (schemaNode : schemaNodes) {
997 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
998 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1006 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
1007 * node for which <code>typeBuilder</code> was created.
1009 * @param module current module
1010 * @param basePackageName
1011 * string contains the module package name
1012 * @param typeBuilder
1013 * generated type builder which represents any node. The subnodes
1014 * of this node are added to the <code>typeBuilder</code> as
1015 * methods. The subnode can be of type leaf, leaf-list, list,
1016 * container, choice.
1017 * @param childOf parent type
1018 * @param schemaNodes
1019 * set of data schema nodes which are the children of the node
1020 * for which <code>typeBuilder</code> was created
1021 * @return generated type builder which is the same object as the input
1022 * parameter <code>typeBuilder</code>. The getter method could be
1025 private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1026 GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1027 if ((schemaNodes !== null) && (typeBuilder !== null)) {
1028 for (schemaNode : schemaNodes) {
1029 if (!schemaNode.isAugmenting()) {
1030 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1038 * Adds to <code>typeBuilder</code> a method which is derived from
1039 * <code>schemaNode</code>.
1041 * @param basePackageName
1042 * string with the module package name
1044 * data schema node which is added to <code>typeBuilder</code> as
1046 * @param typeBuilder
1047 * generated type builder to which is <code>schemaNode</code>
1048 * added as a method.
1049 * @param childOf parent type
1050 * @param module current module
1052 private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1053 GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1054 if (node !== null && typeBuilder !== null) {
1056 case node instanceof LeafSchemaNode:
1057 resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1058 case node instanceof LeafListSchemaNode:
1059 resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1060 case node instanceof ContainerSchemaNode:
1061 containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1062 case node instanceof ListSchemaNode:
1063 listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1064 case node instanceof ChoiceNode:
1065 choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1071 * Converts <code>choiceNode</code> to the list of generated types for
1072 * choice and its cases.
1074 * The package names for choice and for its cases are created as
1075 * concatenation of the module package (<code>basePackageName</code>) and
1076 * names of all parents node.
1078 * @param module current module
1079 * @param basePackageName
1080 * string with the module package name
1081 * @param parent parent type
1082 * @param childOf concrete parent for case child nodes
1084 * choice node which is mapped to generated type. Also child
1085 * nodes - cases are mapped to generated types.
1086 * @throws IllegalArgumentException
1088 * <li>if <code>basePackageName</code> equals null</li>
1089 * <li>if <code>choiceNode</code> equals null</li>
1093 private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1094 ChoiceNode choiceNode) {
1095 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1096 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1098 if (!choiceNode.addedByUses) {
1099 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1100 val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1101 constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1102 choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1103 genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1104 generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1109 * Converts <code>caseNodes</code> set to list of corresponding generated
1112 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1113 * created generated type builder. The package names for the builder is
1114 * created as concatenation of the module package (
1115 * <code>basePackageName</code>) and names of all parents nodes of the
1116 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1117 * between every case builder and <i>choice</i> type
1119 * @param basePackageName
1120 * string with the module package name
1121 * @param refChoiceType
1122 * type which represents superior <i>case</i>
1124 * set of choice case nodes which are mapped to generated types
1125 * @return list of generated types for <code>caseNodes</code>.
1126 * @throws IllegalArgumentException
1128 * <li>if <code>basePackageName</code> equals null</li>
1129 * <li>if <code>refChoiceType</code> equals null</li>
1130 * <li>if <code>caseNodes</code> equals null</li>
1134 private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1135 GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1136 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1137 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1138 checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1140 val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1141 if (caseNodes == null) {
1145 for (caseNode : caseNodes) {
1146 if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1147 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1148 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1149 caseTypeBuilder.addImplementsType(refChoiceType)
1150 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1151 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder,caseNode)
1152 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1153 if (caseChildNodes !== null) {
1154 var Object parentNode = null
1155 val SchemaPath nodeSp = choiceNode.path
1156 val List<QName> nodeNames = nodeSp.path
1157 val List<QName> nodeNewNames = new ArrayList(nodeNames)
1158 nodeNewNames.remove(nodeNewNames.size - 1)
1159 val SchemaPath nodeNewSp = SchemaPath.create(nodeNewNames, nodeSp.absolute)
1160 parentNode = findDataSchemaNode(schemaContext, nodeNewSp)
1162 var SchemaNode parent
1163 if (parentNode instanceof AugmentationSchema) {
1164 val augSchema = parentNode as AugmentationSchema;
1165 val targetPath = augSchema.targetPath;
1166 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1167 if (targetSchemaNode instanceof DataSchemaNode &&
1168 (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1169 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode, schemaContext);
1170 if (targetSchemaNode == null) {
1171 throw new NullPointerException(
1172 "Failed to find target node from grouping for augmentation " + augSchema +
1173 " in module " + module.name);
1176 parent = targetSchemaNode
1178 val SchemaPath sp = choiceNode.path
1179 val List<QName> names = sp.path
1180 val List<QName> newNames = new ArrayList(names)
1181 newNames.remove(newNames.size - 1)
1182 val SchemaPath newSp = SchemaPath.create(newNames, sp.absolute)
1183 parent = findDataSchemaNode(schemaContext, newSp)
1185 var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1186 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1190 processUsesAugments(caseNode, module);
1195 * Generates list of generated types for all the cases of a choice which are
1196 * added to the choice through the augment.
1199 * @param basePackageName
1200 * string contains name of package to which augment belongs. If
1201 * an augmented choice is from an other package (pcg1) than an
1202 * augmenting choice (pcg2) then case's of the augmenting choice
1203 * will belong to pcg2.
1204 * @param refChoiceType
1205 * Type which represents the choice to which case belongs. Every
1206 * case has to contain its choice in extend part.
1208 * set of choice case nodes for which is checked if are/aren't
1209 * added to choice through augmentation
1210 * @return list of generated types which represents augmented cases of
1211 * choice <code>refChoiceType</code>
1212 * @throws IllegalArgumentException
1214 * <li>if <code>basePackageName</code> equals null</li>
1215 * <li>if <code>refChoiceType</code> equals null</li>
1216 * <li>if <code>caseNodes</code> equals null</li>
1219 private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1220 ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1221 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1222 checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1223 checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1225 for (caseNode : augmentedNodes) {
1226 if (caseNode !== null) {
1227 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1228 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1229 caseTypeBuilder.addImplementsType(targetType);
1231 var SchemaNode parent = null
1232 val SchemaPath nodeSp = targetNode.path
1233 val List<QName> nodeNames = nodeSp.path
1234 val List<QName> nodeNewNames = new ArrayList(nodeNames)
1235 nodeNewNames.remove(nodeNewNames.size - 1)
1236 val SchemaPath nodeNewSp = SchemaPath.create(nodeNewNames, nodeSp.absolute)
1237 parent = findDataSchemaNode(schemaContext, nodeNewSp)
1239 var GeneratedTypeBuilder childOfType = null;
1240 if (parent instanceof Module) {
1241 childOfType = genCtx.get(parent as Module).moduleNode
1242 } else if (parent instanceof ChoiceCaseNode) {
1243 childOfType = findCaseByPath(parent.path)
1244 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1245 childOfType = findChildNodeByPath(parent.path)
1246 } else if (parent instanceof GroupingDefinition) {
1247 childOfType = findGroupingByPath(parent.path);
1250 if (childOfType == null) {
1251 throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1254 var ChoiceCaseNode node = null;
1255 if (caseNode instanceof ChoiceCaseNode) {
1256 node = caseNode as ChoiceCaseNode;
1258 node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1260 val Set<DataSchemaNode> childNodes = node.childNodes;
1261 if (childNodes !== null) {
1262 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1264 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1265 genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder,node);
1272 * Converts <code>leaf</code> to the getter method which is added to
1273 * <code>typeBuilder</code>.
1275 * @param typeBuilder
1276 * generated type builder to which is added getter method as
1277 * <code>leaf</code> mapping
1279 * leaf schema node which is mapped as getter method which is
1280 * added to <code>typeBuilder</code>
1281 * @return boolean value
1283 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
1285 * <li>true - in other cases</li>
1288 private def Type resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1289 var Type returnType = null;
1290 if ((leaf !== null) && (typeBuilder !== null)) {
1291 val leafName = leaf.QName.localName;
1292 var String leafDesc = leaf.description;
1293 if (leafDesc === null) {
1297 val parentModule = findParentModule(schemaContext, leaf);
1298 if (leafName !== null && !leaf.isAddedByUses()) {
1299 val TypeDefinition<?> typeDef = leaf.type;
1301 var GeneratedTOBuilder genTOBuilder;
1302 if (typeDef instanceof EnumTypeDefinition) {
1303 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1304 val enumTypeDef = typeDef as EnumTypeDefinition;
1305 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.QName, typeBuilder);
1307 if (enumBuilder !== null) {
1308 returnType = enumBuilder.toInstance(typeBuilder)
1310 (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1311 } else if (typeDef instanceof UnionType) {
1312 genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1313 if (genTOBuilder !== null) {
1314 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)
1316 } else if (typeDef instanceof BitsTypeDefinition) {
1317 genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1318 if (genTOBuilder !== null) {
1319 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1322 val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1323 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1325 if (returnType !== null) {
1326 val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1327 processContextRefExtension(leaf, getter, parentModule);
1334 private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1335 for (node : leaf.unknownSchemaNodes) {
1336 val nodeType = node.nodeType;
1337 if ("context-reference".equals(nodeType.localName)) {
1338 val nodeParam = node.nodeParameter;
1339 var IdentitySchemaNode identity = null;
1340 var String basePackageName = null;
1341 val String[] splittedElement = nodeParam.split(":");
1342 if (splittedElement.length == 1) {
1343 identity = findIdentityByName(module.identities, splittedElement.get(0));
1344 basePackageName = moduleNamespaceToPackageName(module);
1345 } else if (splittedElement.length == 2) {
1346 var prefix = splittedElement.get(0);
1347 val Module dependentModule = findModuleFromImports(module.imports, prefix)
1348 if (dependentModule == null) {
1349 throw new IllegalArgumentException(
1350 "Failed to process context-reference: unknown prefix " + prefix);
1352 identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1353 basePackageName = moduleNamespaceToPackageName(dependentModule);
1355 throw new IllegalArgumentException(
1356 "Failed to process context-reference: unknown identity " + nodeParam);
1358 if (identity == null) {
1359 throw new IllegalArgumentException(
1360 "Failed to process context-reference: unknown identity " + nodeParam);
1363 val Class<RoutingContext> clazz = typeof(RoutingContext);
1364 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1365 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1366 val genTypeName = BindingMapping.getClassName(identity.QName.localName);
1367 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1372 private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1373 for (id : identities) {
1374 if (id.QName.localName.equals(name)) {
1381 private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1382 for (imp : imports) {
1383 if (imp.prefix.equals(prefix)) {
1384 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1390 private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1391 boolean isReadOnly, Module module) {
1392 if ((leaf !== null) && (toBuilder !== null)) {
1393 val leafName = leaf.QName.localName;
1394 var String leafDesc = leaf.description;
1395 if (leafDesc === null) {
1399 if (leafName !== null) {
1400 var Type returnType = null;
1401 val TypeDefinition<?> typeDef = leaf.type;
1402 if (typeDef instanceof UnionTypeDefinition) {
1403 // GeneratedType for this type definition should be already created
1404 var qname = typeDef.QName
1405 var Module unionModule = null
1406 if (qname.prefix == null || qname.prefix.empty) {
1407 unionModule = module
1409 unionModule = findModuleFromImports(module.imports, qname.prefix)
1411 val ModuleContext mc = genCtx.get(unionModule)
1412 returnType = mc.typedefs.get(typeDef.path)
1414 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1416 return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly)
1423 * Converts <code>leaf</code> schema node to property of generated TO
1427 * generated TO builder to which is <code>leaf</code> added as
1430 * leaf schema node which is added to <code>toBuilder</code> as
1432 * @param returnType property type
1434 * boolean value which says if leaf property is|isn't read only
1435 * @return boolean value
1437 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
1438 * name equals null or if leaf is added by <i>uses</i>.</li>
1439 * <li>true - other cases</li>
1442 private def resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf, Type returnType,
1443 boolean isReadOnly) {
1444 if (returnType == null) {
1447 val leafName = leaf.QName.localName
1448 val leafDesc = leaf.description
1449 val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1450 propBuilder.setReadOnly(isReadOnly);
1451 propBuilder.setReturnType(returnType);
1452 propBuilder.setComment(leafDesc);
1453 toBuilder.addEqualsIdentity(propBuilder);
1454 toBuilder.addHashIdentity(propBuilder);
1455 toBuilder.addToStringProperty(propBuilder);
1460 * Converts <code>node</code> leaf list schema node to getter method of
1461 * <code>typeBuilder</code>.
1463 * @param typeBuilder
1464 * generated type builder to which is <code>node</code> added as
1467 * leaf list schema node which is added to
1468 * <code>typeBuilder</code> as getter method
1469 * @return boolean value
1471 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
1472 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
1473 * <li>false - other cases</li>
1476 private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1477 if ((node !== null) && (typeBuilder !== null)) {
1478 val nodeName = node.QName;
1479 var String nodeDesc = node.description;
1480 if (nodeDesc === null) {
1483 if (nodeName !== null && !node.isAddedByUses()) {
1484 val TypeDefinition<?> typeDef = node.type;
1485 val parentModule = findParentModule(schemaContext, node);
1487 var Type returnType = null;
1488 if (typeDef instanceof EnumTypeDefinition) {
1489 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
1490 val enumTypeDef = typeDef as EnumTypeDefinition;
1491 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, typeBuilder);
1492 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1493 (typeProvider as TypeProviderImpl).putReferencedType(node.path, returnType);
1494 } else if (typeDef instanceof UnionType) {
1495 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1496 if (genTOBuilder !== null) {
1497 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)
1499 } else if (typeDef instanceof BitsTypeDefinition) {
1500 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1501 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1503 val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1504 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1507 val listType = Types.listTypeFor(returnType);
1508 constructGetter(typeBuilder, nodeName.localName, nodeDesc, listType);
1515 private def Type createReturnTypeForUnion(GeneratedTOBuilder genTOBuilder, TypeDefinition<?> typeDef,
1516 GeneratedTypeBuilder typeBuilder, Module parentModule) {
1517 val GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.packageName, genTOBuilder.name)
1518 genTOBuilder.setTypedef(true);
1519 genTOBuilder.setIsUnion(true);
1520 (typeProvider as TypeProviderImpl).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1523 val GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
1524 genTOBuilder.getName() + "Builder");
1525 unionBuilder.setIsUnionBuilder(true);
1526 val MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1527 method.setReturnType(returnType);
1528 method.addParameter(Types.STRING, "defaultValue");
1529 method.setAccessModifier(AccessModifier.PUBLIC);
1530 method.setStatic(true);
1532 val Set<Type> types = (typeProvider as TypeProviderImpl).additionalTypes.get(parentModule);
1533 if (types == null) {
1534 (typeProvider as TypeProviderImpl).additionalTypes.put(parentModule,
1535 Sets.newHashSet(unionBuilder.toInstance))
1537 types.add(unionBuilder.toInstance)
1539 return returnType.toInstance
1542 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1543 return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1547 * Instantiates generated type builder with <code>packageName</code> and
1548 * <code>schemaNode</code>.
1550 * The new builder always implements
1551 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
1552 * If <code>schemaNode</code> is instance of GroupingDefinition it also
1553 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
1554 * Augmentable}.<br />
1555 * If <code>schemaNode</code> is instance of
1556 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
1557 * DataNodeContainer} it can also implement nodes which are specified in
1560 * @param packageName
1561 * string with the name of the package to which
1562 * <code>schemaNode</code> belongs.
1564 * schema node for which is created generated type builder
1565 * @param parent parent type (can be null)
1566 * @return generated type builder <code>schemaNode</code>
1568 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1570 val it = addRawInterfaceDefinition(packageName, schemaNode, "");
1571 if (parent === null) {
1572 addImplementsType(DATA_OBJECT);
1574 addImplementsType(BindingTypes.childOf(parent));
1576 if (!(schemaNode instanceof GroupingDefinition)) {
1577 addImplementsType(augmentable(it));
1580 if (schemaNode instanceof DataNodeContainer) {
1581 addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1588 * Wraps the calling of the same overloaded method.
1590 * @param packageName
1591 * string with the package name to which returning generated type
1594 * schema node which provide data about the schema node name
1595 * @return generated type builder for <code>schemaNode</code>
1597 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1598 return addRawInterfaceDefinition(packageName, schemaNode, "");
1602 * Returns reference to generated type builder for specified
1603 * <code>schemaNode</code> with <code>packageName</code>.
1605 * Firstly the generated type builder is searched in
1606 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
1607 * found it is created and added to <code>genTypeBuilders</code>.
1609 * @param packageName
1610 * string with the package name to which returning generated type
1613 * schema node which provide data about the schema node name
1614 * @param prefix return type name prefix
1615 * @return generated type builder for <code>schemaNode</code>
1616 * @throws IllegalArgumentException
1618 * <li>if <code>schemaNode</code> equals null</li>
1619 * <li>if <code>packageName</code> equals null</li>
1620 * <li>if Q name of schema node is null</li>
1621 * <li>if schema node name is null</li>
1625 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1627 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1628 checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1629 checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1630 val schemaNodeName = schemaNode.QName.localName;
1631 checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1633 var String genTypeName;
1634 if (prefix === null) {
1635 genTypeName = BindingMapping.getClassName(schemaNodeName);
1637 genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1640 //FIXME: Validation of name conflict
1641 val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1642 qnameConstant(newType,BindingMapping.QNAME_STATIC_FIELD_NAME,schemaNode.QName);
1643 newType.addComment(schemaNode.getDescription());
1644 if (!genTypeBuilders.containsKey(packageName)) {
1645 val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1646 builders.put(genTypeName, newType);
1647 genTypeBuilders.put(packageName, builders);
1649 val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1650 if (!builders.containsKey(genTypeName)) {
1651 builders.put(genTypeName, newType);
1658 * Creates the name of the getter method name from <code>localName</code>.
1661 * string with the name of the getter method
1662 * @param returnType return type
1663 * @return string with the name of the getter method for
1664 * <code>methodName</code> in JAVA method format
1666 public static def String getterMethodName(String localName, Type returnType) {
1667 val method = new StringBuilder();
1668 if (BOOLEAN.equals(returnType)) {
1669 method.append("is");
1671 method.append("get");
1673 method.append(BindingMapping.getPropertyName(localName).toFirstUpper);
1674 return method.toString();
1678 * Created a method signature builder as part of
1679 * <code>interfaceBuilder</code>.
1681 * The method signature builder is created for the getter method of
1682 * <code>schemaNodeName</code>. Also <code>comment</code> and
1683 * <code>returnType</code> information are added to the builder.
1685 * @param interfaceBuilder
1686 * generated type builder for which the getter method should be
1688 * @param schemaNodeName
1689 * string with schema node name. The name will be the part of the
1690 * getter method name.
1692 * string with comment for the getter method
1694 * type which represents the return type of the getter method
1695 * @return method signature builder which represents the getter method of
1696 * <code>interfaceBuilder</code>
1698 private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1699 String comment, Type returnType) {
1700 val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1701 getMethod.setComment(comment);
1702 getMethod.setReturnType(returnType);
1707 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1708 * or to <code>genTOBuilder</code> as property.
1710 * @param basePackageName
1711 * string contains the module package name
1713 * data schema node which should be added as getter method to
1714 * <code>typeBuilder</code> or as a property to
1715 * <code>genTOBuilder</code> if is part of the list key
1716 * @param typeBuilder
1717 * generated type builder for the list schema node
1718 * @param genTOBuilder
1719 * generated TO builder for the list keys
1721 * list of string which contains names of the list keys
1722 * @param module current module
1723 * @throws IllegalArgumentException
1725 * <li>if <code>schemaNode</code> equals null</li>
1726 * <li>if <code>typeBuilder</code> equals null</li>
1729 private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1730 GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1731 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1732 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1734 if (schemaNode instanceof LeafSchemaNode) {
1735 val leaf = schemaNode as LeafSchemaNode;
1736 val leafName = leaf.QName.localName;
1737 val Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1738 if (listKeys.contains(leafName)) {
1740 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module)
1742 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true)
1745 } else if (!schemaNode.addedByUses) {
1746 if (schemaNode instanceof LeafListSchemaNode) {
1747 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1748 } else if (schemaNode instanceof ContainerSchemaNode) {
1749 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1750 } else if (schemaNode instanceof ChoiceNode) {
1751 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1752 } else if (schemaNode instanceof ListSchemaNode) {
1753 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1758 private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1759 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1761 if (genTOBuilder !== null) {
1762 val genTO = genTOBuilder.toInstance();
1763 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1764 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1769 * Selects the names of the list keys from <code>list</code> and returns
1770 * them as the list of the strings
1773 * of string with names of the list keys
1774 * @return list of string which represents names of the list keys. If the
1775 * <code>list</code> contains no keys then the empty list is
1778 private def listKeys(ListSchemaNode list) {
1779 val List<String> listKeys = new ArrayList();
1781 if (list.keyDefinition !== null) {
1782 val keyDefinitions = list.keyDefinition;
1783 for (keyDefinition : keyDefinitions) {
1784 listKeys.add(keyDefinition.localName);
1791 * Generates for the <code>list</code> which contains any list keys special
1792 * generated TO builder.
1794 * @param packageName
1795 * string with package name to which the list belongs
1797 * list schema node which is source of data about the list name
1798 * @return generated TO builder which represents the keys of the
1799 * <code>list</code> or null if <code>list</code> is null or list of
1800 * key definitions is null or empty.
1802 private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1803 var GeneratedTOBuilder genTOBuilder = null;
1804 if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1805 val listName = list.QName.localName + "Key";
1806 val String genTOName = BindingMapping.getClassName(listName);
1807 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1809 return genTOBuilder;
1813 * Builds generated TO builders for <code>typeDef</code> of type
1814 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
1815 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
1816 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
1817 * enclosing transfer object.
1819 * If more then one generated TO builder is created for enclosing then all
1820 * of the generated TO builders are added to <code>typeBuilder</code> as
1821 * enclosing transfer objects.
1824 * type definition which can be of type <code>UnionType</code> or
1825 * <code>BitsTypeDefinition</code>
1826 * @param typeBuilder
1827 * generated type builder to which is added generated TO created
1828 * from <code>typeDef</code>
1830 * string with name for generated TO builder
1832 * @param parentModule
1833 * @return generated TO builder for <code>typeDef</code>
1835 private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
1836 DataSchemaNode leaf, Module parentModule) {
1837 val classNameFromLeaf = BindingMapping.getClassName(leaf.QName);
1838 val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
1839 val packageName = typeBuilder.fullyQualifiedName;
1840 if (typeDef instanceof UnionTypeDefinition) {
1841 val List<GeneratedTOBuilder> types = (typeProvider as TypeProviderImpl).
1842 provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
1843 classNameFromLeaf, leaf);
1844 genTOBuilders.addAll(types);
1847 var GeneratedTOBuilder resultTOBuilder = null;
1848 if (!types.isEmpty()) {
1849 resultTOBuilder = types.remove(0);
1850 for (GeneratedTOBuilder genTOBuilder : types) {
1851 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
1855 val GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
1856 genPropBuilder.setReturnType(Types.primitiveType("char[]", null));
1857 resultTOBuilder.addEqualsIdentity(genPropBuilder);
1858 resultTOBuilder.addHashIdentity(genPropBuilder);
1859 resultTOBuilder.addToStringProperty(genPropBuilder);
1861 } else if (typeDef instanceof BitsTypeDefinition) {
1863 ((typeProvider as TypeProviderImpl) ).
1864 provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
1866 if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
1867 for (genTOBuilder : genTOBuilders) {
1868 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1870 return genTOBuilders.get(0);
1877 * Adds the implemented types to type builder.
1879 * The method passes through the list of <i>uses</i> in
1880 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
1881 * generated type from {@link BindingGeneratorImpl#allGroupings
1882 * allGroupings} which is added as <i>implements type</i> to
1883 * <code>builder</code>
1885 * @param dataNodeContainer
1886 * element which contains the list of used YANG groupings
1888 * builder to which are added implemented types according to
1889 * <code>dataNodeContainer</code>
1890 * @return generated type builder with all implemented types
1892 private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
1893 for (usesNode : dataNodeContainer.uses) {
1894 if (usesNode.groupingPath !== null) {
1895 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
1896 if (genType === null) {
1897 throw new IllegalStateException(
1898 "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
1900 builder.addImplementsType(genType);
1901 builder.addComment(genType.getComment());
1907 private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
1908 for (ctx : genCtx.values) {
1909 var result = ctx.getChildNode(path)
1910 if (result !== null) {
1917 private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
1918 for (ctx : genCtx.values) {
1919 var result = ctx.getGrouping(path)
1920 if (result !== null) {
1927 private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
1928 for (ctx : genCtx.values) {
1929 var result = ctx.getCase(path)
1930 if (result !== null) {
1937 public def getModuleContexts() {