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.checkArgument;
11 import static com.google.common.base.Preconditions.checkNotNull;
12 import static com.google.common.base.Preconditions.checkState;
13 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.computeDefaultSUID;
14 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
15 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.parseToValidParamName;
16 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_OBJECT;
17 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_ROOT;
18 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIABLE;
19 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIER;
20 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.NOTIFICATION;
21 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.augmentable;
22 import static org.opendaylight.yangtools.binding.generator.util.Types.BOOLEAN;
23 import static org.opendaylight.yangtools.binding.generator.util.Types.FUTURE;
24 import static org.opendaylight.yangtools.binding.generator.util.Types.VOID;
25 import static org.opendaylight.yangtools.binding.generator.util.Types.typeForClass;
26 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
27 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findNodeInSchemaContext;
28 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
29 import com.google.common.base.Splitter;
30 import com.google.common.collect.Iterables;
31 import com.google.common.collect.Sets;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.Collections;
35 import java.util.HashMap;
36 import java.util.Iterator;
37 import java.util.List;
40 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
41 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
42 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
43 import org.opendaylight.yangtools.binding.generator.util.Types;
44 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
45 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
46 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
47 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
48 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
49 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
50 import org.opendaylight.yangtools.sal.binding.model.api.Constant;
51 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
52 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
53 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
54 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
55 import org.opendaylight.yangtools.sal.binding.model.api.Type;
56 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder;
57 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
58 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
59 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
60 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
61 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
62 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
63 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
64 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
65 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
66 import org.opendaylight.yangtools.yang.binding.BindingMapping;
67 import org.opendaylight.yangtools.yang.binding.DataContainer;
68 import org.opendaylight.yangtools.yang.binding.RpcService;
69 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
70 import org.opendaylight.yangtools.yang.common.QName;
71 import org.opendaylight.yangtools.yang.common.RpcResult;
72 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
73 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
74 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
75 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
76 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
77 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
78 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
79 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
80 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.Module;
85 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
86 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
87 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
88 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
89 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
90 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
91 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
92 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
93 import org.opendaylight.yangtools.yang.model.api.UsesNode;
94 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
96 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
97 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
98 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
99 import org.opendaylight.yangtools.yang.model.util.UnionType;
100 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
101 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
102 import org.slf4j.Logger;
103 import org.slf4j.LoggerFactory;
105 public class BindingGeneratorImpl implements BindingGenerator {
106 private static final Logger LOG = LoggerFactory.getLogger(BindingGeneratorImpl.class);
107 private static final Splitter COLON_SPLITTER = Splitter.on(':');
108 private static final Splitter BSDOT_SPLITTER = Splitter.on("\\.");
109 private static final char NEW_LINE = '\n';
112 * Constant with the concrete name of identifier.
114 private static final String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
117 * Constant with the concrete name of namespace.
119 private static final String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
121 private final Map<Module, ModuleContext> genCtx = new HashMap<>();
124 * When set to true, generated classes will include javadoc comments which
125 * are useful for users.
127 private final boolean verboseClassComments;
130 * Outer key represents the package name. Outer value represents map of all
131 * builders in the same package. Inner key represents the schema node name
132 * (in JAVA class/interface name format). Inner value represents instance of
133 * builder for schema node specified in key part.
135 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
138 * Provide methods for converting YANG types to JAVA types.
140 private TypeProvider typeProvider;
143 * Holds reference to schema context to resolve data of augmented element
144 * when creating augmentation builder
146 private SchemaContext schemaContext;
149 * Create a new binding generator with verboe comments.
151 * @deprecated Use {@link #BindingGeneratorImpl(boolean)} instead.
154 public BindingGeneratorImpl() {
159 * Create a new binding generator.
161 * @param verboseClassComments generate verbose comments
163 public BindingGeneratorImpl(final boolean verboseClassComments) {
164 this.verboseClassComments = verboseClassComments;
168 * Resolves generated types from <code>context</code> schema nodes of all
171 * Generated types are created for modules, groupings, types, containers,
172 * lists, choices, augments, rpcs, notification, identities.
175 * schema context which contains data about all schema nodes
177 * @return list of types (usually <code>GeneratedType</code>
178 * <code>GeneratedTransferObject</code>which are generated from
179 * <code>context</code> data.
180 * @throws IllegalArgumentException
181 * if arg <code>context</code> is null
182 * @throws IllegalStateException
183 * if <code>context</code> contain no modules
186 public List<Type> generateTypes(final SchemaContext context) {
187 checkArgument(context != null, "Schema Context reference cannot be NULL.");
188 checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
189 schemaContext = context;
190 typeProvider = new TypeProviderImpl(context);
191 final Set<Module> modules = context.getModules();
192 return generateTypes(context, modules);
196 * Resolves generated types from <code>context</code> schema nodes only for
197 * modules specified in <code>modules</code>
199 * Generated types are created for modules, groupings, types, containers,
200 * lists, choices, augments, rpcs, notification, identities.
203 * schema context which contains data about all schema nodes
206 * set of modules for which schema nodes should be generated
208 * @return list of types (usually <code>GeneratedType</code> or
209 * <code>GeneratedTransferObject</code>) which:
211 * <li>are generated from <code>context</code> schema nodes and</li>
212 * <li>are also part of some of the module in <code>modules</code>
215 * @throws IllegalArgumentException
217 * <li>if arg <code>context</code> is null or</li>
218 * <li>if arg <code>modules</code> is null</li>
220 * @throws IllegalStateException
221 * if <code>context</code> contain no modules
224 public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {
225 checkArgument(context != null, "Schema Context reference cannot be NULL.");
226 checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
227 checkArgument(modules != null, "Set of Modules cannot be NULL.");
229 schemaContext = context;
230 typeProvider = new TypeProviderImpl(context);
231 Module[] modulesArray = new Module[context.getModules().size()];
232 context.getModules().toArray(modulesArray);
233 final List<Module> contextModules = ModuleDependencySort.sort(modulesArray);
234 genTypeBuilders = new HashMap<>();
236 for (Module contextModule : contextModules) {
237 moduleToGenTypes(contextModule, context);
239 for (Module contextModule : contextModules) {
240 allAugmentsToGenTypes(contextModule);
243 final List<Type> filteredGenTypes = new ArrayList<>();
244 for (Module m : modules) {
245 final ModuleContext ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m);
246 filteredGenTypes.addAll(ctx.getGeneratedTypes());
247 final Set<Type> additionalTypes = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(m);
248 if (additionalTypes != null) {
249 filteredGenTypes.addAll(additionalTypes);
253 return filteredGenTypes;
256 private void moduleToGenTypes(final Module m, final SchemaContext context) {
257 genCtx.put(m, new ModuleContext());
258 allTypeDefinitionsToGenTypes(m);
259 groupingsToGenTypes(m, m.getGroupings());
260 rpcMethodsToGenType(m);
261 allIdentitiesToGenTypes(m, context);
262 notificationsToGenType(m);
264 if (!m.getChildNodes().isEmpty()) {
265 final GeneratedTypeBuilder moduleType = moduleToDataType(m);
266 genCtx.get(m).addModuleNode(moduleType);
267 final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
268 resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.getChildNodes());
273 * Converts all extended type definitions of module to the list of
274 * <code>Type</code> objects.
277 * module from which is obtained set of type definitions
278 * @throws IllegalArgumentException
280 * <li>if module is null</li>
281 * <li>if name of module is null</li>
283 * @throws IllegalStateException
284 * if set of type definitions from module is null
286 private void allTypeDefinitionsToGenTypes(final Module module) {
287 checkArgument(module != null, "Module reference cannot be NULL.");
288 checkArgument(module.getName() != null, "Module name cannot be NULL.");
289 final DataNodeIterator it = new DataNodeIterator(module);
290 final List<TypeDefinition<?>> typeDefinitions = it.allTypedefs();
291 checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL.");
293 for (TypeDefinition<?> typedef : typeDefinitions) {
294 if (typedef != null) {
295 final Type type = ((TypeProviderImpl) typeProvider).generatedTypeForExtendedDefinitionType(typedef,
298 final ModuleContext ctx = genCtx.get(module);
299 ctx.addTypedefType(typedef.getPath(), type);
300 ctx.addTypeToSchema(type,typedef);
306 private GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
307 final GeneratedTypeBuilder childOf, final DataSchemaNode node) {
308 if (node.isAugmenting() || node.isAddedByUses()) {
311 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
312 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module);
313 genType.addComment(node.getDescription());
314 genType.setDescription(createDescription(node, genType.getFullyQualifiedName()));
315 genType.setModuleName(module.getName());
316 genType.setReference(node.getReference());
317 genType.setSchemaPath(node.getPath().getPathFromRoot());
318 if (node instanceof DataNodeContainer) {
319 genCtx.get(module).addChildNodeType(node, genType);
320 groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings());
321 processUsesAugments((DataNodeContainer) node, module);
326 private void containerToGenType(final Module module, final String basePackageName,
327 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node) {
328 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
329 if (genType != null) {
330 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType);
331 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes());
335 private void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder parent,
336 final GeneratedTypeBuilder childOf, final ListSchemaNode node) {
337 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
338 if (genType != null) {
339 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), Types.listTypeFor(genType));
341 final List<String> listKeys = listKeys(node);
342 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
343 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
344 if (genTOBuilder != null) {
345 final Type identifierMarker = Types.parameterizedTypeFor(IDENTIFIER, genType);
346 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
347 genTOBuilder.addImplementsType(identifierMarker);
348 genType.addImplementsType(identifiableMarker);
351 for (DataSchemaNode schemaNode : node.getChildNodes()) {
352 if (!schemaNode.isAugmenting()) {
353 addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
358 if (genTOBuilder != null) {
359 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
360 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
361 genTOBuilder.setSUID(prop);
364 typeBuildersToGenTypes(module, genType, genTOBuilder);
368 private void processUsesAugments(final DataNodeContainer node, final Module module) {
369 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
370 for (UsesNode usesNode : node.getUses()) {
371 for (AugmentationSchema augment : usesNode.getAugmentations()) {
372 usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
373 processUsesAugments(augment, module);
379 * Converts all <b>augmentation</b> of the module to the list
380 * <code>Type</code> objects.
383 * module from which is obtained list of all augmentation objects
384 * to iterate over them
385 * @throws IllegalArgumentException
387 * <li>if the module is null</li>
388 * <li>if the name of module is null</li>
390 * @throws IllegalStateException
391 * if set of augmentations from module is null
393 private void allAugmentsToGenTypes(final Module module) {
394 checkArgument(module != null, "Module reference cannot be NULL.");
395 checkArgument(module.getName() != null, "Module name cannot be NULL.");
396 checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
398 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
399 final List<AugmentationSchema> augmentations = resolveAugmentations(module);
400 for (AugmentationSchema augment : augmentations) {
401 augmentationToGenTypes(basePackageName, augment, module);
406 * Returns list of <code>AugmentationSchema</code> objects. The objects are
407 * sorted according to the length of their target path from the shortest to
411 * module from which is obtained list of all augmentation objects
412 * @return list of sorted <code>AugmentationSchema</code> objects obtained
413 * from <code>module</code>
414 * @throws IllegalArgumentException
416 * @throws IllegalStateException
417 * if set of module augmentations is null
419 private List<AugmentationSchema> resolveAugmentations(final Module module) {
420 checkArgument(module != null, "Module reference cannot be NULL.");
421 checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
423 final Set<AugmentationSchema> augmentations = module.getAugmentations();
424 List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);
425 Collections.sort(sortedAugmentations, Comparators.AUGMENT_COMP);
427 return sortedAugmentations;
431 * Create GeneratedTypeBuilder object from module argument.
434 * Module object from which builder will be created
435 * @return <code>GeneratedTypeBuilder</code> which is internal
436 * representation of the module
437 * @throws IllegalArgumentException
440 private GeneratedTypeBuilder moduleToDataType(final Module module) {
441 checkArgument(module != null, "Module reference cannot be NULL.");
443 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
444 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
445 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
446 moduleDataTypeBuilder.addComment(module.getDescription());
447 moduleDataTypeBuilder.setDescription(createDescription(module));
448 moduleDataTypeBuilder.setReference(module.getReference());
449 return moduleDataTypeBuilder;
453 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
454 * to the list of <code>Type</code> objects. In addition are to containers
455 * and lists which belong to input or output also part of returning list.
458 * module from which is obtained set of all rpc objects to
460 * @throws IllegalArgumentException
462 * <li>if the module is null</li>
463 * <li>if the name of module is null</li>
465 * @throws IllegalStateException
466 * if set of rpcs from module is null
468 private void rpcMethodsToGenType(final Module module) {
469 checkArgument(module != null, "Module reference cannot be NULL.");
470 checkArgument(module.getName() != null, "Module name cannot be NULL.");
471 final Set<RpcDefinition> rpcDefinitions = module.getRpcs();
472 checkState(rpcDefinitions != null, "Set of rpcs from module " + module.getName() + " cannot be NULL.");
473 if (rpcDefinitions.isEmpty()) {
477 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
478 final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, "Service");
479 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService.class));
480 interfaceBuilder.setDescription(createDescription(rpcDefinitions, module.getName(), module.getModuleSourcePath()));
482 for (RpcDefinition rpc : rpcDefinitions) {
484 final String rpcName = BindingMapping.getClassName(rpc.getQName());
485 final String rpcMethodName = parseToValidParamName(rpcName);
486 final String rpcComment = rpc.getDescription();
487 final MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName);
488 final ContainerSchemaNode input = rpc.getInput();
489 final ContainerSchemaNode output = rpc.getOutput();
492 final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
493 addImplementedInterfaceFromUses(input, inType);
494 inType.addImplementsType(DATA_OBJECT);
495 inType.addImplementsType(augmentable(inType));
496 resolveDataSchemaNodes(module, basePackageName, inType, inType, input.getChildNodes());
497 genCtx.get(module).addChildNodeType(input, inType);
498 final GeneratedType inTypeInstance = inType.toInstance();
499 method.addParameter(inTypeInstance, "input");
502 Type outTypeInstance = VOID;
503 if (output != null) {
504 final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
505 addImplementedInterfaceFromUses(output, outType);
506 outType.addImplementsType(DATA_OBJECT);
507 outType.addImplementsType(augmentable(outType));
508 resolveDataSchemaNodes(module, basePackageName, outType, outType, output.getChildNodes());
509 genCtx.get(module).addChildNodeType(output, outType);
510 outTypeInstance = outType.toInstance();
513 final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);
514 method.setComment(rpcComment);
515 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
519 genCtx.get(module).addTopLevelNodeType(interfaceBuilder);
523 * Converts all <b>notifications</b> of the module to the list of
524 * <code>Type</code> objects. In addition are to this list added containers
525 * and lists which are part of this notification.
528 * module from which is obtained set of all notification objects
529 * to iterate over them
530 * @throws IllegalArgumentException
532 * <li>if the module equals null</li>
533 * <li>if the name of module equals null</li>
535 * @throws IllegalStateException
536 * if set of notifications from module is null
538 private void notificationsToGenType(final Module module) {
539 checkArgument(module != null, "Module reference cannot be NULL.");
540 checkArgument(module.getName() != null, "Module name cannot be NULL.");
541 final Set<NotificationDefinition> notifications = module.getNotifications();
542 checkState(notifications != null, "Set of notification from module " + module.getName() + " cannot be NULL.");
543 if (notifications.isEmpty()) {
547 final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");
548 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
549 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
553 for (NotificationDefinition notification : notifications) {
554 if (notification != null) {
555 processUsesAugments(notification, module);
557 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,
558 notification, BindingTypes.DATA_OBJECT, module);
559 notificationInterface.addImplementsType(NOTIFICATION);
560 genCtx.get(module).addChildNodeType(notification, notificationInterface);
562 // Notification object
563 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
564 notification.getChildNodes());
566 listenerInterface.addMethod("on" + notificationInterface.getName())
567 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
568 .setComment(notification.getDescription()).setReturnType(Types.VOID);
571 listenerInterface.setDescription(createDescription(notifications, module.getName(), module.getModuleSourcePath()));
573 genCtx.get(module).addTopLevelNodeType(listenerInterface);
577 * Converts all <b>identities</b> of the module to the list of
578 * <code>Type</code> objects.
581 * module from which is obtained set of all identity objects to
584 * schema context only used as input parameter for method
585 * {@link identityToGenType}
588 private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) {
589 final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
590 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
592 if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
593 for (IdentitySchemaNode identity : schemaIdentities) {
594 identityToGenType(module, basePackageName, identity, context);
600 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
601 * created transport object builder. If identity contains base identity then
602 * reference to base identity is added to superior identity as its extend.
603 * If identity doesn't contain base identity then only reference to abstract
604 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
605 * BaseIdentity} is added
609 * @param basePackageName
610 * string contains the module package name
612 * IdentitySchemaNode which contains data about identity
614 * SchemaContext which is used to get package and name
615 * information about base of identity
618 private void identityToGenType(final Module module, final String basePackageName,
619 final IdentitySchemaNode identity, final SchemaContext context) {
620 if (identity == null) {
623 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
624 final String genTypeName = BindingMapping.getClassName(identity.getQName());
625 final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
626 final IdentitySchemaNode baseIdentity = identity.getBaseIdentity();
627 if (baseIdentity == null) {
628 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
629 BaseIdentity.class.getSimpleName());
630 newType.setExtendsType(gto.toInstance());
632 final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
633 final String returnTypePkgName = BindingMapping.getRootPackageName(baseIdentityParentModule
635 final String returnTypeName = BindingMapping.getClassName(baseIdentity.getQName());
636 final GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName)
638 newType.setExtendsType(gto);
640 newType.setAbstract(true);
641 newType.addComment(identity.getDescription());
642 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName()));
643 newType.setReference(identity.getReference());
644 newType.setModuleName(module.getName());
645 newType.setSchemaPath(identity.getPath().getPathFromRoot());
647 final QName qname = identity.getQName();
648 qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, qname);
650 genCtx.get(module).addIdentityType(identity.getQName(), newType);
653 private static Constant qnameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
655 StringBuilder sb = new StringBuilder("org.opendaylight.yangtools.yang.common.QName");
656 sb.append(".create(");
658 sb.append(name.getNamespace());
660 sb.append(name.getFormattedRevision());
662 sb.append(name.getLocalName());
665 return toBuilder.addConstant(typeForClass(QName.class), constantName, sb.toString());
669 * Converts all <b>groupings</b> of the module to the list of
670 * <code>Type</code> objects. Firstly are groupings sorted according mutual
671 * dependencies. At least dependent (independent) groupings are in the list
672 * saved at first positions. For every grouping the record is added to map
673 * {@link BindingGeneratorImpl#allGroupings allGroupings}
678 * of groupings from which types will be generated
681 private void groupingsToGenTypes(final Module module, final Collection<GroupingDefinition> groupings) {
682 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
683 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
685 for (GroupingDefinition grouping : groupingsSortedByDependencies) {
686 groupingToGenType(basePackageName, grouping, module);
691 * Converts individual grouping to GeneratedType. Firstly generated type
692 * builder is created and every child node of grouping is resolved to the
695 * @param basePackageName
696 * string contains the module package name
698 * GroupingDefinition which contains data about grouping
701 * @return GeneratedType which is generated from grouping (object of type
702 * <code>GroupingDefinition</code>)
704 private void groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module module) {
705 final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());
706 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module);
707 genCtx.get(module).addGroupingType(grouping.getPath(), genType);
708 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes());
709 groupingsToGenTypes(module, grouping.getGroupings());
710 processUsesAugments(grouping, module);
714 * Adds enumeration builder created from <code>enumTypeDef</code> to
715 * <code>typeBuilder</code>.
717 * Each <code>enumTypeDef</code> item is added to builder with its name and
721 * EnumTypeDefinition contains enum data
723 * string contains name which will be assigned to enumeration
726 * GeneratedTypeBuilder to which will be enum builder assigned
727 * @return enumeration builder which contains data from
728 * <code>enumTypeDef</code>
730 private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
731 final GeneratedTypeBuilder typeBuilder) {
732 if ((enumTypeDef != null) && (typeBuilder != null) && (enumTypeDef.getQName() != null)
733 && (enumTypeDef.getQName().getLocalName() != null)) {
734 final String enumerationName = BindingMapping.getClassName(enumName);
735 final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
736 enumBuilder.setDescription(enumTypeDef.getDescription());
737 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
744 * Generates type builder for <code>module</code>.
747 * Module which is source of package name for generated type
750 * string which is added to the module class name representation
752 * @return instance of GeneratedTypeBuilder which represents
753 * <code>module</code>.
754 * @throws IllegalArgumentException
755 * if <code>module</code> is null
757 private GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {
758 checkArgument(module != null, "Module reference cannot be NULL.");
759 final String packageName = BindingMapping.getRootPackageName(module.getQNameModule());
760 final String moduleName = BindingMapping.getClassName(module.getName()) + postfix;
762 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
763 moduleBuilder.setDescription(createDescription(module));
764 moduleBuilder.setReference(module.getReference());
765 moduleBuilder.setModuleName(moduleName);
767 return moduleBuilder;
771 * Converts <code>augSchema</code> to list of <code>Type</code> which
772 * contains generated type for augmentation. In addition there are also
773 * generated types for all containers, list and choices which are child of
774 * <code>augSchema</code> node or a generated types for cases are added if
775 * augmented node is choice.
777 * @param augmentPackageName
778 * string with the name of the package to which the augmentation
781 * AugmentationSchema which is contains data about augmentation
782 * (target path, childs...)
785 * @param parentUsesNode
786 * @throws IllegalArgumentException
788 * <li>if <code>augmentPackageName</code> equals null</li>
789 * <li>if <code>augSchema</code> equals null</li>
791 * @throws IllegalStateException
792 * if augment target path is null
794 private void augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
795 final Module module) {
796 checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
797 checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
798 checkState(augSchema.getTargetPath() != null,
799 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
801 processUsesAugments(augSchema, module);
802 final SchemaPath targetPath = augSchema.getTargetPath();
803 SchemaNode targetSchemaNode = null;
805 targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
806 if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
807 if (targetSchemaNode instanceof DerivableSchemaNode) {
808 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
810 if (targetSchemaNode == null) {
811 throw new IllegalStateException("Failed to find target node from grouping in augmentation " + augSchema
812 + " in module " + module.getName());
815 if (targetSchemaNode == null) {
816 throw new IllegalArgumentException("augment target not found: " + targetPath);
819 GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
820 if (targetTypeBuilder == null) {
821 targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
823 if (targetTypeBuilder == null) {
824 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
827 if (!(targetSchemaNode instanceof ChoiceNode)) {
828 String packageName = augmentPackageName;
829 final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(),
830 targetTypeBuilder.getName());
831 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetType, augSchema);
834 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
835 (ChoiceNode) targetSchemaNode, augSchema.getChildNodes());
839 private void usesAugmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
840 final Module module, final UsesNode usesNode, final DataNodeContainer usesNodeParent) {
841 checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
842 checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
843 checkState(augSchema.getTargetPath() != null,
844 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
846 processUsesAugments(augSchema, module);
847 final SchemaPath targetPath = augSchema.getTargetPath();
848 SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
849 if (targetSchemaNode == null) {
850 throw new IllegalArgumentException("augment target not found: " + targetPath);
853 GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
854 if (targetTypeBuilder == null) {
855 targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
857 if (targetTypeBuilder == null) {
858 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
861 if (!(targetSchemaNode instanceof ChoiceNode)) {
862 String packageName = augmentPackageName;
863 if (usesNodeParent instanceof SchemaNode) {
864 packageName = packageNameForGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath(),
867 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(),
870 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
871 (ChoiceNode) targetSchemaNode, augSchema.getChildNodes());
876 * Convenient method to find node added by uses statement.
880 * @param parentUsesNode
881 * parent of uses node
882 * @return node from its original location in grouping
884 private DataSchemaNode findOriginalTargetFromGrouping(final SchemaPath targetPath, final UsesNode parentUsesNode) {
885 SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath()
887 if (!(targetGrouping instanceof GroupingDefinition)) {
888 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
891 GroupingDefinition grouping = (GroupingDefinition) targetGrouping;
892 SchemaNode result = grouping;
893 for (QName node : targetPath.getPathFromRoot()) {
894 // finding by local name is valid, grouping cannot contain nodes
895 // with same name and different namespace
896 if (result instanceof DataNodeContainer) {
897 result = ((DataNodeContainer) result).getDataChildByName(node.getLocalName());
898 } else if (result instanceof ChoiceNode) {
899 result = ((ChoiceNode) result).getCaseNodeByName(node.getLocalName());
902 if (result == null) {
906 boolean fromUses = ((DataSchemaNode) result).isAddedByUses();
907 Iterator<UsesNode> groupingUses = grouping.getUses().iterator();
908 while (groupingUses.hasNext() && fromUses) {
909 result = findOriginalTargetFromGrouping(targetPath, groupingUses.next());
910 if (result != null) {
911 fromUses = ((DataSchemaNode) result).isAddedByUses();
915 // this indicates invalid yang and thus possible bug in code because
916 // invalid yang should be already spotted by parser
917 throw new IllegalStateException("Failed to generate code for augment in " + parentUsesNode);
920 return (DataSchemaNode) result;
924 * Returns a generated type builder for an augmentation.
926 * The name of the type builder is equal to the name of augmented node with
927 * serial number as suffix.
931 * @param augmentPackageName
932 * string with contains the package name to which the augment
934 * @param basePackageName
935 * string with the package name to which the augmented node
937 * @param targetTypeRef
940 * augmentation schema which contains data about the child nodes
941 * and uses of augment
942 * @return generated type builder for augment
944 private GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
945 final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema) {
946 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
947 if (augmentBuilders == null) {
948 augmentBuilders = new HashMap<>();
949 genTypeBuilders.put(augmentPackageName, augmentBuilders);
951 final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
954 if (augIdentifier != null) {
955 augTypeName = BindingMapping.getClassName(augIdentifier);
957 augTypeName = augGenTypeName(augmentBuilders, targetTypeRef.getName());
960 final GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
962 augTypeBuilder.addImplementsType(DATA_OBJECT);
963 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
964 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
966 augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes());
967 augmentBuilders.put(augTypeName, augTypeBuilder);
969 if(!augSchema.getChildNodes().isEmpty()) {
970 genCtx.get(module).addTargetToAugmentation(targetTypeRef, augTypeBuilder);
971 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
974 genCtx.get(module).addAugmentType(augTypeBuilder);
975 return augTypeBuilder;
980 * @param unknownSchemaNodes
981 * @return nodeParameter of UnknownSchemaNode
983 private String getAugmentIdentifier(final List<UnknownSchemaNode> unknownSchemaNodes) {
984 for (UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
985 final QName nodeType = unknownSchemaNode.getNodeType();
986 if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())
987 && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {
988 return unknownSchemaNode.getNodeParameter();
995 * Returns first unique name for the augment generated type builder. The
996 * generated type builder name for augment consists from name of augmented
997 * node and serial number of its augmentation.
1000 * map of builders which were created in the package to which the
1001 * augmentation belongs
1002 * @param genTypeName
1003 * string with name of augmented node
1004 * @return string with unique name for augmentation builder
1006 private String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {
1008 if (builders != null) {
1009 while (builders.containsKey(genTypeName + index)) {
1013 return genTypeName + index;
1017 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
1018 * node for which <code>typeBuilder</code> was created.
1020 * The subnodes aren't mapped to the methods if they are part of grouping or
1021 * augment (in this case are already part of them).
1025 * @param basePackageName
1026 * string contains the module package name
1028 * generated type builder which represents any node. The subnodes
1029 * of this node are added to the <code>typeBuilder</code> as
1030 * methods. The subnode can be of type leaf, leaf-list, list,
1031 * container, choice.
1034 * @param schemaNodes
1035 * set of data schema nodes which are the children of the node
1036 * for which <code>typeBuilder</code> was created
1037 * @return generated type builder which is the same builder as input
1038 * parameter. The getter methods (representing child nodes) could be
1041 private GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
1042 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes) {
1043 if (schemaNodes != null && parent != null) {
1044 for (DataSchemaNode schemaNode : schemaNodes) {
1045 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
1046 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1054 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
1055 * node for which <code>typeBuilder</code> was created.
1059 * @param basePackageName
1060 * string contains the module package name
1061 * @param typeBuilder
1062 * generated type builder which represents any node. The subnodes
1063 * of this node are added to the <code>typeBuilder</code> as
1064 * methods. The subnode can be of type leaf, leaf-list, list,
1065 * container, choice.
1068 * @param schemaNodes
1069 * set of data schema nodes which are the children of the node
1070 * for which <code>typeBuilder</code> was created
1071 * @return generated type builder which is the same object as the input
1072 * parameter <code>typeBuilder</code>. The getter method could be
1075 private GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
1076 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf,
1077 final Iterable<DataSchemaNode> schemaNodes) {
1078 if ((schemaNodes != null) && (typeBuilder != null)) {
1079 for (DataSchemaNode schemaNode : schemaNodes) {
1080 if (!schemaNode.isAugmenting()) {
1081 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1089 * Adds to <code>typeBuilder</code> a method which is derived from
1090 * <code>schemaNode</code>.
1092 * @param basePackageName
1093 * string with the module package name
1095 * data schema node which is added to <code>typeBuilder</code> as
1097 * @param typeBuilder
1098 * generated type builder to which is <code>schemaNode</code>
1099 * added as a method.
1105 private void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
1106 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module) {
1107 if (node != null && typeBuilder != null) {
1108 if (node instanceof LeafSchemaNode) {
1109 resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) node);
1110 } else if (node instanceof LeafListSchemaNode) {
1111 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node);
1112 } else if (node instanceof ContainerSchemaNode) {
1113 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node);
1114 } else if (node instanceof ListSchemaNode) {
1115 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node);
1116 } else if (node instanceof ChoiceNode) {
1117 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceNode) node);
1119 // TODO: anyxml not yet supported
1120 LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
1121 typeBuilder.getFullyQualifiedName());
1127 * Converts <code>choiceNode</code> to the list of generated types for
1128 * choice and its cases.
1130 * The package names for choice and for its cases are created as
1131 * concatenation of the module package (<code>basePackageName</code>) and
1132 * names of all parents node.
1136 * @param basePackageName
1137 * string with the module package name
1141 * choice node which is mapped to generated type. Also child
1142 * nodes - cases are mapped to generated types.
1143 * @throws IllegalArgumentException
1145 * <li>if <code>basePackageName</code> is null</li>
1146 * <li>if <code>choiceNode</code> is null</li>
1149 private void choiceToGeneratedType(final Module module, final String basePackageName,
1150 final GeneratedTypeBuilder parent, final ChoiceNode choiceNode) {
1151 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1152 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
1154 if (!choiceNode.isAddedByUses()) {
1155 final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());
1156 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1157 constructGetter(parent, choiceNode.getQName().getLocalName(), choiceNode.getDescription(),
1159 choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class));
1160 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
1161 generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode);
1166 * Converts <code>caseNodes</code> set to list of corresponding generated
1169 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1170 * created generated type builder. The package names for the builder is
1171 * created as concatenation of the module package (
1172 * <code>basePackageName</code>) and names of all parents nodes of the
1173 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1174 * between every case builder and <i>choice</i> type
1178 * @param basePackageName
1179 * string with the module package name
1180 * @param refChoiceType
1181 * type which represents superior <i>case</i>
1183 * choice case node which is mapped to generated type
1184 * @return list of generated types for <code>caseNodes</code>.
1185 * @throws IllegalArgumentException
1187 * <li>if <code>basePackageName</code> equals null</li>
1188 * <li>if <code>refChoiceType</code> equals null</li>
1189 * <li>if <code>caseNodes</code> equals null</li>
1192 private void generateTypesFromChoiceCases(final Module module, final String basePackageName,
1193 final Type refChoiceType, final ChoiceNode choiceNode) {
1194 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1195 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1196 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1198 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1199 if (caseNodes == null) {
1203 for (ChoiceCaseNode caseNode : caseNodes) {
1204 if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1205 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1206 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1207 caseTypeBuilder.addImplementsType(refChoiceType);
1208 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1209 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1210 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1211 if (caseChildNodes != null) {
1212 final SchemaPath nodeSp = choiceNode.getPath();
1213 final Object parentNode = findDataSchemaNode(schemaContext, nodeSp.getParent());
1216 if (parentNode instanceof AugmentationSchema) {
1217 final AugmentationSchema augSchema = (AugmentationSchema) parentNode;
1218 final SchemaPath targetPath = augSchema.getTargetPath();
1219 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1220 if (targetSchemaNode instanceof DataSchemaNode
1221 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1222 if (targetSchemaNode instanceof DerivableSchemaNode) {
1223 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1225 if (targetSchemaNode == null) {
1226 throw new IllegalStateException(
1227 "Failed to find target node from grouping for augmentation " + augSchema
1228 + " in module " + module.getName());
1231 parent = targetSchemaNode;
1233 final SchemaPath sp = choiceNode.getPath();
1234 parent = findDataSchemaNode(schemaContext, sp.getParent());
1236 if (parent != null) {
1237 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath());
1238 if (childOfType == null) {
1239 childOfType = findGroupingByPath(parent.getPath());
1241 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes);
1245 processUsesAugments(caseNode, module);
1250 * Generates list of generated types for all the cases of a choice which are
1251 * added to the choice through the augment.
1255 * @param basePackageName
1256 * string contains name of package to which augment belongs. If
1257 * an augmented choice is from an other package (pcg1) than an
1258 * augmenting choice (pcg2) then case's of the augmenting choice
1259 * will belong to pcg2.
1261 * Type which represents target choice
1263 * node which represents target choice
1264 * @param augmentedNodes
1265 * set of choice case nodes for which is checked if are/aren't
1266 * added to choice through augmentation
1267 * @return list of generated types which represents augmented cases of
1268 * choice <code>refChoiceType</code>
1269 * @throws IllegalArgumentException
1271 * <li>if <code>basePackageName</code> is null</li>
1272 * <li>if <code>targetType</code> is null</li>
1273 * <li>if <code>augmentedNodes</code> is null</li>
1276 private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName,
1277 final Type targetType, final ChoiceNode targetNode, final Iterable<DataSchemaNode> augmentedNodes) {
1278 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1279 checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
1280 checkArgument(augmentedNodes != null, "Set of Choice Case Nodes cannot be NULL.");
1282 for (DataSchemaNode caseNode : augmentedNodes) {
1283 if (caseNode != null) {
1284 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1285 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1286 caseTypeBuilder.addImplementsType(targetType);
1288 SchemaNode parent = null;
1289 final SchemaPath nodeSp = targetNode.getPath();
1290 parent = findDataSchemaNode(schemaContext, nodeSp.getParent());
1292 GeneratedTypeBuilder childOfType = null;
1293 if (parent instanceof Module) {
1294 childOfType = genCtx.get(parent).getModuleNode();
1295 } else if (parent instanceof ChoiceCaseNode) {
1296 childOfType = findCaseByPath(parent.getPath());
1297 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1298 childOfType = findChildNodeByPath(parent.getPath());
1299 } else if (parent instanceof GroupingDefinition) {
1300 childOfType = findGroupingByPath(parent.getPath());
1303 if (childOfType == null) {
1304 throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1307 ChoiceCaseNode node = null;
1308 if (caseNode instanceof ChoiceCaseNode) {
1309 node = (ChoiceCaseNode) caseNode;
1311 node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1313 final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
1314 if (childNodes != null) {
1315 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1317 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1318 genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
1324 * Converts <code>leaf</code> to the getter method which is added to
1325 * <code>typeBuilder</code>.
1327 * @param typeBuilder
1328 * generated type builder to which is added getter method as
1329 * <code>leaf</code> mapping
1331 * leaf schema node which is mapped as getter method which is
1332 * added to <code>typeBuilder</code>
1333 * @return boolean value
1335 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
1337 * <li>true - in other cases</li>
1340 private Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf) {
1341 Type returnType = null;
1342 if ((leaf != null) && (typeBuilder != null)) {
1343 final String leafName = leaf.getQName().getLocalName();
1344 String leafDesc = leaf.getDescription();
1345 if (leafDesc == null) {
1349 final Module parentModule = findParentModule(schemaContext, leaf);
1350 if (leafName != null && !leaf.isAddedByUses()) {
1351 final TypeDefinition<?> typeDef = leaf.getType();
1353 GeneratedTOBuilder genTOBuilder;
1354 if (typeDef instanceof EnumTypeDefinition) {
1355 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1356 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1357 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
1360 if (enumBuilder != null) {
1361 returnType = enumBuilder.toInstance(typeBuilder);
1363 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1364 } else if (typeDef instanceof UnionType) {
1365 genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1366 if (genTOBuilder != null) {
1367 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1369 } else if (typeDef instanceof BitsTypeDefinition) {
1370 genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1371 if (genTOBuilder != null) {
1372 returnType = genTOBuilder.toInstance();
1375 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1376 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1378 if (returnType != null) {
1379 final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1380 processContextRefExtension(leaf, getter, parentModule);
1387 private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter,
1388 final Module module) {
1389 for (UnknownSchemaNode node : leaf.getUnknownSchemaNodes()) {
1390 final QName nodeType = node.getNodeType();
1391 if ("context-reference".equals(nodeType.getLocalName())) {
1392 final String nodeParam = node.getNodeParameter();
1393 IdentitySchemaNode identity = null;
1394 String basePackageName = null;
1395 final Iterable<String> splittedElement = COLON_SPLITTER.split(nodeParam);
1396 final Iterator<String> iterator = splittedElement.iterator();
1397 final int length = Iterables.size(splittedElement);
1399 identity = findIdentityByName(module.getIdentities(), iterator.next());
1400 basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
1401 } else if (length == 2) {
1402 String prefix = iterator.next();
1403 final Module dependentModule = findModuleFromImports(module.getImports(), prefix);
1404 if (dependentModule == null) {
1405 throw new IllegalArgumentException("Failed to process context-reference: unknown prefix "
1408 identity = findIdentityByName(dependentModule.getIdentities(), iterator.next());
1409 basePackageName = BindingMapping.getRootPackageName(dependentModule.getQNameModule());
1411 throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1414 if (identity == null) {
1415 throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1419 final Class<RoutingContext> clazz = RoutingContext.class;
1420 final AnnotationTypeBuilder rc = getter.addAnnotation(clazz.getPackage().getName(),
1421 clazz.getSimpleName());
1422 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
1423 final String genTypeName = BindingMapping.getClassName(identity.getQName().getLocalName());
1424 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1429 private IdentitySchemaNode findIdentityByName(final Set<IdentitySchemaNode> identities, final String name) {
1430 for (IdentitySchemaNode id : identities) {
1431 if (id.getQName().getLocalName().equals(name)) {
1438 private Module findModuleFromImports(final Set<ModuleImport> imports, final String prefix) {
1439 for (ModuleImport imp : imports) {
1440 if (imp.getPrefix().equals(prefix)) {
1441 return schemaContext.findModuleByName(imp.getModuleName(), imp.getRevision());
1447 private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1448 final boolean isReadOnly, final Module module) {
1449 if ((leaf != null) && (toBuilder != null)) {
1450 final String leafName = leaf.getQName().getLocalName();
1451 String leafDesc = leaf.getDescription();
1452 if (leafDesc == null) {
1456 if (leafName != null) {
1457 Type returnType = null;
1458 final TypeDefinition<?> typeDef = leaf.getType();
1459 if (typeDef instanceof UnionTypeDefinition) {
1460 // GeneratedType for this type definition should be already
1462 QName qname = typeDef.getQName();
1463 Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1464 qname.getRevision());
1465 final ModuleContext mc = genCtx.get(unionModule);
1466 returnType = mc.getTypedefs().get(typeDef.getPath());
1468 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1470 return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1477 * Converts <code>leaf</code> schema node to property of generated TO
1481 * generated TO builder to which is <code>leaf</code> added as
1484 * leaf schema node which is added to <code>toBuilder</code> as
1489 * boolean value which says if leaf property is|isn't read only
1490 * @return boolean value
1492 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
1493 * name equals null or if leaf is added by <i>uses</i>.</li>
1494 * <li>true - other cases</li>
1497 private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1498 final Type returnType, final boolean isReadOnly) {
1499 if (returnType == null) {
1502 final String leafName = leaf.getQName().getLocalName();
1503 final String leafDesc = leaf.getDescription();
1504 final GeneratedPropertyBuilder propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1505 propBuilder.setReadOnly(isReadOnly);
1506 propBuilder.setReturnType(returnType);
1507 propBuilder.setComment(leafDesc);
1508 toBuilder.addEqualsIdentity(propBuilder);
1509 toBuilder.addHashIdentity(propBuilder);
1510 toBuilder.addToStringProperty(propBuilder);
1515 * Converts <code>node</code> leaf list schema node to getter method of
1516 * <code>typeBuilder</code>.
1518 * @param typeBuilder
1519 * generated type builder to which is <code>node</code> added as
1522 * leaf list schema node which is added to
1523 * <code>typeBuilder</code> as getter method
1524 * @return boolean value
1526 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
1527 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
1528 * <li>false - other cases</li>
1531 private boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node) {
1532 if ((node != null) && (typeBuilder != null)) {
1533 final QName nodeName = node.getQName();
1535 if (nodeName != null && !node.isAddedByUses()) {
1536 final TypeDefinition<?> typeDef = node.getType();
1537 final Module parentModule = findParentModule(schemaContext, node);
1539 Type returnType = null;
1540 if (typeDef instanceof EnumTypeDefinition) {
1541 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
1542 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1543 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
1545 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
1546 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
1547 } else if (typeDef instanceof UnionType) {
1548 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1549 if (genTOBuilder != null) {
1550 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1552 } else if (typeDef instanceof BitsTypeDefinition) {
1553 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1554 returnType = genTOBuilder.toInstance();
1556 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1557 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1560 final ParameterizedType listType = Types.listTypeFor(returnType);
1561 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType);
1568 private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition<?> typeDef,
1569 final GeneratedTypeBuilder typeBuilder, final Module parentModule) {
1570 final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(),
1571 genTOBuilder.getName());
1573 returnType.setDescription(typeDef.getDescription());
1574 returnType.setReference(typeDef.getReference());
1575 returnType.setSchemaPath(typeDef.getPath().getPathFromRoot());
1576 returnType.setModuleName(parentModule.getName());
1578 genTOBuilder.setTypedef(true);
1579 genTOBuilder.setIsUnion(true);
1580 ((TypeProviderImpl) typeProvider).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1583 final GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
1584 genTOBuilder.getName() + "Builder");
1585 unionBuilder.setIsUnionBuilder(true);
1586 final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1587 method.setReturnType(returnType);
1588 method.addParameter(Types.STRING, "defaultValue");
1589 method.setAccessModifier(AccessModifier.PUBLIC);
1590 method.setStatic(true);
1592 final Set<Type> types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule);
1593 if (types == null) {
1594 ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule,
1595 Sets.<Type> newHashSet(unionBuilder.toInstance()));
1597 types.add(unionBuilder.toInstance());
1599 return returnType.toInstance();
1602 private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1603 final Module module) {
1604 return addDefaultInterfaceDefinition(packageName, schemaNode, null, module);
1608 * Instantiates generated type builder with <code>packageName</code> and
1609 * <code>schemaNode</code>.
1611 * The new builder always implements
1612 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
1613 * If <code>schemaNode</code> is instance of GroupingDefinition it also
1614 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
1615 * Augmentable}.<br />
1616 * If <code>schemaNode</code> is instance of
1617 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
1618 * DataNodeContainer} it can also implement nodes which are specified in
1621 * @param packageName
1622 * string with the name of the package to which
1623 * <code>schemaNode</code> belongs.
1625 * schema node for which is created generated type builder
1627 * parent type (can be null)
1628 * @return generated type builder <code>schemaNode</code>
1630 private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1631 final Type parent, final Module module) {
1632 final GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, "");
1633 if (parent == null) {
1634 it.addImplementsType(DATA_OBJECT);
1636 it.addImplementsType(BindingTypes.childOf(parent));
1638 if (!(schemaNode instanceof GroupingDefinition)) {
1639 it.addImplementsType(augmentable(it));
1642 if (schemaNode instanceof DataNodeContainer) {
1643 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings());
1644 addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it);
1651 * Wraps the calling of the same overloaded method.
1653 * @param packageName
1654 * string with the package name to which returning generated type
1657 * schema node which provide data about the schema node name
1658 * @return generated type builder for <code>schemaNode</code>
1660 private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {
1661 return addRawInterfaceDefinition(packageName, schemaNode, "");
1665 * Returns reference to generated type builder for specified
1666 * <code>schemaNode</code> with <code>packageName</code>.
1668 * Firstly the generated type builder is searched in
1669 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
1670 * found it is created and added to <code>genTypeBuilders</code>.
1672 * @param packageName
1673 * string with the package name to which returning generated type
1676 * schema node which provide data about the schema node name
1678 * return type name prefix
1679 * @return generated type builder for <code>schemaNode</code>
1680 * @throws IllegalArgumentException
1682 * <li>if <code>schemaNode</code> is null</li>
1683 * <li>if <code>packageName</code> is null</li>
1684 * <li>if QName of schema node is null</li>
1685 * <li>if schemaNode name is null</li>
1689 private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1690 final String prefix) {
1691 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1692 checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
1693 checkArgument(schemaNode.getQName() != null, "QName for Data Schema Node cannot be NULL.");
1694 final String schemaNodeName = schemaNode.getQName().getLocalName();
1695 checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
1698 if (prefix == null) {
1699 genTypeName = BindingMapping.getClassName(schemaNodeName);
1701 genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1704 // FIXME: Validation of name conflict
1705 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1706 final Module module = findParentModule(schemaContext, schemaNode);
1707 qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
1708 newType.addComment(schemaNode.getDescription());
1709 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName()));
1710 newType.setReference(schemaNode.getReference());
1711 newType.setSchemaPath(schemaNode.getPath().getPathFromRoot());
1712 newType.setModuleName(module.getName());
1714 if (!genTypeBuilders.containsKey(packageName)) {
1715 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
1716 builders.put(genTypeName, newType);
1717 genTypeBuilders.put(packageName, builders);
1719 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1720 if (!builders.containsKey(genTypeName)) {
1721 builders.put(genTypeName, newType);
1728 * Creates the name of the getter method name from <code>localName</code>.
1731 * string with the name of the getter method
1734 * @return string with the name of the getter method for
1735 * <code>methodName</code> in JAVA method format
1737 public static String getterMethodName(final String localName, final Type returnType) {
1738 final StringBuilder method = new StringBuilder();
1739 if (BOOLEAN.equals(returnType)) {
1740 method.append("is");
1742 method.append("get");
1744 String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName));
1745 method.append(name);
1746 return method.toString();
1750 * Created a method signature builder as part of
1751 * <code>interfaceBuilder</code>.
1753 * The method signature builder is created for the getter method of
1754 * <code>schemaNodeName</code>. Also <code>comment</code> and
1755 * <code>returnType</code> information are added to the builder.
1757 * @param interfaceBuilder
1758 * generated type builder for which the getter method should be
1760 * @param schemaNodeName
1761 * string with schema node name. The name will be the part of the
1762 * getter method name.
1764 * string with comment for the getter method
1766 * type which represents the return type of the getter method
1767 * @return method signature builder which represents the getter method of
1768 * <code>interfaceBuilder</code>
1770 private MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
1771 final String schemaNodeName, final String comment, final Type returnType) {
1772 final MethodSignatureBuilder getMethod = interfaceBuilder
1773 .addMethod(getterMethodName(schemaNodeName, returnType));
1774 getMethod.setComment(comment);
1775 getMethod.setReturnType(returnType);
1780 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1781 * or to <code>genTOBuilder</code> as property.
1783 * @param basePackageName
1784 * string contains the module package name
1786 * data schema node which should be added as getter method to
1787 * <code>typeBuilder</code> or as a property to
1788 * <code>genTOBuilder</code> if is part of the list key
1789 * @param typeBuilder
1790 * generated type builder for the list schema node
1791 * @param genTOBuilder
1792 * generated TO builder for the list keys
1794 * list of string which contains names of the list keys
1797 * @throws IllegalArgumentException
1799 * <li>if <code>schemaNode</code> equals null</li>
1800 * <li>if <code>typeBuilder</code> equals null</li>
1803 private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,
1804 final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys,
1805 final Module module) {
1806 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1807 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1809 if (schemaNode instanceof LeafSchemaNode) {
1810 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1811 final String leafName = leaf.getQName().getLocalName();
1812 final Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1813 if (listKeys.contains(leafName)) {
1815 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module);
1817 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1820 } else if (!schemaNode.isAddedByUses()) {
1821 if (schemaNode instanceof LeafListSchemaNode) {
1822 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode);
1823 } else if (schemaNode instanceof ContainerSchemaNode) {
1824 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode);
1825 } else if (schemaNode instanceof ChoiceNode) {
1826 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceNode) schemaNode);
1827 } else if (schemaNode instanceof ListSchemaNode) {
1828 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode);
1833 private void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
1834 final GeneratedTOBuilder genTOBuilder) {
1835 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1837 if (genTOBuilder != null) {
1838 GeneratedTransferObject genTO = genTOBuilder.toInstance();
1839 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1840 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
1845 * Selects the names of the list keys from <code>list</code> and returns
1846 * them as the list of the strings
1849 * of string with names of the list keys
1850 * @return list of string which represents names of the list keys. If the
1851 * <code>list</code> contains no keys then the empty list is
1854 private List<String> listKeys(final ListSchemaNode list) {
1855 final List<String> listKeys = new ArrayList<>();
1857 List<QName> keyDefinition = list.getKeyDefinition();
1858 if (keyDefinition != null) {
1859 for (QName keyDef : keyDefinition) {
1860 listKeys.add(keyDef.getLocalName());
1867 * Generates for the <code>list</code> which contains any list keys special
1868 * generated TO builder.
1870 * @param packageName
1871 * string with package name to which the list belongs
1873 * list schema node which is source of data about the list name
1874 * @return generated TO builder which represents the keys of the
1875 * <code>list</code> or null if <code>list</code> is null or list of
1876 * key definitions is null or empty.
1878 private GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
1879 GeneratedTOBuilder genTOBuilder = null;
1880 if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
1881 final String listName = list.getQName().getLocalName() + "Key";
1882 final String genTOName = BindingMapping.getClassName(listName);
1883 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1885 return genTOBuilder;
1889 * Builds generated TO builders for <code>typeDef</code> of type
1890 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
1891 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
1892 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
1893 * enclosing transfer object.
1895 * If more then one generated TO builder is created for enclosing then all
1896 * of the generated TO builders are added to <code>typeBuilder</code> as
1897 * enclosing transfer objects.
1900 * type definition which can be of type <code>UnionType</code> or
1901 * <code>BitsTypeDefinition</code>
1902 * @param typeBuilder
1903 * generated type builder to which is added generated TO created
1904 * from <code>typeDef</code>
1906 * string with name for generated TO builder
1908 * @return generated TO builder for <code>typeDef</code>
1910 private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef,
1911 final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) {
1912 final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName());
1913 final List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();
1914 final String packageName = typeBuilder.getFullyQualifiedName();
1915 if (typeDef instanceof UnionTypeDefinition) {
1916 final List<GeneratedTOBuilder> types = ((TypeProviderImpl) typeProvider)
1917 .provideGeneratedTOBuildersForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
1918 classNameFromLeaf, leaf);
1919 genTOBuilders.addAll(types);
1921 GeneratedTOBuilder resultTOBuilder = null;
1922 if (types.isEmpty()) {
1923 throw new IllegalStateException("No GeneratedTOBuilder objects generated from union " + typeDef);
1925 resultTOBuilder = types.remove(0);
1926 for (GeneratedTOBuilder genTOBuilder : types) {
1927 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
1930 final GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
1931 genPropBuilder.setReturnType(Types.CHAR_ARRAY);
1932 resultTOBuilder.addEqualsIdentity(genPropBuilder);
1933 resultTOBuilder.addHashIdentity(genPropBuilder);
1934 resultTOBuilder.addToStringProperty(genPropBuilder);
1936 } else if (typeDef instanceof BitsTypeDefinition) {
1937 genTOBuilders.add((((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
1938 packageName, typeDef, classNameFromLeaf, parentModule.getName()));
1940 if (genTOBuilders != null && !genTOBuilders.isEmpty()) {
1941 for (GeneratedTOBuilder genTOBuilder : genTOBuilders) {
1942 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1944 return genTOBuilders.get(0);
1951 * Adds the implemented types to type builder.
1953 * The method passes through the list of <i>uses</i> in
1954 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
1955 * generated type from {@link BindingGeneratorImpl#allGroupings
1956 * allGroupings} which is added as <i>implements type</i> to
1957 * <code>builder</code>
1959 * @param dataNodeContainer
1960 * element which contains the list of used YANG groupings
1962 * builder to which are added implemented types according to
1963 * <code>dataNodeContainer</code>
1964 * @return generated type builder with all implemented types
1966 private GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
1967 final GeneratedTypeBuilder builder) {
1968 for (UsesNode usesNode : dataNodeContainer.getUses()) {
1969 if (usesNode.getGroupingPath() != null) {
1970 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath()).toInstance();
1971 if (genType == null) {
1972 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
1973 + builder.getName());
1976 builder.addImplementsType(genType);
1978 builder.addComment(genType.getDescription());
1979 builder.setDescription(genType.getDescription());
1980 builder.setModuleName(genType.getModuleName());
1981 builder.setReference(genType.getReference());
1982 builder.setSchemaPath(genType.getSchemaPath());
1989 private boolean isNullOrEmpty(final Collection<?> list) {
1990 return (list == null || list.isEmpty() ? true : false);
1993 private String createDescription(final Set<? extends SchemaNode> schemaNodes, final String moduleName, final String moduleSourcePath) {
1994 final StringBuilder sb = new StringBuilder();
1996 if (!isNullOrEmpty(schemaNodes)) {
1997 final SchemaNode node = schemaNodes.iterator().next();
1999 if (node instanceof RpcDefinition) {
2000 sb.append("Interface for implementing the following YANG RPCs defined in module <b>" + moduleName + "</b>");
2001 } else if (node instanceof NotificationDefinition) {
2002 sb.append("Interface for receiving the following YANG notifications defined in module <b>" + moduleName + "</b>");
2005 sb.append(NEW_LINE);
2006 sb.append("<br />(Source path: <i>");
2007 sb.append(moduleSourcePath);
2008 sb.append("</i>):");
2009 sb.append(NEW_LINE);
2011 if (verboseClassComments) {
2013 sb.append(NEW_LINE);
2014 sb.append(YangTemplate.generateYangSnipet(schemaNodes));
2015 sb.append("</pre>");
2016 sb.append(NEW_LINE);
2019 return sb.toString();
2022 private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) {
2023 final StringBuilder sb = new StringBuilder();
2024 final String formattedDescription = YangTemplate.formatToParagraph(schemaNode.getDescription(), 0);
2026 if (!isNullOrEmpty(formattedDescription)) {
2027 sb.append(formattedDescription);
2028 sb.append(NEW_LINE);
2031 if (verboseClassComments) {
2032 final Module module = findParentModule(schemaContext, schemaNode);
2033 final StringBuilder linkToBuilderClass = new StringBuilder();
2034 final StringBuilder linkToKeyClass = new StringBuilder();
2035 final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
2036 String className = namespace[namespace.length - 1];
2038 if (hasBuilderClass(schemaNode)) {
2039 linkToBuilderClass.append(className);
2040 linkToBuilderClass.append("Builder");
2042 if (schemaNode instanceof ListSchemaNode) {
2043 linkToKeyClass.append(className);
2044 linkToKeyClass.append("Key");
2049 sb.append("This class represents the following YANG schema fragment defined in module <b>");
2050 sb.append(module.getName());
2052 sb.append(NEW_LINE);
2053 sb.append("<br />(Source path: <i>");
2054 sb.append(module.getModuleSourcePath());
2055 sb.append("</i>):");
2056 sb.append(NEW_LINE);
2058 sb.append(NEW_LINE);
2059 sb.append(YangTemplate.generateYangSnipet(schemaNode));
2060 sb.append("</pre>");
2061 sb.append(NEW_LINE);
2062 sb.append("The schema path to identify an instance is");
2063 sb.append(NEW_LINE);
2065 sb.append(YangTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
2067 sb.append(NEW_LINE);
2069 if (hasBuilderClass(schemaNode)) {
2070 sb.append(NEW_LINE);
2071 sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
2072 sb.append(NEW_LINE);
2074 sb.append(linkToBuilderClass);
2075 if (schemaNode instanceof ListSchemaNode) {
2077 sb.append(linkToKeyClass);
2079 sb.append(NEW_LINE);
2083 return sb.toString();
2086 private boolean hasBuilderClass(final SchemaNode schemaNode) {
2087 if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
2088 schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
2094 private boolean isNullOrEmpty(final String string) {
2095 return (string == null || string.isEmpty() ? true : false);
2098 private String createDescription(final Module module) {
2099 final StringBuilder sb = new StringBuilder();
2100 final String formattedDescription = YangTemplate.formatToParagraph(module.getDescription(), 0);
2102 if (!isNullOrEmpty(formattedDescription)) {
2103 sb.append(formattedDescription);
2104 sb.append(NEW_LINE);
2107 if (verboseClassComments) {
2109 sb.append("This class represents the following YANG schema fragment defined in module <b>");
2110 sb.append(module.getName());
2112 sb.append(NEW_LINE);
2113 sb.append("<br />Source path: <i>");
2114 sb.append(module.getModuleSourcePath());
2115 sb.append("</i>):");
2116 sb.append(NEW_LINE);
2118 sb.append(NEW_LINE);
2119 sb.append(YangTemplate.generateYangSnipet(module));
2120 sb.append("</pre>");
2123 return sb.toString();
2126 private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) {
2127 for (ModuleContext ctx : genCtx.values()) {
2128 GeneratedTypeBuilder result = ctx.getChildNode(path);
2129 if (result != null) {
2136 private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) {
2137 for (ModuleContext ctx : genCtx.values()) {
2138 GeneratedTypeBuilder result = ctx.getGrouping(path);
2139 if (result != null) {
2146 private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) {
2147 for (ModuleContext ctx : genCtx.values()) {
2148 GeneratedTypeBuilder result = ctx.getCase(path);
2149 if (result != null) {
2156 public Map<Module, ModuleContext> getModuleContexts() {