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.mdsal.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.mdsal.binding.generator.util.BindingGeneratorUtil.computeDefaultSUID;
14 import static org.opendaylight.mdsal.binding.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
15 import static org.opendaylight.mdsal.binding.generator.util.BindingGeneratorUtil.packageNameForAugmentedGeneratedType;
16 import static org.opendaylight.mdsal.binding.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
17 import static org.opendaylight.mdsal.binding.generator.util.BindingTypes.DATA_OBJECT;
18 import static org.opendaylight.mdsal.binding.generator.util.BindingTypes.DATA_ROOT;
19 import static org.opendaylight.mdsal.binding.generator.util.BindingTypes.IDENTIFIABLE;
20 import static org.opendaylight.mdsal.binding.generator.util.BindingTypes.IDENTIFIER;
21 import static org.opendaylight.mdsal.binding.generator.util.BindingTypes.NOTIFICATION;
22 import static org.opendaylight.mdsal.binding.generator.util.BindingTypes.augmentable;
23 import static org.opendaylight.mdsal.binding.generator.util.Types.BOOLEAN;
24 import static org.opendaylight.mdsal.binding.generator.util.Types.FUTURE;
25 import static org.opendaylight.mdsal.binding.generator.util.Types.VOID;
26 import static org.opendaylight.mdsal.binding.generator.util.Types.typeForClass;
27 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
28 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findNodeInSchemaContext;
29 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
31 import com.google.common.annotations.VisibleForTesting;
32 import com.google.common.base.Optional;
33 import com.google.common.base.Preconditions;
34 import com.google.common.base.Splitter;
35 import com.google.common.base.Strings;
36 import com.google.common.collect.Iterables;
37 import com.google.common.collect.Sets;
38 import java.util.ArrayList;
39 import java.util.Collection;
40 import java.util.Comparator;
41 import java.util.HashMap;
42 import java.util.Iterator;
43 import java.util.List;
46 import java.util.regex.Pattern;
47 import org.opendaylight.mdsal.binding.generator.api.BindingGenerator;
48 import org.opendaylight.mdsal.binding.generator.spi.TypeProvider;
49 import org.opendaylight.mdsal.binding.generator.util.BindingGeneratorUtil;
50 import org.opendaylight.mdsal.binding.generator.util.BindingTypes;
51 import org.opendaylight.mdsal.binding.generator.util.ReferencedTypeImpl;
52 import org.opendaylight.mdsal.binding.generator.util.Types;
53 import org.opendaylight.mdsal.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
54 import org.opendaylight.mdsal.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
55 import org.opendaylight.mdsal.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
56 import org.opendaylight.mdsal.binding.model.api.AccessModifier;
57 import org.opendaylight.mdsal.binding.model.api.Constant;
58 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
59 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
60 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
61 import org.opendaylight.mdsal.binding.model.api.Restrictions;
62 import org.opendaylight.mdsal.binding.model.api.Type;
63 import org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder;
64 import org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder;
65 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder;
66 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
67 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
68 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
69 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
70 import org.opendaylight.mdsal.binding.yang.types.GroupingDefinitionDependencySort;
71 import org.opendaylight.mdsal.binding.yang.types.TypeProviderImpl;
72 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
73 import org.opendaylight.yangtools.yang.binding.BindingMapping;
74 import org.opendaylight.yangtools.yang.binding.DataContainer;
75 import org.opendaylight.yangtools.yang.binding.RpcService;
76 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
77 import org.opendaylight.yangtools.yang.common.QName;
78 import org.opendaylight.yangtools.yang.common.RpcResult;
79 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
80 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
81 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
83 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
84 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
87 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
90 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
91 import org.opendaylight.yangtools.yang.model.api.Module;
92 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
93 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
94 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
95 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
96 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
97 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
98 import org.opendaylight.yangtools.yang.model.api.Status;
99 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
100 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
101 import org.opendaylight.yangtools.yang.model.api.UsesNode;
102 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
103 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
104 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
105 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
106 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
107 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
108 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
109 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
110 import org.opendaylight.yangtools.yang.model.util.type.CompatUtils;
111 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
112 import org.slf4j.Logger;
113 import org.slf4j.LoggerFactory;
115 public class BindingGeneratorImpl implements BindingGenerator {
116 private static final Logger LOG = LoggerFactory.getLogger(BindingGeneratorImpl.class);
117 private static final Splitter COLON_SPLITTER = Splitter.on(':');
118 private static final Splitter BSDOT_SPLITTER = Splitter.on("\\.");
119 private static final char NEW_LINE = '\n';
122 * Comparator based on augment target path.
124 private static final Comparator<AugmentationSchema> AUGMENT_COMP = (o1, o2) -> {
125 final Iterator<QName> thisIt = o1.getTargetPath().getPathFromRoot().iterator();
126 final Iterator<QName> otherIt = o2.getTargetPath().getPathFromRoot().iterator();
128 while (thisIt.hasNext()) {
129 if (!otherIt.hasNext()) {
133 final int comp = thisIt.next().compareTo(otherIt.next());
139 return otherIt.hasNext() ? -1 : 0;
143 * Constant with the concrete name of identifier.
145 private static final String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
148 * Constant with the concrete name of namespace.
150 private static final String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
152 private static final Pattern UNICODE_CHAR_PATTERN = Pattern.compile("\\\\+u");
154 private final Map<Module, ModuleContext> genCtx = new HashMap<>();
157 * When set to true, generated classes will include javadoc comments which
158 * are useful for users.
160 private final boolean verboseClassComments;
163 * Outer key represents the package name. Outer value represents map of all
164 * builders in the same package. Inner key represents the schema node name
165 * (in JAVA class/interface name format). Inner value represents instance of
166 * builder for schema node specified in key part.
168 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
171 * Provide methods for converting YANG types to JAVA types.
173 private TypeProvider typeProvider;
176 * Holds reference to schema context to resolve data of augmented element
177 * when creating augmentation builder
179 private SchemaContext schemaContext;
182 * Create a new binding generator.
184 * @param verboseClassComments generate verbose comments
186 public BindingGeneratorImpl(final boolean verboseClassComments) {
187 this.verboseClassComments = verboseClassComments;
191 * Resolves generated types from <code>context</code> schema nodes of all
194 * Generated types are created for modules, groupings, types, containers,
195 * lists, choices, augments, rpcs, notification, identities.
198 * schema context which contains data about all schema nodes
200 * @return list of types (usually <code>GeneratedType</code>
201 * <code>GeneratedTransferObject</code>which are generated from
202 * <code>context</code> data.
203 * @throws IllegalArgumentException
204 * if arg <code>context</code> is null
205 * @throws IllegalStateException
206 * if <code>context</code> contain no modules
209 public List<Type> generateTypes(final SchemaContext context) {
210 checkArgument(context != null, "Schema Context reference cannot be NULL.");
211 checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
212 schemaContext = context;
213 typeProvider = new TypeProviderImpl(context);
214 final Set<Module> modules = context.getModules();
215 return generateTypes(context, modules);
219 * Resolves generated types from <code>context</code> schema nodes only for
220 * modules specified in <code>modules</code>
222 * Generated types are created for modules, groupings, types, containers,
223 * lists, choices, augments, rpcs, notification, identities.
226 * schema context which contains data about all schema nodes
229 * set of modules for which schema nodes should be generated
231 * @return list of types (usually <code>GeneratedType</code> or
232 * <code>GeneratedTransferObject</code>) which:
234 * <li>are generated from <code>context</code> schema nodes and</li>
235 * <li>are also part of some of the module in <code>modules</code>
238 * @throws IllegalArgumentException
240 * <li>if arg <code>context</code> is null or</li>
241 * <li>if arg <code>modules</code> is null</li>
243 * @throws IllegalStateException
244 * if <code>context</code> contain no modules
247 public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {
248 checkArgument(context != null, "Schema Context reference cannot be NULL.");
249 checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
250 checkArgument(modules != null, "Set of Modules cannot be NULL.");
252 schemaContext = context;
253 typeProvider = new TypeProviderImpl(context);
254 final Module[] modulesArray = new Module[context.getModules().size()];
255 context.getModules().toArray(modulesArray);
256 final List<Module> contextModules = ModuleDependencySort.sort(modulesArray);
257 genTypeBuilders = new HashMap<>();
259 for (final Module contextModule : contextModules) {
260 moduleToGenTypes(contextModule, context);
262 for (final Module contextModule : contextModules) {
263 allAugmentsToGenTypes(contextModule);
266 final List<Type> filteredGenTypes = new ArrayList<>();
267 for (final Module m : modules) {
268 final ModuleContext ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m);
269 filteredGenTypes.addAll(ctx.getGeneratedTypes());
270 final Set<Type> additionalTypes = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(m);
271 if (additionalTypes != null) {
272 filteredGenTypes.addAll(additionalTypes);
276 return filteredGenTypes;
279 private void moduleToGenTypes(final Module m, final SchemaContext context) {
280 genCtx.put(m, new ModuleContext());
281 allTypeDefinitionsToGenTypes(m);
282 groupingsToGenTypes(m, m.getGroupings());
283 rpcMethodsToGenType(m);
284 allIdentitiesToGenTypes(m, context);
285 notificationsToGenType(m);
287 if (!m.getChildNodes().isEmpty()) {
288 final GeneratedTypeBuilder moduleType = moduleToDataType(m);
289 genCtx.get(m).addModuleNode(moduleType);
290 final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
291 resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.getChildNodes());
296 * Converts all extended type definitions of module to the list of
297 * <code>Type</code> objects.
300 * module from which is obtained set of type definitions
301 * @throws IllegalArgumentException
303 * <li>if module is null</li>
304 * <li>if name of module is null</li>
306 * @throws IllegalStateException
307 * if set of type definitions from module is null
309 private void allTypeDefinitionsToGenTypes(final Module module) {
310 checkArgument(module != null, "Module reference cannot be NULL.");
311 checkArgument(module.getName() != null, "Module name cannot be NULL.");
312 final DataNodeIterator it = new DataNodeIterator(module);
313 final List<TypeDefinition<?>> typeDefinitions = it.allTypedefs();
314 checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL.");
316 for (final TypeDefinition<?> typedef : typeDefinitions) {
317 if (typedef != null) {
318 final Type type = ((TypeProviderImpl) typeProvider).generatedTypeForExtendedDefinitionType(typedef,
321 final ModuleContext ctx = genCtx.get(module);
322 ctx.addTypedefType(typedef.getPath(), type);
323 ctx.addTypeToSchema(type,typedef);
329 private GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
330 final GeneratedTypeBuilder childOf, final DataSchemaNode node) {
331 if (node.isAugmenting() || node.isAddedByUses()) {
334 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
335 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module);
336 genType.addComment(node.getDescription());
337 annotateDeprecatedIfNecessary(node.getStatus(), genType);
338 genType.setDescription(createDescription(node, genType.getFullyQualifiedName()));
339 genType.setModuleName(module.getName());
340 genType.setReference(node.getReference());
341 genType.setSchemaPath(node.getPath().getPathFromRoot());
342 if (node instanceof DataNodeContainer) {
343 genCtx.get(module).addChildNodeType(node, genType);
344 groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings());
345 processUsesAugments((DataNodeContainer) node, module);
350 private void containerToGenType(final Module module, final String basePackageName,
351 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node) {
352 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
353 if (genType != null) {
354 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType, node.getStatus());
355 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes());
359 private void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder parent,
360 final GeneratedTypeBuilder childOf, final ListSchemaNode node) {
361 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
362 if (genType != null) {
363 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(),
364 Types.listTypeFor(genType), node.getStatus());
366 final List<String> listKeys = listKeys(node);
367 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
368 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
369 if (genTOBuilder != null) {
370 final Type identifierMarker = Types.parameterizedTypeFor(IDENTIFIER, genType);
371 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
372 genTOBuilder.addImplementsType(identifierMarker);
373 genType.addImplementsType(identifiableMarker);
376 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
377 if (!schemaNode.isAugmenting()) {
378 addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
383 if (genTOBuilder != null) {
384 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
385 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
386 genTOBuilder.setSUID(prop);
389 typeBuildersToGenTypes(module, genType, genTOBuilder);
393 private void processUsesAugments(final DataNodeContainer node, final Module module) {
394 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
395 for (final UsesNode usesNode : node.getUses()) {
396 for (final AugmentationSchema augment : usesNode.getAugmentations()) {
397 usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
398 processUsesAugments(augment, module);
404 * Converts all <b>augmentation</b> of the module to the list
405 * <code>Type</code> objects.
408 * module from which is obtained list of all augmentation objects
409 * to iterate over them
410 * @throws IllegalArgumentException
412 * <li>if the module is null</li>
413 * <li>if the name of module is null</li>
415 * @throws IllegalStateException
416 * if set of augmentations from module is null
418 private void allAugmentsToGenTypes(final Module module) {
419 checkArgument(module != null, "Module reference cannot be NULL.");
420 checkArgument(module.getName() != null, "Module name cannot be NULL.");
421 checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
423 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
424 final List<AugmentationSchema> augmentations = resolveAugmentations(module);
425 for (final AugmentationSchema augment : augmentations) {
426 augmentationToGenTypes(basePackageName, augment, module);
431 * Returns list of <code>AugmentationSchema</code> objects. The objects are
432 * sorted according to the length of their target path from the shortest to
436 * module from which is obtained list of all augmentation objects
437 * @return list of sorted <code>AugmentationSchema</code> objects obtained
438 * from <code>module</code>
439 * @throws IllegalArgumentException
441 * @throws IllegalStateException
442 * if set of module augmentations is null
444 private static List<AugmentationSchema> resolveAugmentations(final Module module) {
445 checkArgument(module != null, "Module reference cannot be NULL.");
446 checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
448 final Set<AugmentationSchema> augmentations = module.getAugmentations();
449 final List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);
450 sortedAugmentations.sort(AUGMENT_COMP);
452 return sortedAugmentations;
456 * Create GeneratedTypeBuilder object from module argument.
459 * Module object from which builder will be created
460 * @return <code>GeneratedTypeBuilder</code> which is internal
461 * representation of the module
462 * @throws IllegalArgumentException
465 private GeneratedTypeBuilder moduleToDataType(final Module module) {
466 checkArgument(module != null, "Module reference cannot be NULL.");
468 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
469 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
470 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
471 moduleDataTypeBuilder.addComment(module.getDescription());
472 moduleDataTypeBuilder.setDescription(createDescription(module));
473 moduleDataTypeBuilder.setReference(module.getReference());
474 return moduleDataTypeBuilder;
478 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
479 * to the list of <code>Type</code> objects. In addition are to containers
480 * and lists which belong to input or output also part of returning list.
483 * module from which is obtained set of all rpc objects to
485 * @throws IllegalArgumentException
487 * <li>if the module is null</li>
488 * <li>if the name of module is null</li>
490 * @throws IllegalStateException
491 * if set of rpcs from module is null
493 private void rpcMethodsToGenType(final Module module) {
494 checkArgument(module != null, "Module reference cannot be NULL.");
495 checkArgument(module.getName() != null, "Module name cannot be NULL.");
496 final Set<RpcDefinition> rpcDefinitions = module.getRpcs();
497 checkState(rpcDefinitions != null, "Set of rpcs from module " + module.getName() + " cannot be NULL.");
498 if (rpcDefinitions.isEmpty()) {
502 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
503 final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, "Service");
504 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService.class));
505 interfaceBuilder.setDescription(createDescription(rpcDefinitions, module.getName()));
507 for (final RpcDefinition rpc : rpcDefinitions) {
509 final String rpcName = BindingMapping.getClassName(rpc.getQName());
510 final String rpcMethodName = BindingMapping.getPropertyName(rpcName);
511 final String rpcComment = encodeAngleBrackets(rpc.getDescription());
512 final MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName);
513 final ContainerSchemaNode input = rpc.getInput();
514 final ContainerSchemaNode output = rpc.getOutput();
516 //in case of implicit RPC input (StatementSource.CONTEXT),
517 // stay compatible (no input argument generated)
518 if (input != null && isExplicitStatement(input)) {
519 final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
520 addImplementedInterfaceFromUses(input, inType);
521 inType.addImplementsType(DATA_OBJECT);
522 inType.addImplementsType(augmentable(inType));
523 annotateDeprecatedIfNecessary(rpc.getStatus(), inType);
524 resolveDataSchemaNodes(module, basePackageName, inType, inType, input.getChildNodes());
525 genCtx.get(module).addChildNodeType(input, inType);
526 final GeneratedType inTypeInstance = inType.toInstance();
527 method.addParameter(inTypeInstance, "input");
530 Type outTypeInstance = VOID;
531 //in case of implicit RPC output (StatementSource.CONTEXT),
532 //stay compatible (Future<RpcResult<Void>> return type generated)
533 if (output != null && isExplicitStatement(output)) {
534 final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
535 addImplementedInterfaceFromUses(output, outType);
536 outType.addImplementsType(DATA_OBJECT);
537 outType.addImplementsType(augmentable(outType));
538 annotateDeprecatedIfNecessary(rpc.getStatus(), outType);
539 resolveDataSchemaNodes(module, basePackageName, outType, outType, output.getChildNodes());
540 genCtx.get(module).addChildNodeType(output, outType);
541 outTypeInstance = outType.toInstance();
544 final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);
545 method.setComment(rpcComment);
546 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
550 genCtx.get(module).addTopLevelNodeType(interfaceBuilder);
553 private static boolean isExplicitStatement(ContainerSchemaNode node) {
554 return node instanceof EffectiveStatement
555 && ((EffectiveStatement) node).getDeclared().getStatementSource() == StatementSource.DECLARATION;
559 * Converts all <b>notifications</b> of the module to the list of
560 * <code>Type</code> objects. In addition are to this list added containers
561 * and lists which are part of this notification.
564 * module from which is obtained set of all notification objects
565 * to iterate over them
566 * @throws IllegalArgumentException
568 * <li>if the module equals null</li>
569 * <li>if the name of module equals null</li>
571 * @throws IllegalStateException
572 * if set of notifications from module is null
574 private void notificationsToGenType(final Module module) {
575 checkArgument(module != null, "Module reference cannot be NULL.");
576 checkArgument(module.getName() != null, "Module name cannot be NULL.");
577 final Set<NotificationDefinition> notifications = module.getNotifications();
578 if (notifications.isEmpty()) {
582 final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");
583 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
584 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
588 for (final NotificationDefinition notification : notifications) {
589 if (notification != null) {
590 processUsesAugments(notification, module);
592 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,
593 notification, null, module);
594 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
595 notificationInterface.addImplementsType(NOTIFICATION);
596 genCtx.get(module).addChildNodeType(notification, notificationInterface);
598 // Notification object
599 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
600 notification.getChildNodes());
602 listenerInterface.addMethod("on" + notificationInterface.getName())
603 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
604 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
607 listenerInterface.setDescription(createDescription(notifications, module.getName()));
609 genCtx.get(module).addTopLevelNodeType(listenerInterface);
613 * Converts all <b>identities</b> of the module to the list of
614 * <code>Type</code> objects.
617 * module from which is obtained set of all identity objects to
620 * schema context only used as input parameter for method
621 * {@link BindingGeneratorImpl#identityToGenType}
624 private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) {
625 final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
626 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
628 if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
629 for (final IdentitySchemaNode identity : schemaIdentities) {
630 identityToGenType(module, basePackageName, identity, context);
636 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
637 * created transport object builder. If identity contains base identity then
638 * reference to base identity is added to superior identity as its extend.
639 * If identity doesn't contain base identity then only reference to abstract
640 * class {@link org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode
641 * BaseIdentity} is added
645 * @param basePackageName
646 * string contains the module package name
648 * IdentitySchemaNode which contains data about identity
650 * SchemaContext which is used to get package and name
651 * information about base of identity
654 private void identityToGenType(final Module module, final String basePackageName,
655 final IdentitySchemaNode identity, final SchemaContext context) {
656 if (identity == null) {
659 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
660 final String genTypeName = BindingMapping.getClassName(identity.getQName());
661 final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
662 final IdentitySchemaNode baseIdentity = identity.getBaseIdentity();
663 if (baseIdentity == null) {
664 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
665 BaseIdentity.class.getSimpleName());
666 newType.setExtendsType(gto.toInstance());
668 final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
669 final String returnTypePkgName = BindingMapping.getRootPackageName(baseIdentityParentModule
671 final String returnTypeName = BindingMapping.getClassName(baseIdentity.getQName());
672 final GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName)
674 newType.setExtendsType(gto);
676 newType.setAbstract(true);
677 newType.addComment(identity.getDescription());
678 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName()));
679 newType.setReference(identity.getReference());
680 newType.setModuleName(module.getName());
681 newType.setSchemaPath(identity.getPath().getPathFromRoot());
683 final QName qname = identity.getQName();
684 qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, qname);
686 genCtx.get(module).addIdentityType(identity.getQName(), newType);
689 private static Constant qnameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
691 return toBuilder.addConstant(typeForClass(QName.class), constantName, name);
695 * Converts all <b>groupings</b> of the module to the list of
696 * <code>Type</code> objects. Firstly are groupings sorted according mutual
697 * dependencies. At least dependent (independent) groupings are in the list
698 * saved at first positions. For every grouping the record is added to map
699 * {@link ModuleContext#groupings allGroupings}
704 * collection of groupings from which types will be generated
707 private void groupingsToGenTypes(final Module module, final Collection<GroupingDefinition> groupings) {
708 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
709 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
711 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
712 groupingToGenType(basePackageName, grouping, module);
717 * Converts individual grouping to GeneratedType. Firstly generated type
718 * builder is created and every child node of grouping is resolved to the
721 * @param basePackageName
722 * string contains the module package name
724 * GroupingDefinition which contains data about grouping
727 * @return GeneratedType which is generated from grouping (object of type
728 * <code>GroupingDefinition</code>)
730 private void groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module module) {
731 final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());
732 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module);
733 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
734 genCtx.get(module).addGroupingType(grouping.getPath(), genType);
735 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes());
736 groupingsToGenTypes(module, grouping.getGroupings());
737 processUsesAugments(grouping, module);
741 * Adds enumeration builder created from <code>enumTypeDef</code> to
742 * <code>typeBuilder</code>.
744 * Each <code>enumTypeDef</code> item is added to builder with its name and
748 * EnumTypeDefinition contains enum data
750 * string contains name which will be assigned to enumeration
753 * GeneratedTypeBuilder to which will be enum builder assigned
755 * Module in which type should be generated
756 * @return enumeration builder which contains data from
757 * <code>enumTypeDef</code>
759 private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
760 final GeneratedTypeBuilder typeBuilder, final Module module) {
761 if (enumTypeDef != null && typeBuilder != null && enumTypeDef.getQName().getLocalName() != null) {
762 final String enumerationName = BindingMapping.getClassName(enumName);
763 final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
764 final String enumTypedefDescription = encodeAngleBrackets(enumTypeDef.getDescription());
765 enumBuilder.setDescription(enumTypedefDescription);
766 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
767 ModuleContext ctx = genCtx.get(module);
768 ctx.addInnerTypedefType(enumTypeDef.getPath(), enumBuilder);
775 * Generates type builder for <code>module</code>.
778 * Module which is source of package name for generated type
781 * string which is added to the module class name representation
783 * @return instance of GeneratedTypeBuilder which represents
784 * <code>module</code>.
785 * @throws IllegalArgumentException
786 * if <code>module</code> is null
788 private GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {
789 checkArgument(module != null, "Module reference cannot be NULL.");
790 final String packageName = BindingMapping.getRootPackageName(module.getQNameModule());
791 final String moduleName = BindingMapping.getClassName(module.getName()) + postfix;
793 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
794 moduleBuilder.setDescription(createDescription(module));
795 moduleBuilder.setReference(module.getReference());
796 moduleBuilder.setModuleName(moduleName);
798 return moduleBuilder;
802 * Converts <code>augSchema</code> to list of <code>Type</code> which
803 * contains generated type for augmentation. In addition there are also
804 * generated types for all containers, list and choices which are child of
805 * <code>augSchema</code> node or a generated types for cases are added if
806 * augmented node is choice.
808 * @param augmentPackageName
809 * string with the name of the package to which the augmentation
812 * AugmentationSchema which is contains data about augmentation
813 * (target path, childs...)
816 * @throws IllegalArgumentException
818 * <li>if <code>augmentPackageName</code> equals null</li>
819 * <li>if <code>augSchema</code> equals null</li>
821 * @throws IllegalStateException
822 * if augment target path is null
824 private void augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
825 final Module module) {
826 checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
827 checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
828 checkState(augSchema.getTargetPath() != null,
829 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
831 processUsesAugments(augSchema, module);
832 final SchemaPath targetPath = augSchema.getTargetPath();
833 SchemaNode targetSchemaNode = null;
835 targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
836 if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
837 if (targetSchemaNode instanceof DerivableSchemaNode) {
838 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
840 if (targetSchemaNode == null) {
841 throw new IllegalStateException("Failed to find target node from grouping in augmentation " + augSchema
842 + " in module " + module.getName());
845 if (targetSchemaNode == null) {
846 throw new IllegalArgumentException("augment target not found: " + targetPath);
849 GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
850 if (targetTypeBuilder == null) {
851 targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
853 if (targetTypeBuilder == null) {
854 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
857 if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
858 final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(),
859 targetTypeBuilder.getName());
860 addRawAugmentGenTypeDefinition(module, augmentPackageName, augmentPackageName, targetType, augSchema);
863 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
864 (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes(), null);
868 private void usesAugmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
869 final Module module, final UsesNode usesNode, final DataNodeContainer usesNodeParent) {
870 checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
871 checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
872 checkState(augSchema.getTargetPath() != null,
873 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
875 processUsesAugments(augSchema, module);
876 final SchemaPath targetPath = augSchema.getTargetPath();
877 final SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
878 if (targetSchemaNode == null) {
879 throw new IllegalArgumentException("augment target not found: " + targetPath);
882 GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
883 if (targetTypeBuilder == null) {
884 targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
886 if (targetTypeBuilder == null) {
887 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
890 if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
891 String packageName = augmentPackageName;
892 if (usesNodeParent instanceof SchemaNode) {
893 packageName = packageNameForAugmentedGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath());
895 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(),
898 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
899 (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes(), usesNodeParent);
904 * Convenient method to find node added by uses statement.
908 * @param parentUsesNode
909 * parent of uses node
910 * @return node from its original location in grouping
912 private DataSchemaNode findOriginalTargetFromGrouping(final SchemaPath targetPath, final UsesNode parentUsesNode) {
913 final SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath()
915 if (!(targetGrouping instanceof GroupingDefinition)) {
916 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
919 SchemaNode result = targetGrouping;
920 for (final QName node : targetPath.getPathFromRoot()) {
921 if (result instanceof DataNodeContainer) {
922 final QName resultNode = QName.create(result.getQName().getModule(), node.getLocalName());
923 result = ((DataNodeContainer) result).getDataChildByName(resultNode);
924 } else if (result instanceof ChoiceSchemaNode) {
925 result = ((ChoiceSchemaNode) result).getCaseNodeByName(node.getLocalName());
928 if (result == null) {
932 if (result instanceof DerivableSchemaNode) {
933 DerivableSchemaNode castedResult = (DerivableSchemaNode) result;
934 Optional<? extends SchemaNode> originalNode = castedResult
936 if (castedResult.isAddedByUses() && originalNode.isPresent()) {
937 result = originalNode.get();
941 if (result instanceof DataSchemaNode) {
942 DataSchemaNode resultDataSchemaNode = (DataSchemaNode) result;
943 if (resultDataSchemaNode.isAddedByUses()) {
944 // The original node is required, but we have only the copy of
945 // the original node.
946 // Maybe this indicates a bug in Yang parser.
947 throw new IllegalStateException(
948 "Failed to generate code for augment in "
951 return resultDataSchemaNode;
954 throw new IllegalStateException(
955 "Target node of uses-augment statement must be DataSchemaNode. Failed to generate code for augment in "
961 * Returns a generated type builder for an augmentation.
963 * The name of the type builder is equal to the name of augmented node with
964 * serial number as suffix.
968 * @param augmentPackageName
969 * string with contains the package name to which the augment
971 * @param basePackageName
972 * string with the package name to which the augmented node
974 * @param targetTypeRef
977 * augmentation schema which contains data about the child nodes
978 * and uses of augment
979 * @return generated type builder for augment
981 private GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
982 final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema) {
983 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
984 if (augmentBuilders == null) {
985 augmentBuilders = new HashMap<>();
986 genTypeBuilders.put(augmentPackageName, augmentBuilders);
988 final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
991 if (augIdentifier != null) {
992 augTypeName = BindingMapping.getClassName(augIdentifier);
994 augTypeName = augGenTypeName(augmentBuilders, targetTypeRef.getName());
997 final GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
999 augTypeBuilder.addImplementsType(DATA_OBJECT);
1000 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
1001 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
1002 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
1004 augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes());
1005 augmentBuilders.put(augTypeName, augTypeBuilder);
1007 if (!augSchema.getChildNodes().isEmpty()) {
1008 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
1011 genCtx.get(module).addAugmentType(augTypeBuilder);
1012 return augTypeBuilder;
1017 * @param unknownSchemaNodes
1018 * @return nodeParameter of UnknownSchemaNode
1020 private static String getAugmentIdentifier(final List<UnknownSchemaNode> unknownSchemaNodes) {
1021 for (final UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
1022 final QName nodeType = unknownSchemaNode.getNodeType();
1023 if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())
1024 && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {
1025 return unknownSchemaNode.getNodeParameter();
1032 * Returns first unique name for the augment generated type builder. The
1033 * generated type builder name for augment consists from name of augmented
1034 * node and serial number of its augmentation.
1037 * map of builders which were created in the package to which the
1038 * augmentation belongs
1039 * @param genTypeName
1040 * string with name of augmented node
1041 * @return string with unique name for augmentation builder
1043 private static String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {
1045 if (builders != null) {
1046 while (builders.containsKey(genTypeName + index)) {
1050 return genTypeName + index;
1054 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
1055 * node for which <code>typeBuilder</code> was created.
1057 * The subnodes aren't mapped to the methods if they are part of grouping or
1058 * augment (in this case are already part of them).
1062 * @param basePackageName
1063 * string contains the module package name
1065 * generated type builder which represents any node. The subnodes
1066 * of this node are added to the <code>typeBuilder</code> as
1067 * methods. The subnode can be of type leaf, leaf-list, list,
1068 * container, choice.
1071 * @param schemaNodes
1072 * set of data schema nodes which are the children of the node
1073 * for which <code>typeBuilder</code> was created
1074 * @return generated type builder which is the same builder as input
1075 * parameter. The getter methods (representing child nodes) could be
1078 private GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
1079 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes) {
1080 if (schemaNodes != null && parent != null) {
1081 for (final DataSchemaNode schemaNode : schemaNodes) {
1082 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
1083 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1091 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
1092 * node for which <code>typeBuilder</code> was created.
1096 * @param basePackageName
1097 * string contains the module package name
1098 * @param typeBuilder
1099 * generated type builder which represents any node. The subnodes
1100 * of this node are added to the <code>typeBuilder</code> as
1101 * methods. The subnode can be of type leaf, leaf-list, list,
1102 * container, choice.
1105 * @param schemaNodes
1106 * set of data schema nodes which are the children of the node
1107 * for which <code>typeBuilder</code> was created
1108 * @return generated type builder which is the same object as the input
1109 * parameter <code>typeBuilder</code>. The getter method could be
1112 private GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
1113 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf,
1114 final Iterable<DataSchemaNode> schemaNodes) {
1115 if ((schemaNodes != null) && (typeBuilder != null)) {
1116 for (final DataSchemaNode schemaNode : schemaNodes) {
1117 if (!schemaNode.isAugmenting()) {
1118 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1126 * Adds to <code>typeBuilder</code> a method which is derived from
1127 * <code>schemaNode</code>.
1129 * @param basePackageName
1130 * string with the module package name
1132 * data schema node which is added to <code>typeBuilder</code> as
1134 * @param typeBuilder
1135 * generated type builder to which is <code>schemaNode</code>
1136 * added as a method.
1142 private void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
1143 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module) {
1144 if (node != null && typeBuilder != null) {
1145 if (node instanceof LeafSchemaNode) {
1146 resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) node, module);
1147 } else if (node instanceof LeafListSchemaNode) {
1148 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node,module);
1149 } else if (node instanceof ContainerSchemaNode) {
1150 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node);
1151 } else if (node instanceof ListSchemaNode) {
1152 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node);
1153 } else if (node instanceof ChoiceSchemaNode) {
1154 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) node);
1156 // TODO: anyxml not yet supported
1157 LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
1158 typeBuilder.getFullyQualifiedName());
1164 * Converts <code>choiceNode</code> to the list of generated types for
1165 * choice and its cases.
1167 * The package names for choice and for its cases are created as
1168 * concatenation of the module package (<code>basePackageName</code>) and
1169 * names of all parents node.
1173 * @param basePackageName
1174 * string with the module package name
1178 * choice node which is mapped to generated type. Also child
1179 * nodes - cases are mapped to generated types.
1180 * @throws IllegalArgumentException
1182 * <li>if <code>basePackageName</code> is null</li>
1183 * <li>if <code>choiceNode</code> is null</li>
1186 private void choiceToGeneratedType(final Module module, final String basePackageName,
1187 final GeneratedTypeBuilder parent, final ChoiceSchemaNode choiceNode) {
1188 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1189 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
1191 if (!choiceNode.isAddedByUses()) {
1192 final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());
1193 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1194 constructGetter(parent, choiceNode.getQName().getLocalName(),
1195 choiceNode.getDescription(), choiceTypeBuilder, choiceNode.getStatus());
1196 choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class));
1197 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
1198 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
1199 generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode);
1204 * Converts <code>caseNodes</code> set to list of corresponding generated
1207 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1208 * created generated type builder. The package names for the builder is
1209 * created as concatenation of the module package (
1210 * <code>basePackageName</code>) and names of all parents nodes of the
1211 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1212 * between every case builder and <i>choice</i> type
1216 * @param basePackageName
1217 * string with the module package name
1218 * @param refChoiceType
1219 * type which represents superior <i>case</i>
1221 * choice case node which is mapped to generated type
1222 * @return list of generated types for <code>caseNodes</code>.
1223 * @throws IllegalArgumentException
1225 * <li>if <code>basePackageName</code> equals null</li>
1226 * <li>if <code>refChoiceType</code> equals null</li>
1227 * <li>if <code>caseNodes</code> equals null</li>
1230 private void generateTypesFromChoiceCases(final Module module, final String basePackageName,
1231 final Type refChoiceType, final ChoiceSchemaNode choiceNode) {
1232 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1233 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1234 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1236 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1237 if (caseNodes == null) {
1241 for (final ChoiceCaseNode caseNode : caseNodes) {
1242 if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1243 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1244 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1245 caseTypeBuilder.addImplementsType(refChoiceType);
1246 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1247 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1248 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1249 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1250 if (caseChildNodes != null) {
1251 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1253 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1254 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1256 if (parent instanceof AugmentationSchema) {
1257 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1258 final SchemaPath targetPath = augSchema.getTargetPath();
1259 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1260 if (targetSchemaNode instanceof DataSchemaNode
1261 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1262 if (targetSchemaNode instanceof DerivableSchemaNode) {
1263 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1265 if (targetSchemaNode == null) {
1266 throw new IllegalStateException(
1267 "Failed to find target node from grouping for augmentation " + augSchema
1268 + " in module " + module.getName());
1271 parent = targetSchemaNode;
1274 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1275 choiceNodeParentPath);
1276 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath());
1277 if (childOfType == null) {
1278 childOfType = findGroupingByPath(parent.getPath());
1280 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes);
1282 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module),
1287 processUsesAugments(caseNode, module);
1292 * Generates list of generated types for all the cases of a choice which are
1293 * added to the choice through the augment.
1297 * @param basePackageName
1298 * string contains name of package to which augment belongs. If
1299 * an augmented choice is from an other package (pcg1) than an
1300 * augmenting choice (pcg2) then case's of the augmenting choice
1301 * will belong to pcg2.
1303 * Type which represents target choice
1305 * node which represents target choice
1306 * @param augmentedNodes
1307 * set of choice case nodes for which is checked if are/aren't
1308 * added to choice through augmentation
1309 * @return list of generated types which represents augmented cases of
1310 * choice <code>refChoiceType</code>
1311 * @throws IllegalArgumentException
1313 * <li>if <code>basePackageName</code> is null</li>
1314 * <li>if <code>targetType</code> is null</li>
1315 * <li>if <code>augmentedNodes</code> is null</li>
1318 private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName,
1319 final Type targetType, final ChoiceSchemaNode targetNode, final Iterable<DataSchemaNode> augmentedNodes,
1320 final DataNodeContainer usesNodeParent) {
1321 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1322 checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
1323 checkArgument(augmentedNodes != null, "Set of Choice Case Nodes cannot be NULL.");
1325 for (final DataSchemaNode caseNode : augmentedNodes) {
1326 if (caseNode != null) {
1327 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1328 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1329 caseTypeBuilder.addImplementsType(targetType);
1332 final SchemaPath nodeSp = targetNode.getPath();
1333 parent = findDataSchemaNode(schemaContext, nodeSp.getParent());
1335 GeneratedTypeBuilder childOfType = null;
1336 if (parent instanceof Module) {
1337 childOfType = genCtx.get(parent).getModuleNode();
1338 } else if (parent instanceof ChoiceCaseNode) {
1339 childOfType = findCaseByPath(parent.getPath());
1340 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1341 childOfType = findChildNodeByPath(parent.getPath());
1342 } else if (parent instanceof GroupingDefinition) {
1343 childOfType = findGroupingByPath(parent.getPath());
1346 if (childOfType == null) {
1347 throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1350 ChoiceCaseNode node = null;
1351 final String caseLocalName = caseNode.getQName().getLocalName();
1352 if (caseNode instanceof ChoiceCaseNode) {
1353 node = (ChoiceCaseNode) caseNode;
1354 } else if (targetNode.getCaseNodeByName(caseLocalName) == null) {
1355 final String targetNodeLocalName = targetNode.getQName().getLocalName();
1356 for (DataSchemaNode dataSchemaNode : usesNodeParent.getChildNodes()) {
1357 if (dataSchemaNode instanceof ChoiceSchemaNode && targetNodeLocalName.equals(dataSchemaNode.getQName
1358 ().getLocalName())) {
1359 node = ((ChoiceSchemaNode) dataSchemaNode).getCaseNodeByName(caseLocalName);
1364 node = targetNode.getCaseNodeByName(caseLocalName);
1366 final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
1367 if (childNodes != null) {
1368 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1370 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1371 genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
1376 private static boolean isInnerType(final LeafSchemaNode leaf, final TypeDefinition<?> type) {
1377 // New parser with encapsulated type
1378 if (leaf.getPath().equals(type.getPath())) {
1382 // Embedded type definition with new parser. Also takes care of the old parser with bits
1383 if (leaf.getPath().equals(type.getPath().getParent())) {
1391 * Converts <code>leaf</code> to the getter method which is added to
1392 * <code>typeBuilder</code>.
1394 * @param typeBuilder
1395 * generated type builder to which is added getter method as
1396 * <code>leaf</code> mapping
1398 * leaf schema node which is mapped as getter method which is
1399 * added to <code>typeBuilder</code>
1401 * Module in which type was defined
1402 * @return boolean value
1404 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
1406 * <li>true - in other cases</li>
1409 private Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf, final Module module) {
1410 if (leaf == null || typeBuilder == null || leaf.isAddedByUses()) {
1414 final String leafName = leaf.getQName().getLocalName();
1415 if (leafName == null) {
1419 final Module parentModule = findParentModule(schemaContext, leaf);
1420 Type returnType = null;
1422 final TypeDefinition<?> typeDef = CompatUtils.compatLeafType(leaf);
1423 if (isInnerType(leaf, typeDef)) {
1424 if (typeDef instanceof EnumTypeDefinition) {
1425 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1426 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1427 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
1428 typeBuilder, module);
1429 if (enumBuilder != null) {
1430 returnType = enumBuilder.toInstance(typeBuilder);
1432 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1433 } else if (typeDef instanceof UnionTypeDefinition) {
1434 GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1435 if (genTOBuilder != null) {
1436 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1438 } else if (typeDef instanceof BitsTypeDefinition) {
1439 GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1440 if (genTOBuilder != null) {
1441 returnType = genTOBuilder.toInstance();
1444 // It is constrained version of already declared type (inner declared type exists,
1445 // onlyfor special cases (Enum, Union, Bits), which were already checked.
1446 // In order to get proper class we need to look up closest derived type
1447 // and apply restrictions from leaf type
1448 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1449 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
1453 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1454 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1457 if (returnType == null) {
1461 if (typeDef instanceof EnumTypeDefinition) {
1462 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1465 String leafDesc = leaf.getDescription();
1466 if (leafDesc == null) {
1470 final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType, leaf.getStatus());
1471 processContextRefExtension(leaf, getter, parentModule);
1475 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1476 // Returns DerivedType in case of new parser.
1477 final TypeDefinition<?> baseType = typeDef.getBaseType();
1478 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1481 private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter,
1482 final Module module) {
1483 for (final UnknownSchemaNode node : leaf.getUnknownSchemaNodes()) {
1484 final QName nodeType = node.getNodeType();
1485 if ("context-reference".equals(nodeType.getLocalName())) {
1486 final String nodeParam = node.getNodeParameter();
1487 IdentitySchemaNode identity = null;
1488 String basePackageName = null;
1489 final Iterable<String> splittedElement = COLON_SPLITTER.split(nodeParam);
1490 final Iterator<String> iterator = splittedElement.iterator();
1491 final int length = Iterables.size(splittedElement);
1493 identity = findIdentityByName(module.getIdentities(), iterator.next());
1494 basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
1495 } else if (length == 2) {
1496 final String prefix = iterator.next();
1497 final Module dependentModule = findModuleFromImports(module.getImports(), prefix);
1498 if (dependentModule == null) {
1499 throw new IllegalArgumentException("Failed to process context-reference: unknown prefix "
1502 identity = findIdentityByName(dependentModule.getIdentities(), iterator.next());
1503 basePackageName = BindingMapping.getRootPackageName(dependentModule.getQNameModule());
1505 throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1508 if (identity == null) {
1509 throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1513 final Class<RoutingContext> clazz = RoutingContext.class;
1514 final AnnotationTypeBuilder rc = getter.addAnnotation(clazz.getPackage().getName(),
1515 clazz.getSimpleName());
1516 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
1517 final String genTypeName = BindingMapping.getClassName(identity.getQName().getLocalName());
1518 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1523 private static IdentitySchemaNode findIdentityByName(final Set<IdentitySchemaNode> identities, final String name) {
1524 for (final IdentitySchemaNode id : identities) {
1525 if (id.getQName().getLocalName().equals(name)) {
1532 private Module findModuleFromImports(final Set<ModuleImport> imports, final String prefix) {
1533 for (final ModuleImport imp : imports) {
1534 if (imp.getPrefix().equals(prefix)) {
1535 return schemaContext.findModuleByName(imp.getModuleName(), imp.getRevision());
1541 private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1542 final boolean isReadOnly, final Module module) {
1543 if (leaf != null && toBuilder != null) {
1545 final TypeDefinition<?> typeDef = CompatUtils.compatLeafType(leaf);
1546 if (typeDef instanceof UnionTypeDefinition) {
1547 // GeneratedType for this type definition should be already
1549 final QName qname = typeDef.getQName();
1550 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1551 qname.getRevision());
1552 final ModuleContext mc = genCtx.get(unionModule);
1553 returnType = mc.getTypedefs().get(typeDef.getPath());
1554 } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) {
1555 // Annonymous enumeration (already generated, since it is inherited via uses).
1556 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1557 QName qname = originalLeaf.getQName();
1558 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1559 qname.getRevision());
1560 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1562 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1564 return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1570 * Converts <code>leaf</code> schema node to property of generated TO
1574 * generated TO builder to which is <code>leaf</code> added as
1577 * leaf schema node which is added to <code>toBuilder</code> as
1582 * boolean value which says if leaf property is|isn't read only
1583 * @return boolean value
1585 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
1586 * name equals null or if leaf is added by <i>uses</i>.</li>
1587 * <li>true - other cases</li>
1590 private static boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1591 final Type returnType, final boolean isReadOnly) {
1592 if (returnType == null) {
1595 final String leafName = leaf.getQName().getLocalName();
1596 final String leafDesc = encodeAngleBrackets(leaf.getDescription());
1597 final GeneratedPropertyBuilder propBuilder = toBuilder.addProperty(BindingMapping.getPropertyName(leafName));
1598 propBuilder.setReadOnly(isReadOnly);
1599 propBuilder.setReturnType(returnType);
1600 propBuilder.setComment(leafDesc);
1601 toBuilder.addEqualsIdentity(propBuilder);
1602 toBuilder.addHashIdentity(propBuilder);
1603 toBuilder.addToStringProperty(propBuilder);
1608 * Converts <code>node</code> leaf list schema node to getter method of
1609 * <code>typeBuilder</code>.
1611 * @param typeBuilder
1612 * generated type builder to which is <code>node</code> added as
1615 * leaf list schema node which is added to
1616 * <code>typeBuilder</code> as getter method
1617 * @param module module
1618 * @return boolean value
1620 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
1621 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
1622 * <li>false - other cases</li>
1625 private boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node, final Module module) {
1626 if (node == null || typeBuilder == null || node.isAddedByUses()) {
1630 final QName nodeName = node.getQName();
1632 final TypeDefinition<?> typeDef = node.getType();
1633 final Module parentModule = findParentModule(schemaContext, node);
1635 Type returnType = null;
1636 if (typeDef.getBaseType() == null) {
1637 if (typeDef instanceof EnumTypeDefinition) {
1638 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
1639 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1640 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
1641 typeBuilder,module);
1642 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
1643 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
1644 } else if (typeDef instanceof UnionTypeDefinition) {
1645 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1646 if (genTOBuilder != null) {
1647 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1649 } else if (typeDef instanceof BitsTypeDefinition) {
1650 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1651 returnType = genTOBuilder.toInstance();
1653 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1654 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1657 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1658 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1661 final ParameterizedType listType = Types.listTypeFor(returnType);
1662 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType, node.getStatus());
1666 private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition<?> typeDef,
1667 final GeneratedTypeBuilder typeBuilder, final Module parentModule) {
1668 final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(),
1669 genTOBuilder.getName());
1670 final String typedefDescription = encodeAngleBrackets(typeDef.getDescription());
1672 returnType.setDescription(typedefDescription);
1673 returnType.setReference(typeDef.getReference());
1674 returnType.setSchemaPath(typeDef.getPath().getPathFromRoot());
1675 returnType.setModuleName(parentModule.getName());
1677 genTOBuilder.setTypedef(true);
1678 genTOBuilder.setIsUnion(true);
1679 TypeProviderImpl.addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1683 final GeneratedTOBuilder unionBuilder = createUnionBuilder(genTOBuilder,typeBuilder);
1686 final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1687 method.setReturnType(returnType);
1688 method.addParameter(Types.STRING, "defaultValue");
1689 method.setAccessModifier(AccessModifier.PUBLIC);
1690 method.setStatic(true);
1692 final Set<Type> types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule);
1693 if (types == null) {
1694 ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule,
1695 Sets.newHashSet(unionBuilder.toInstance()));
1697 types.add(unionBuilder.toInstance());
1699 return returnType.toInstance();
1702 private static GeneratedTOBuilder createUnionBuilder(final GeneratedTOBuilder genTOBuilder, final GeneratedTypeBuilder typeBuilder) {
1703 final String outerCls = Types.getOuterClassName(genTOBuilder);
1704 final StringBuilder name;
1705 if (outerCls != null) {
1706 name = new StringBuilder(outerCls);
1708 name = new StringBuilder();
1710 name.append(genTOBuilder.getName());
1711 name.append("Builder");
1712 final GeneratedTOBuilderImpl unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),name.toString());
1713 unionBuilder.setIsUnionBuilder(true);
1714 return unionBuilder;
1717 private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1718 final Module module) {
1719 return addDefaultInterfaceDefinition(packageName, schemaNode, null, module);
1723 * Instantiates generated type builder with <code>packageName</code> and
1724 * <code>schemaNode</code>.
1726 * The new builder always implements
1727 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br>
1728 * If <code>schemaNode</code> is instance of GroupingDefinition it also
1729 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
1731 * If <code>schemaNode</code> is instance of
1732 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
1733 * DataNodeContainer} it can also implement nodes which are specified in
1736 * @param packageName
1737 * string with the name of the package to which
1738 * <code>schemaNode</code> belongs.
1740 * schema node for which is created generated type builder
1742 * parent type (can be null)
1743 * @return generated type builder <code>schemaNode</code>
1745 private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1746 final Type parent, final Module module) {
1747 final GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, "");
1748 if (parent == null) {
1749 it.addImplementsType(DATA_OBJECT);
1751 it.addImplementsType(BindingTypes.childOf(parent));
1753 if (!(schemaNode instanceof GroupingDefinition)) {
1754 it.addImplementsType(augmentable(it));
1757 if (schemaNode instanceof DataNodeContainer) {
1758 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings());
1759 addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it);
1766 * Wraps the calling of the same overloaded method.
1768 * @param packageName
1769 * string with the package name to which returning generated type
1772 * schema node which provide data about the schema node name
1773 * @return generated type builder for <code>schemaNode</code>
1775 private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {
1776 return addRawInterfaceDefinition(packageName, schemaNode, "");
1780 * Returns reference to generated type builder for specified
1781 * <code>schemaNode</code> with <code>packageName</code>.
1783 * Firstly the generated type builder is searched in
1784 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
1785 * found it is created and added to <code>genTypeBuilders</code>.
1787 * @param packageName
1788 * string with the package name to which returning generated type
1791 * schema node which provide data about the schema node name
1793 * return type name prefix
1794 * @return generated type builder for <code>schemaNode</code>
1795 * @throws IllegalArgumentException
1797 * <li>if <code>schemaNode</code> is null</li>
1798 * <li>if <code>packageName</code> is null</li>
1799 * <li>if QName of schema node is null</li>
1800 * <li>if schemaNode name is null</li>
1804 private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1805 final String prefix) {
1806 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1807 checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
1808 checkArgument(schemaNode.getQName() != null, "QName for Data Schema Node cannot be NULL.");
1809 final String schemaNodeName = schemaNode.getQName().getLocalName();
1810 checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
1813 if (prefix == null) {
1814 genTypeName = BindingMapping.getClassName(schemaNodeName);
1816 genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1819 // FIXME: Validation of name conflict
1820 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1821 final Module module = findParentModule(schemaContext, schemaNode);
1822 qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
1823 newType.addComment(schemaNode.getDescription());
1824 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName()));
1825 newType.setReference(schemaNode.getReference());
1826 newType.setSchemaPath(schemaNode.getPath().getPathFromRoot());
1827 newType.setModuleName(module.getName());
1829 if (!genTypeBuilders.containsKey(packageName)) {
1830 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
1831 builders.put(genTypeName, newType);
1832 genTypeBuilders.put(packageName, builders);
1834 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1835 if (!builders.containsKey(genTypeName)) {
1836 builders.put(genTypeName, newType);
1843 * Creates the name of the getter method name from <code>localName</code>.
1846 * string with the name of the getter method
1849 * @return string with the name of the getter method for
1850 * <code>methodName</code> in JAVA method format
1852 public static String getterMethodName(final String localName, final Type returnType) {
1853 final StringBuilder method = new StringBuilder();
1854 if (BOOLEAN.equals(returnType)) {
1855 method.append("is");
1857 method.append("get");
1859 final String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName));
1860 method.append(name);
1861 return method.toString();
1865 * Created a method signature builder as part of
1866 * <code>interfaceBuilder</code>.
1868 * The method signature builder is created for the getter method of
1869 * <code>schemaNodeName</code>. Also <code>comment</code> and
1870 * <code>returnType</code> information are added to the builder.
1872 * @param interfaceBuilder
1873 * generated type builder for which the getter method should be
1875 * @param schemaNodeName
1876 * string with schema node name. The name will be the part of the
1877 * getter method name.
1879 * string with comment for the getter method
1881 * type which represents the return type of the getter method
1883 * status from yang file, for deprecated annotation
1884 * @return method signature builder which represents the getter method of
1885 * <code>interfaceBuilder</code>
1887 private static MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
1888 final String schemaNodeName, final String comment, final Type returnType, final Status status) {
1889 final MethodSignatureBuilder getMethod = interfaceBuilder
1890 .addMethod(getterMethodName(schemaNodeName, returnType));
1891 if (status == Status.DEPRECATED) {
1892 getMethod.addAnnotation("", "Deprecated");
1894 getMethod.setComment(encodeAngleBrackets(comment));
1895 getMethod.setReturnType(returnType);
1900 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1901 * or to <code>genTOBuilder</code> as property.
1903 * @param basePackageName
1904 * string contains the module package name
1906 * data schema node which should be added as getter method to
1907 * <code>typeBuilder</code> or as a property to
1908 * <code>genTOBuilder</code> if is part of the list key
1909 * @param typeBuilder
1910 * generated type builder for the list schema node
1911 * @param genTOBuilder
1912 * generated TO builder for the list keys
1914 * list of string which contains names of the list keys
1917 * @throws IllegalArgumentException
1919 * <li>if <code>schemaNode</code> equals null</li>
1920 * <li>if <code>typeBuilder</code> equals null</li>
1923 private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,
1924 final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys,
1925 final Module module) {
1926 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1927 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1929 if (schemaNode instanceof LeafSchemaNode) {
1930 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1931 final String leafName = leaf.getQName().getLocalName();
1932 final Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf,module);
1933 if (listKeys.contains(leafName)) {
1935 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module);
1937 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1940 } else if (!schemaNode.isAddedByUses()) {
1941 if (schemaNode instanceof LeafListSchemaNode) {
1942 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode, module);
1943 } else if (schemaNode instanceof ContainerSchemaNode) {
1944 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode);
1945 } else if (schemaNode instanceof ChoiceSchemaNode) {
1946 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) schemaNode);
1947 } else if (schemaNode instanceof ListSchemaNode) {
1948 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode);
1953 private void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
1954 final GeneratedTOBuilder genTOBuilder) {
1955 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1957 if (genTOBuilder != null) {
1958 final GeneratedTransferObject genTO = genTOBuilder.toInstance();
1959 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT);
1960 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
1965 * Selects the names of the list keys from <code>list</code> and returns
1966 * them as the list of the strings
1969 * of string with names of the list keys
1970 * @return list of string which represents names of the list keys. If the
1971 * <code>list</code> contains no keys then the empty list is
1974 private static List<String> listKeys(final ListSchemaNode list) {
1975 final List<String> listKeys = new ArrayList<>();
1977 final List<QName> keyDefinition = list.getKeyDefinition();
1978 if (keyDefinition != null) {
1979 for (final QName keyDef : keyDefinition) {
1980 listKeys.add(keyDef.getLocalName());
1987 * Generates for the <code>list</code> which contains any list keys special
1988 * generated TO builder.
1990 * @param packageName
1991 * string with package name to which the list belongs
1993 * list schema node which is source of data about the list name
1994 * @return generated TO builder which represents the keys of the
1995 * <code>list</code> or null if <code>list</code> is null or list of
1996 * key definitions is null or empty.
1998 private static GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
1999 GeneratedTOBuilder genTOBuilder = null;
2000 if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
2001 final String listName = list.getQName().getLocalName() + "Key";
2002 final String genTOName = BindingMapping.getClassName(listName);
2003 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
2005 return genTOBuilder;
2009 * Builds generated TO builders for <code>typeDef</code> of type
2010 * {@link UnionTypeDefinition} or {@link BitsTypeDefinition} which are
2011 * also added to <code>typeBuilder</code> as enclosing transfer object.
2013 * If more then one generated TO builder is created for enclosing then all
2014 * of the generated TO builders are added to <code>typeBuilder</code> as
2015 * enclosing transfer objects.
2018 * type definition which can be of type <code>UnionType</code> or
2019 * <code>BitsTypeDefinition</code>
2020 * @param typeBuilder
2021 * generated type builder to which is added generated TO created
2022 * from <code>typeDef</code>
2024 * string with name for generated TO builder
2025 * @param parentModule
2027 * @return generated TO builder for <code>typeDef</code>
2029 private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef,
2030 final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) {
2031 final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName());
2032 final List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();
2033 final String packageName = typeBuilder.getFullyQualifiedName();
2034 if (typeDef instanceof UnionTypeDefinition) {
2035 final List<GeneratedTOBuilder> types = ((TypeProviderImpl) typeProvider)
2036 .provideGeneratedTOBuildersForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
2037 classNameFromLeaf, leaf);
2038 genTOBuilders.addAll(types);
2040 GeneratedTOBuilder resultTOBuilder;
2041 if (types.isEmpty()) {
2042 throw new IllegalStateException("No GeneratedTOBuilder objects generated from union " + typeDef);
2044 resultTOBuilder = types.remove(0);
2045 for (final GeneratedTOBuilder genTOBuilder : types) {
2046 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
2049 final GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
2050 genPropBuilder.setReturnType(Types.CHAR_ARRAY);
2051 resultTOBuilder.addEqualsIdentity(genPropBuilder);
2052 resultTOBuilder.addHashIdentity(genPropBuilder);
2053 resultTOBuilder.addToStringProperty(genPropBuilder);
2055 } else if (typeDef instanceof BitsTypeDefinition) {
2056 genTOBuilders.add((((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
2057 packageName, typeDef, classNameFromLeaf, parentModule.getName()));
2059 if (!genTOBuilders.isEmpty()) {
2060 for (final GeneratedTOBuilder genTOBuilder : genTOBuilders) {
2061 typeBuilder.addEnclosingTransferObject(genTOBuilder);
2063 return genTOBuilders.get(0);
2070 * Adds the implemented types to type builder.
2072 * The method passes through the list of <i>uses</i> in
2073 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
2074 * generated type from {@link ModuleContext#groupings
2075 * allGroupings} which is added as <i>implements type</i> to
2076 * <code>builder</code>
2078 * @param dataNodeContainer
2079 * element which contains the list of used YANG groupings
2081 * builder to which are added implemented types according to
2082 * <code>dataNodeContainer</code>
2083 * @return generated type builder with all implemented types
2085 private GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
2086 final GeneratedTypeBuilder builder) {
2087 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
2088 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath()).toInstance();
2089 if (genType == null) {
2090 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
2091 + builder.getName());
2094 builder.addImplementsType(genType);
2099 private static boolean isNullOrEmpty(final Collection<?> list) {
2100 return list == null || list.isEmpty();
2103 private String createDescription(final Set<? extends SchemaNode> schemaNodes, final String moduleName) {
2104 final StringBuilder sb = new StringBuilder();
2106 if (!isNullOrEmpty(schemaNodes)) {
2107 final SchemaNode node = schemaNodes.iterator().next();
2109 if (node instanceof RpcDefinition) {
2110 sb.append("Interface for implementing the following YANG RPCs defined in module <b>" + moduleName + "</b>");
2111 } else if (node instanceof NotificationDefinition) {
2112 sb.append("Interface for receiving the following YANG notifications defined in module <b>" + moduleName + "</b>");
2115 sb.append(NEW_LINE);
2117 if (verboseClassComments) {
2119 sb.append(NEW_LINE);
2120 sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNodes)));
2121 sb.append("</pre>");
2122 sb.append(NEW_LINE);
2125 return replaceAllIllegalChars(sb);
2128 private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) {
2129 final StringBuilder sb = new StringBuilder();
2130 final String nodeDescription = encodeAngleBrackets(schemaNode.getDescription());
2131 final String formattedDescription = YangTextTemplate.formatToParagraph(nodeDescription, 0);
2133 if (!Strings.isNullOrEmpty(formattedDescription)) {
2134 sb.append(formattedDescription);
2135 sb.append(NEW_LINE);
2138 if (verboseClassComments) {
2139 final Module module = findParentModule(schemaContext, schemaNode);
2140 final StringBuilder linkToBuilderClass = new StringBuilder();
2141 final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
2142 final String className = namespace[namespace.length - 1];
2144 if (hasBuilderClass(schemaNode)) {
2145 linkToBuilderClass.append(className);
2146 linkToBuilderClass.append("Builder");
2150 sb.append("This class represents the following YANG schema fragment defined in module <b>");
2151 sb.append(module.getName());
2153 sb.append(NEW_LINE);
2155 sb.append(NEW_LINE);
2156 sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNode)));
2157 sb.append("</pre>");
2158 sb.append(NEW_LINE);
2159 sb.append("The schema path to identify an instance is");
2160 sb.append(NEW_LINE);
2162 sb.append(YangTextTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
2164 sb.append(NEW_LINE);
2166 if (hasBuilderClass(schemaNode)) {
2167 sb.append(NEW_LINE);
2168 sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
2169 sb.append(NEW_LINE);
2171 sb.append(linkToBuilderClass);
2172 sb.append(NEW_LINE);
2173 if (schemaNode instanceof ListSchemaNode) {
2174 final List<QName> keyDef = ((ListSchemaNode)schemaNode).getKeyDefinition();
2175 if (keyDef != null && !keyDef.isEmpty()) {
2177 sb.append(className);
2180 sb.append(NEW_LINE);
2185 return replaceAllIllegalChars(sb);
2188 private static boolean hasBuilderClass(final SchemaNode schemaNode) {
2189 if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
2190 schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
2196 private String createDescription(final Module module) {
2197 final StringBuilder sb = new StringBuilder();
2198 final String moduleDescription = encodeAngleBrackets(module.getDescription());
2199 final String formattedDescription = YangTextTemplate.formatToParagraph(moduleDescription, 0);
2201 if (!Strings.isNullOrEmpty(formattedDescription)) {
2202 sb.append(formattedDescription);
2203 sb.append(NEW_LINE);
2206 if (verboseClassComments) {
2208 sb.append("This class represents the following YANG schema fragment defined in module <b>");
2209 sb.append(module.getName());
2211 sb.append(NEW_LINE);
2213 sb.append(NEW_LINE);
2214 sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(module)));
2215 sb.append("</pre>");
2218 return replaceAllIllegalChars(sb);
2221 private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) {
2222 for (final ModuleContext ctx : genCtx.values()) {
2223 final GeneratedTypeBuilder result = ctx.getChildNode(path);
2224 if (result != null) {
2231 private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) {
2232 for (final ModuleContext ctx : genCtx.values()) {
2233 final GeneratedTypeBuilder result = ctx.getGrouping(path);
2234 if (result != null) {
2241 private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) {
2242 for (final ModuleContext ctx : genCtx.values()) {
2243 final GeneratedTypeBuilder result = ctx.getCase(path);
2244 if (result != null) {
2251 public Map<Module, ModuleContext> getModuleContexts() {
2256 static String replaceAllIllegalChars(final StringBuilder stringBuilder){
2257 final String ret = UNICODE_CHAR_PATTERN.matcher(stringBuilder).replaceAll("\\\\\\\\u");
2258 return ret.isEmpty() ? "" : ret;
2261 private static void annotateDeprecatedIfNecessary(final Status status, final GeneratedTypeBuilder builder) {
2262 if (status == Status.DEPRECATED) {
2263 builder.addAnnotation("", "Deprecated");