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.encodeAngleBrackets;
15 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.packageNameForAugmentedGeneratedType;
16 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
17 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_OBJECT;
18 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_ROOT;
19 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIABLE;
20 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIER;
21 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.NOTIFICATION;
22 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.augmentable;
23 import static org.opendaylight.yangtools.binding.generator.util.Types.BOOLEAN;
24 import static org.opendaylight.yangtools.binding.generator.util.Types.FUTURE;
25 import static org.opendaylight.yangtools.binding.generator.util.Types.VOID;
26 import static org.opendaylight.yangtools.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;
30 import com.google.common.annotations.VisibleForTesting;
31 import com.google.common.base.Optional;
32 import com.google.common.base.Preconditions;
33 import com.google.common.base.Splitter;
34 import com.google.common.base.Strings;
35 import com.google.common.collect.Iterables;
36 import com.google.common.collect.Sets;
37 import java.util.ArrayList;
38 import java.util.Collection;
39 import java.util.Collections;
40 import java.util.HashMap;
41 import java.util.Iterator;
42 import java.util.List;
45 import java.util.regex.Pattern;
46 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
47 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
48 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
49 import org.opendaylight.yangtools.binding.generator.util.Types;
50 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl;
51 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
52 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
53 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
54 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
55 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
56 import org.opendaylight.yangtools.sal.binding.model.api.Constant;
57 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
58 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
59 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
60 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
61 import org.opendaylight.yangtools.sal.binding.model.api.Type;
62 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder;
63 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
64 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
65 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
66 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
67 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
68 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
69 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
70 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
71 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
72 import org.opendaylight.yangtools.yang.binding.BindingMapping;
73 import org.opendaylight.yangtools.yang.binding.DataContainer;
74 import org.opendaylight.yangtools.yang.binding.RpcService;
75 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
76 import org.opendaylight.yangtools.yang.common.QName;
77 import org.opendaylight.yangtools.yang.common.RpcResult;
78 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
79 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
80 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
81 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
82 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
83 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
86 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
90 import org.opendaylight.yangtools.yang.model.api.Module;
91 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
92 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
93 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
94 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
95 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
96 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
97 import org.opendaylight.yangtools.yang.model.api.Status;
98 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
99 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
100 import org.opendaylight.yangtools.yang.model.api.UsesNode;
101 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
102 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
103 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
104 import org.opendaylight.yangtools.yang.model.util.BaseTypes;
105 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
106 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
107 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
108 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
109 import org.opendaylight.yangtools.yang.model.util.UnionType;
110 import org.opendaylight.yangtools.yang.model.util.type.CompatUtils;
111 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
112 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
113 import org.slf4j.Logger;
114 import org.slf4j.LoggerFactory;
116 public class BindingGeneratorImpl implements BindingGenerator {
117 private static final Logger LOG = LoggerFactory.getLogger(BindingGeneratorImpl.class);
118 private static final Splitter COLON_SPLITTER = Splitter.on(':');
119 private static final Splitter BSDOT_SPLITTER = Splitter.on("\\.");
120 private static final char NEW_LINE = '\n';
123 * Constant with the concrete name of identifier.
125 private static final String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
128 * Constant with the concrete name of namespace.
130 private static final String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
132 private static final Pattern UNICODE_CHAR_PATTERN = Pattern.compile("\\\\+u");
134 private final Map<Module, ModuleContext> genCtx = new HashMap<>();
137 * When set to true, generated classes will include javadoc comments which
138 * are useful for users.
140 private final boolean verboseClassComments;
143 * Outer key represents the package name. Outer value represents map of all
144 * builders in the same package. Inner key represents the schema node name
145 * (in JAVA class/interface name format). Inner value represents instance of
146 * builder for schema node specified in key part.
148 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
151 * Provide methods for converting YANG types to JAVA types.
153 private TypeProvider typeProvider;
156 * Holds reference to schema context to resolve data of augmented element
157 * when creating augmentation builder
159 private SchemaContext schemaContext;
162 * Create a new binding generator.
164 * @param verboseClassComments generate verbose comments
166 public BindingGeneratorImpl(final boolean verboseClassComments) {
167 this.verboseClassComments = verboseClassComments;
171 * Resolves generated types from <code>context</code> schema nodes of all
174 * Generated types are created for modules, groupings, types, containers,
175 * lists, choices, augments, rpcs, notification, identities.
178 * schema context which contains data about all schema nodes
180 * @return list of types (usually <code>GeneratedType</code>
181 * <code>GeneratedTransferObject</code>which are generated from
182 * <code>context</code> data.
183 * @throws IllegalArgumentException
184 * if arg <code>context</code> is null
185 * @throws IllegalStateException
186 * if <code>context</code> contain no modules
189 public List<Type> generateTypes(final SchemaContext context) {
190 checkArgument(context != null, "Schema Context reference cannot be NULL.");
191 checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
192 schemaContext = context;
193 typeProvider = new TypeProviderImpl(context);
194 final Set<Module> modules = context.getModules();
195 return generateTypes(context, modules);
199 * Resolves generated types from <code>context</code> schema nodes only for
200 * modules specified in <code>modules</code>
202 * Generated types are created for modules, groupings, types, containers,
203 * lists, choices, augments, rpcs, notification, identities.
206 * schema context which contains data about all schema nodes
209 * set of modules for which schema nodes should be generated
211 * @return list of types (usually <code>GeneratedType</code> or
212 * <code>GeneratedTransferObject</code>) which:
214 * <li>are generated from <code>context</code> schema nodes and</li>
215 * <li>are also part of some of the module in <code>modules</code>
218 * @throws IllegalArgumentException
220 * <li>if arg <code>context</code> is null or</li>
221 * <li>if arg <code>modules</code> is null</li>
223 * @throws IllegalStateException
224 * if <code>context</code> contain no modules
227 public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {
228 checkArgument(context != null, "Schema Context reference cannot be NULL.");
229 checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
230 checkArgument(modules != null, "Set of Modules cannot be NULL.");
232 schemaContext = context;
233 typeProvider = new TypeProviderImpl(context);
234 final Module[] modulesArray = new Module[context.getModules().size()];
235 context.getModules().toArray(modulesArray);
236 final List<Module> contextModules = ModuleDependencySort.sort(modulesArray);
237 genTypeBuilders = new HashMap<>();
239 for (final Module contextModule : contextModules) {
240 moduleToGenTypes(contextModule, context);
242 for (final Module contextModule : contextModules) {
243 allAugmentsToGenTypes(contextModule);
246 final List<Type> filteredGenTypes = new ArrayList<>();
247 for (final Module m : modules) {
248 final ModuleContext ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m);
249 filteredGenTypes.addAll(ctx.getGeneratedTypes());
250 final Set<Type> additionalTypes = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(m);
251 if (additionalTypes != null) {
252 filteredGenTypes.addAll(additionalTypes);
256 return filteredGenTypes;
259 private void moduleToGenTypes(final Module m, final SchemaContext context) {
260 genCtx.put(m, new ModuleContext());
261 allTypeDefinitionsToGenTypes(m);
262 groupingsToGenTypes(m, m.getGroupings());
263 rpcMethodsToGenType(m);
264 allIdentitiesToGenTypes(m, context);
265 notificationsToGenType(m);
267 if (!m.getChildNodes().isEmpty()) {
268 final GeneratedTypeBuilder moduleType = moduleToDataType(m);
269 genCtx.get(m).addModuleNode(moduleType);
270 final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
271 resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.getChildNodes());
276 * Converts all extended type definitions of module to the list of
277 * <code>Type</code> objects.
280 * module from which is obtained set of type definitions
281 * @throws IllegalArgumentException
283 * <li>if module is null</li>
284 * <li>if name of module is null</li>
286 * @throws IllegalStateException
287 * if set of type definitions from module is null
289 private void allTypeDefinitionsToGenTypes(final Module module) {
290 checkArgument(module != null, "Module reference cannot be NULL.");
291 checkArgument(module.getName() != null, "Module name cannot be NULL.");
292 final DataNodeIterator it = new DataNodeIterator(module);
293 final List<TypeDefinition<?>> typeDefinitions = it.allTypedefs();
294 checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL.");
296 for (final TypeDefinition<?> typedef : typeDefinitions) {
297 if (typedef != null) {
298 final Type type = ((TypeProviderImpl) typeProvider).generatedTypeForExtendedDefinitionType(typedef,
301 final ModuleContext ctx = genCtx.get(module);
302 ctx.addTypedefType(typedef.getPath(), type);
303 ctx.addTypeToSchema(type,typedef);
309 private GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
310 final GeneratedTypeBuilder childOf, final DataSchemaNode node) {
311 if (node.isAugmenting() || node.isAddedByUses()) {
314 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
315 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module);
316 genType.addComment(node.getDescription());
317 annotateDeprecatedIfNecessary(node.getStatus(), genType);
318 genType.setDescription(createDescription(node, genType.getFullyQualifiedName()));
319 genType.setModuleName(module.getName());
320 genType.setReference(node.getReference());
321 genType.setSchemaPath(node.getPath().getPathFromRoot());
322 if (node instanceof DataNodeContainer) {
323 genCtx.get(module).addChildNodeType(node, genType);
324 groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings());
325 processUsesAugments((DataNodeContainer) node, module);
330 private void containerToGenType(final Module module, final String basePackageName,
331 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node) {
332 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
333 if (genType != null) {
334 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType);
335 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes());
339 private void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder parent,
340 final GeneratedTypeBuilder childOf, final ListSchemaNode node) {
341 final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
342 if (genType != null) {
343 constructGetter(parent, node.getQName().getLocalName(), node.getDescription(),
344 Types.listTypeFor(genType));
346 final List<String> listKeys = listKeys(node);
347 final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
348 final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
349 if (genTOBuilder != null) {
350 final Type identifierMarker = Types.parameterizedTypeFor(IDENTIFIER, genType);
351 final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
352 genTOBuilder.addImplementsType(identifierMarker);
353 genType.addImplementsType(identifiableMarker);
356 for (final DataSchemaNode schemaNode : node.getChildNodes()) {
357 if (!schemaNode.isAugmenting()) {
358 addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
363 if (genTOBuilder != null) {
364 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
365 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
366 genTOBuilder.setSUID(prop);
369 typeBuildersToGenTypes(module, genType, genTOBuilder);
373 private void processUsesAugments(final DataNodeContainer node, final Module module) {
374 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
375 for (final UsesNode usesNode : node.getUses()) {
376 for (final AugmentationSchema augment : usesNode.getAugmentations()) {
377 usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
378 processUsesAugments(augment, module);
384 * Converts all <b>augmentation</b> of the module to the list
385 * <code>Type</code> objects.
388 * module from which is obtained list of all augmentation objects
389 * to iterate over them
390 * @throws IllegalArgumentException
392 * <li>if the module is null</li>
393 * <li>if the name of module is null</li>
395 * @throws IllegalStateException
396 * if set of augmentations from module is null
398 private void allAugmentsToGenTypes(final Module module) {
399 checkArgument(module != null, "Module reference cannot be NULL.");
400 checkArgument(module.getName() != null, "Module name cannot be NULL.");
401 checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
403 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
404 final List<AugmentationSchema> augmentations = resolveAugmentations(module);
405 for (final AugmentationSchema augment : augmentations) {
406 augmentationToGenTypes(basePackageName, augment, module);
411 * Returns list of <code>AugmentationSchema</code> objects. The objects are
412 * sorted according to the length of their target path from the shortest to
416 * module from which is obtained list of all augmentation objects
417 * @return list of sorted <code>AugmentationSchema</code> objects obtained
418 * from <code>module</code>
419 * @throws IllegalArgumentException
421 * @throws IllegalStateException
422 * if set of module augmentations is null
424 private static List<AugmentationSchema> resolveAugmentations(final Module module) {
425 checkArgument(module != null, "Module reference cannot be NULL.");
426 checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
428 final Set<AugmentationSchema> augmentations = module.getAugmentations();
429 final List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);
430 Collections.sort(sortedAugmentations, Comparators.AUGMENT_COMP);
432 return sortedAugmentations;
436 * Create GeneratedTypeBuilder object from module argument.
439 * Module object from which builder will be created
440 * @return <code>GeneratedTypeBuilder</code> which is internal
441 * representation of the module
442 * @throws IllegalArgumentException
445 private GeneratedTypeBuilder moduleToDataType(final Module module) {
446 checkArgument(module != null, "Module reference cannot be NULL.");
448 final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
449 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
450 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
451 moduleDataTypeBuilder.addComment(module.getDescription());
452 moduleDataTypeBuilder.setDescription(createDescription(module));
453 moduleDataTypeBuilder.setReference(module.getReference());
454 return moduleDataTypeBuilder;
458 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
459 * to the list of <code>Type</code> objects. In addition are to containers
460 * and lists which belong to input or output also part of returning list.
463 * module from which is obtained set of all rpc objects to
465 * @throws IllegalArgumentException
467 * <li>if the module is null</li>
468 * <li>if the name of module is null</li>
470 * @throws IllegalStateException
471 * if set of rpcs from module is null
473 private void rpcMethodsToGenType(final Module module) {
474 checkArgument(module != null, "Module reference cannot be NULL.");
475 checkArgument(module.getName() != null, "Module name cannot be NULL.");
476 final Set<RpcDefinition> rpcDefinitions = module.getRpcs();
477 checkState(rpcDefinitions != null, "Set of rpcs from module " + module.getName() + " cannot be NULL.");
478 if (rpcDefinitions.isEmpty()) {
482 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
483 final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, "Service");
484 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService.class));
485 interfaceBuilder.setDescription(createDescription(rpcDefinitions, module.getName()));
487 for (final RpcDefinition rpc : rpcDefinitions) {
489 final String rpcName = BindingMapping.getClassName(rpc.getQName());
490 final String rpcMethodName = BindingMapping.getPropertyName(rpcName);
491 final String rpcComment = encodeAngleBrackets(rpc.getDescription());
492 final MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName);
493 final ContainerSchemaNode input = rpc.getInput();
494 final ContainerSchemaNode output = rpc.getOutput();
497 final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
498 addImplementedInterfaceFromUses(input, inType);
499 inType.addImplementsType(DATA_OBJECT);
500 inType.addImplementsType(augmentable(inType));
501 annotateDeprecatedIfNecessary(rpc.getStatus(), inType);
502 resolveDataSchemaNodes(module, basePackageName, inType, inType, input.getChildNodes());
503 genCtx.get(module).addChildNodeType(input, inType);
504 final GeneratedType inTypeInstance = inType.toInstance();
505 method.addParameter(inTypeInstance, "input");
508 Type outTypeInstance = VOID;
509 if (output != null) {
510 final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
511 addImplementedInterfaceFromUses(output, outType);
512 outType.addImplementsType(DATA_OBJECT);
513 outType.addImplementsType(augmentable(outType));
514 annotateDeprecatedIfNecessary(rpc.getStatus(), outType);
515 resolveDataSchemaNodes(module, basePackageName, outType, outType, output.getChildNodes());
516 genCtx.get(module).addChildNodeType(output, outType);
517 outTypeInstance = outType.toInstance();
520 final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);
521 method.setComment(rpcComment);
522 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
526 genCtx.get(module).addTopLevelNodeType(interfaceBuilder);
530 * Converts all <b>notifications</b> of the module to the list of
531 * <code>Type</code> objects. In addition are to this list added containers
532 * and lists which are part of this notification.
535 * module from which is obtained set of all notification objects
536 * to iterate over them
537 * @throws IllegalArgumentException
539 * <li>if the module equals null</li>
540 * <li>if the name of module equals null</li>
542 * @throws IllegalStateException
543 * if set of notifications from module is null
545 private void notificationsToGenType(final Module module) {
546 checkArgument(module != null, "Module reference cannot be NULL.");
547 checkArgument(module.getName() != null, "Module name cannot be NULL.");
548 final Set<NotificationDefinition> notifications = module.getNotifications();
549 checkState(notifications != null, "Set of notification from module " + module.getName() + " cannot be NULL.");
550 if (notifications.isEmpty()) {
554 final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");
555 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
556 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
560 for (final NotificationDefinition notification : notifications) {
561 if (notification != null) {
562 processUsesAugments(notification, module);
564 final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,
565 notification, null, module);
566 annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface);
567 notificationInterface.addImplementsType(NOTIFICATION);
568 genCtx.get(module).addChildNodeType(notification, notificationInterface);
570 // Notification object
571 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
572 notification.getChildNodes());
574 listenerInterface.addMethod("on" + notificationInterface.getName())
575 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
576 .setComment(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID);
579 listenerInterface.setDescription(createDescription(notifications, module.getName()));
581 genCtx.get(module).addTopLevelNodeType(listenerInterface);
585 * Converts all <b>identities</b> of the module to the list of
586 * <code>Type</code> objects.
589 * module from which is obtained set of all identity objects to
592 * schema context only used as input parameter for method
593 * {@link identityToGenType}
596 private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) {
597 final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
598 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
600 if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
601 for (final IdentitySchemaNode identity : schemaIdentities) {
602 identityToGenType(module, basePackageName, identity, context);
608 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
609 * created transport object builder. If identity contains base identity then
610 * reference to base identity is added to superior identity as its extend.
611 * If identity doesn't contain base identity then only reference to abstract
612 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
613 * BaseIdentity} is added
617 * @param basePackageName
618 * string contains the module package name
620 * IdentitySchemaNode which contains data about identity
622 * SchemaContext which is used to get package and name
623 * information about base of identity
626 private void identityToGenType(final Module module, final String basePackageName,
627 final IdentitySchemaNode identity, final SchemaContext context) {
628 if (identity == null) {
631 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
632 final String genTypeName = BindingMapping.getClassName(identity.getQName());
633 final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
634 final IdentitySchemaNode baseIdentity = identity.getBaseIdentity();
635 if (baseIdentity == null) {
636 final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
637 BaseIdentity.class.getSimpleName());
638 newType.setExtendsType(gto.toInstance());
640 final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
641 final String returnTypePkgName = BindingMapping.getRootPackageName(baseIdentityParentModule
643 final String returnTypeName = BindingMapping.getClassName(baseIdentity.getQName());
644 final GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName)
646 newType.setExtendsType(gto);
648 newType.setAbstract(true);
649 newType.addComment(identity.getDescription());
650 newType.setDescription(createDescription(identity, newType.getFullyQualifiedName()));
651 newType.setReference(identity.getReference());
652 newType.setModuleName(module.getName());
653 newType.setSchemaPath(identity.getPath().getPathFromRoot());
655 final QName qname = identity.getQName();
656 qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, qname);
658 genCtx.get(module).addIdentityType(identity.getQName(), newType);
661 private static Constant qnameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
663 return toBuilder.addConstant(typeForClass(QName.class), constantName, name);
667 * Converts all <b>groupings</b> of the module to the list of
668 * <code>Type</code> objects. Firstly are groupings sorted according mutual
669 * dependencies. At least dependent (independent) groupings are in the list
670 * saved at first positions. For every grouping the record is added to map
671 * {@link BindingGeneratorImpl#allGroupings allGroupings}
676 * of groupings from which types will be generated
679 private void groupingsToGenTypes(final Module module, final Collection<GroupingDefinition> groupings) {
680 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
681 final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
683 for (final GroupingDefinition grouping : groupingsSortedByDependencies) {
684 groupingToGenType(basePackageName, grouping, module);
689 * Converts individual grouping to GeneratedType. Firstly generated type
690 * builder is created and every child node of grouping is resolved to the
693 * @param basePackageName
694 * string contains the module package name
696 * GroupingDefinition which contains data about grouping
699 * @return GeneratedType which is generated from grouping (object of type
700 * <code>GroupingDefinition</code>)
702 private void groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module module) {
703 final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());
704 final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module);
705 annotateDeprecatedIfNecessary(grouping.getStatus(), genType);
706 genCtx.get(module).addGroupingType(grouping.getPath(), genType);
707 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes());
708 groupingsToGenTypes(module, grouping.getGroupings());
709 processUsesAugments(grouping, module);
713 * Adds enumeration builder created from <code>enumTypeDef</code> to
714 * <code>typeBuilder</code>.
716 * Each <code>enumTypeDef</code> item is added to builder with its name and
720 * EnumTypeDefinition contains enum data
722 * string contains name which will be assigned to enumeration
725 * GeneratedTypeBuilder to which will be enum builder assigned
727 * Module in which type should be generated
728 * @return enumeration builder which contains data from
729 * <code>enumTypeDef</code>
731 private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
732 final GeneratedTypeBuilder typeBuilder, final Module module) {
733 if ((enumTypeDef != null) && (typeBuilder != null) && (enumTypeDef.getQName() != null)
734 && (enumTypeDef.getQName().getLocalName() != null)) {
735 final String enumerationName = BindingMapping.getClassName(enumName);
736 final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
737 final String enumTypedefDescription = encodeAngleBrackets(enumTypeDef.getDescription());
738 enumBuilder.setDescription(enumTypedefDescription);
739 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
740 ModuleContext ctx = genCtx.get(module);
741 ctx.addInnerTypedefType(enumTypeDef.getPath(), enumBuilder);
748 * Generates type builder for <code>module</code>.
751 * Module which is source of package name for generated type
754 * string which is added to the module class name representation
756 * @return instance of GeneratedTypeBuilder which represents
757 * <code>module</code>.
758 * @throws IllegalArgumentException
759 * if <code>module</code> is null
761 private GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {
762 checkArgument(module != null, "Module reference cannot be NULL.");
763 final String packageName = BindingMapping.getRootPackageName(module.getQNameModule());
764 final String moduleName = BindingMapping.getClassName(module.getName()) + postfix;
766 final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
767 moduleBuilder.setDescription(createDescription(module));
768 moduleBuilder.setReference(module.getReference());
769 moduleBuilder.setModuleName(moduleName);
771 return moduleBuilder;
775 * Converts <code>augSchema</code> to list of <code>Type</code> which
776 * contains generated type for augmentation. In addition there are also
777 * generated types for all containers, list and choices which are child of
778 * <code>augSchema</code> node or a generated types for cases are added if
779 * augmented node is choice.
781 * @param augmentPackageName
782 * string with the name of the package to which the augmentation
785 * AugmentationSchema which is contains data about augmentation
786 * (target path, childs...)
789 * @param parentUsesNode
790 * @throws IllegalArgumentException
792 * <li>if <code>augmentPackageName</code> equals null</li>
793 * <li>if <code>augSchema</code> equals null</li>
795 * @throws IllegalStateException
796 * if augment target path is null
798 private void augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
799 final Module module) {
800 checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
801 checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
802 checkState(augSchema.getTargetPath() != null,
803 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
805 processUsesAugments(augSchema, module);
806 final SchemaPath targetPath = augSchema.getTargetPath();
807 SchemaNode targetSchemaNode = null;
809 targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
810 if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
811 if (targetSchemaNode instanceof DerivableSchemaNode) {
812 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
814 if (targetSchemaNode == null) {
815 throw new IllegalStateException("Failed to find target node from grouping in augmentation " + augSchema
816 + " in module " + module.getName());
819 if (targetSchemaNode == null) {
820 throw new IllegalArgumentException("augment target not found: " + targetPath);
823 GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
824 if (targetTypeBuilder == null) {
825 targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
827 if (targetTypeBuilder == null) {
828 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
831 if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
832 final String packageName = augmentPackageName;
833 final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(),
834 targetTypeBuilder.getName());
835 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetType, augSchema);
838 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
839 (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes());
843 private void usesAugmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
844 final Module module, final UsesNode usesNode, final DataNodeContainer usesNodeParent) {
845 checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
846 checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
847 checkState(augSchema.getTargetPath() != null,
848 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
850 processUsesAugments(augSchema, module);
851 final SchemaPath targetPath = augSchema.getTargetPath();
852 final SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
853 if (targetSchemaNode == null) {
854 throw new IllegalArgumentException("augment target not found: " + targetPath);
857 GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
858 if (targetTypeBuilder == null) {
859 targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
861 if (targetTypeBuilder == null) {
862 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
865 if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
866 String packageName = augmentPackageName;
867 if (usesNodeParent instanceof SchemaNode) {
868 packageName = packageNameForAugmentedGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath());
870 addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(),
873 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
874 (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes());
879 * Convenient method to find node added by uses statement.
883 * @param parentUsesNode
884 * parent of uses node
885 * @return node from its original location in grouping
887 private DataSchemaNode findOriginalTargetFromGrouping(final SchemaPath targetPath, final UsesNode parentUsesNode) {
888 final SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath()
890 if (!(targetGrouping instanceof GroupingDefinition)) {
891 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
894 final GroupingDefinition grouping = (GroupingDefinition) targetGrouping;
895 SchemaNode result = grouping;
896 for (final QName node : targetPath.getPathFromRoot()) {
897 // finding by local name is valid, grouping cannot contain nodes
898 // with same name and different namespace
899 if (result instanceof DataNodeContainer) {
900 result = ((DataNodeContainer) result).getDataChildByName(node.getLocalName());
901 } else if (result instanceof ChoiceSchemaNode) {
902 result = ((ChoiceSchemaNode) result).getCaseNodeByName(node.getLocalName());
905 if (result == null) {
909 if (result instanceof DerivableSchemaNode) {
910 DerivableSchemaNode castedResult = (DerivableSchemaNode) result;
911 Optional<? extends SchemaNode> originalNode = castedResult
913 if (castedResult.isAddedByUses() && originalNode.isPresent()) {
914 result = originalNode.get();
918 if (result instanceof DataSchemaNode) {
919 DataSchemaNode resultDataSchemaNode = (DataSchemaNode) result;
920 if (resultDataSchemaNode.isAddedByUses()) {
921 // The original node is required, but we have only the copy of
922 // the original node.
923 // Maybe this indicates a bug in Yang parser.
924 throw new IllegalStateException(
925 "Failed to generate code for augment in "
928 return resultDataSchemaNode;
931 throw new IllegalStateException(
932 "Target node of uses-augment statement must be DataSchemaNode. Failed to generate code for augment in "
938 * Returns a generated type builder for an augmentation.
940 * The name of the type builder is equal to the name of augmented node with
941 * serial number as suffix.
945 * @param augmentPackageName
946 * string with contains the package name to which the augment
948 * @param basePackageName
949 * string with the package name to which the augmented node
951 * @param targetTypeRef
954 * augmentation schema which contains data about the child nodes
955 * and uses of augment
956 * @return generated type builder for augment
958 private GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
959 final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema) {
960 Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
961 if (augmentBuilders == null) {
962 augmentBuilders = new HashMap<>();
963 genTypeBuilders.put(augmentPackageName, augmentBuilders);
965 final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
968 if (augIdentifier != null) {
969 augTypeName = BindingMapping.getClassName(augIdentifier);
971 augTypeName = augGenTypeName(augmentBuilders, targetTypeRef.getName());
974 final GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
976 augTypeBuilder.addImplementsType(DATA_OBJECT);
977 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
978 annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder);
979 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
981 augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes());
982 augmentBuilders.put(augTypeName, augTypeBuilder);
984 if(!augSchema.getChildNodes().isEmpty()) {
985 genCtx.get(module).addTargetToAugmentation(targetTypeRef, augTypeBuilder);
986 genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
989 genCtx.get(module).addAugmentType(augTypeBuilder);
990 return augTypeBuilder;
995 * @param unknownSchemaNodes
996 * @return nodeParameter of UnknownSchemaNode
998 private static String getAugmentIdentifier(final List<UnknownSchemaNode> unknownSchemaNodes) {
999 for (final UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
1000 final QName nodeType = unknownSchemaNode.getNodeType();
1001 if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())
1002 && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {
1003 return unknownSchemaNode.getNodeParameter();
1010 * Returns first unique name for the augment generated type builder. The
1011 * generated type builder name for augment consists from name of augmented
1012 * node and serial number of its augmentation.
1015 * map of builders which were created in the package to which the
1016 * augmentation belongs
1017 * @param genTypeName
1018 * string with name of augmented node
1019 * @return string with unique name for augmentation builder
1021 private static String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {
1023 if (builders != null) {
1024 while (builders.containsKey(genTypeName + index)) {
1028 return genTypeName + index;
1032 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
1033 * node for which <code>typeBuilder</code> was created.
1035 * The subnodes aren't mapped to the methods if they are part of grouping or
1036 * augment (in this case are already part of them).
1040 * @param basePackageName
1041 * string contains the module package name
1043 * generated type builder which represents any node. The subnodes
1044 * of this node are added to the <code>typeBuilder</code> as
1045 * methods. The subnode can be of type leaf, leaf-list, list,
1046 * container, choice.
1049 * @param schemaNodes
1050 * set of data schema nodes which are the children of the node
1051 * for which <code>typeBuilder</code> was created
1052 * @return generated type builder which is the same builder as input
1053 * parameter. The getter methods (representing child nodes) could be
1056 private GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
1057 final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes) {
1058 if (schemaNodes != null && parent != null) {
1059 for (final DataSchemaNode schemaNode : schemaNodes) {
1060 if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
1061 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1069 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
1070 * node for which <code>typeBuilder</code> was created.
1074 * @param basePackageName
1075 * string contains the module package name
1076 * @param typeBuilder
1077 * generated type builder which represents any node. The subnodes
1078 * of this node are added to the <code>typeBuilder</code> as
1079 * methods. The subnode can be of type leaf, leaf-list, list,
1080 * container, choice.
1083 * @param schemaNodes
1084 * set of data schema nodes which are the children of the node
1085 * for which <code>typeBuilder</code> was created
1086 * @return generated type builder which is the same object as the input
1087 * parameter <code>typeBuilder</code>. The getter method could be
1090 private GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
1091 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf,
1092 final Iterable<DataSchemaNode> schemaNodes) {
1093 if ((schemaNodes != null) && (typeBuilder != null)) {
1094 for (final DataSchemaNode schemaNode : schemaNodes) {
1095 if (!schemaNode.isAugmenting()) {
1096 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1104 * Adds to <code>typeBuilder</code> a method which is derived from
1105 * <code>schemaNode</code>.
1107 * @param basePackageName
1108 * string with the module package name
1110 * data schema node which is added to <code>typeBuilder</code> as
1112 * @param typeBuilder
1113 * generated type builder to which is <code>schemaNode</code>
1114 * added as a method.
1120 private void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
1121 final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module) {
1122 if (node != null && typeBuilder != null) {
1123 if (node instanceof LeafSchemaNode) {
1124 resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) node, module);
1125 } else if (node instanceof LeafListSchemaNode) {
1126 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node,module);
1127 } else if (node instanceof ContainerSchemaNode) {
1128 containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node);
1129 } else if (node instanceof ListSchemaNode) {
1130 listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node);
1131 } else if (node instanceof ChoiceSchemaNode) {
1132 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) node);
1134 // TODO: anyxml not yet supported
1135 LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
1136 typeBuilder.getFullyQualifiedName());
1142 * Converts <code>choiceNode</code> to the list of generated types for
1143 * choice and its cases.
1145 * The package names for choice and for its cases are created as
1146 * concatenation of the module package (<code>basePackageName</code>) and
1147 * names of all parents node.
1151 * @param basePackageName
1152 * string with the module package name
1156 * choice node which is mapped to generated type. Also child
1157 * nodes - cases are mapped to generated types.
1158 * @throws IllegalArgumentException
1160 * <li>if <code>basePackageName</code> is null</li>
1161 * <li>if <code>choiceNode</code> is null</li>
1164 private void choiceToGeneratedType(final Module module, final String basePackageName,
1165 final GeneratedTypeBuilder parent, final ChoiceSchemaNode choiceNode) {
1166 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1167 checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
1169 if (!choiceNode.isAddedByUses()) {
1170 final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());
1171 final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1172 constructGetter(parent, choiceNode.getQName().getLocalName(),
1173 choiceNode.getDescription(), choiceTypeBuilder);
1174 choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class));
1175 annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder);
1176 genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
1177 generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode);
1182 * Converts <code>caseNodes</code> set to list of corresponding generated
1185 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
1186 * created generated type builder. The package names for the builder is
1187 * created as concatenation of the module package (
1188 * <code>basePackageName</code>) and names of all parents nodes of the
1189 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
1190 * between every case builder and <i>choice</i> type
1194 * @param basePackageName
1195 * string with the module package name
1196 * @param refChoiceType
1197 * type which represents superior <i>case</i>
1199 * choice case node which is mapped to generated type
1200 * @return list of generated types for <code>caseNodes</code>.
1201 * @throws IllegalArgumentException
1203 * <li>if <code>basePackageName</code> equals null</li>
1204 * <li>if <code>refChoiceType</code> equals null</li>
1205 * <li>if <code>caseNodes</code> equals null</li>
1208 private void generateTypesFromChoiceCases(final Module module, final String basePackageName,
1209 final Type refChoiceType, final ChoiceSchemaNode choiceNode) {
1210 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1211 checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
1212 checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
1214 final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
1215 if (caseNodes == null) {
1219 for (final ChoiceCaseNode caseNode : caseNodes) {
1220 if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1221 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1222 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1223 caseTypeBuilder.addImplementsType(refChoiceType);
1224 annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder);
1225 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1226 genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
1227 final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
1228 if (caseChildNodes != null) {
1229 final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent();
1231 if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) {
1232 SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath);
1234 if (parent instanceof AugmentationSchema) {
1235 final AugmentationSchema augSchema = (AugmentationSchema) parent;
1236 final SchemaPath targetPath = augSchema.getTargetPath();
1237 SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
1238 if (targetSchemaNode instanceof DataSchemaNode
1239 && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
1240 if (targetSchemaNode instanceof DerivableSchemaNode) {
1241 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
1243 if (targetSchemaNode == null) {
1244 throw new IllegalStateException(
1245 "Failed to find target node from grouping for augmentation " + augSchema
1246 + " in module " + module.getName());
1249 parent = targetSchemaNode;
1252 Preconditions.checkState(parent != null, "Could not find Choice node parent %s",
1253 choiceNodeParentPath);
1254 GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath());
1255 if (childOfType == null) {
1256 childOfType = findGroupingByPath(parent.getPath());
1258 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes);
1260 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module),
1265 processUsesAugments(caseNode, module);
1270 * Generates list of generated types for all the cases of a choice which are
1271 * added to the choice through the augment.
1275 * @param basePackageName
1276 * string contains name of package to which augment belongs. If
1277 * an augmented choice is from an other package (pcg1) than an
1278 * augmenting choice (pcg2) then case's of the augmenting choice
1279 * will belong to pcg2.
1281 * Type which represents target choice
1283 * node which represents target choice
1284 * @param augmentedNodes
1285 * set of choice case nodes for which is checked if are/aren't
1286 * added to choice through augmentation
1287 * @return list of generated types which represents augmented cases of
1288 * choice <code>refChoiceType</code>
1289 * @throws IllegalArgumentException
1291 * <li>if <code>basePackageName</code> is null</li>
1292 * <li>if <code>targetType</code> is null</li>
1293 * <li>if <code>augmentedNodes</code> is null</li>
1296 private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName,
1297 final Type targetType, final ChoiceSchemaNode targetNode, final Iterable<DataSchemaNode> augmentedNodes) {
1298 checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
1299 checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
1300 checkArgument(augmentedNodes != null, "Set of Choice Case Nodes cannot be NULL.");
1302 for (final DataSchemaNode caseNode : augmentedNodes) {
1303 if (caseNode != null) {
1304 final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
1305 final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
1306 caseTypeBuilder.addImplementsType(targetType);
1308 SchemaNode parent = null;
1309 final SchemaPath nodeSp = targetNode.getPath();
1310 parent = findDataSchemaNode(schemaContext, nodeSp.getParent());
1312 GeneratedTypeBuilder childOfType = null;
1313 if (parent instanceof Module) {
1314 childOfType = genCtx.get(parent).getModuleNode();
1315 } else if (parent instanceof ChoiceCaseNode) {
1316 childOfType = findCaseByPath(parent.getPath());
1317 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1318 childOfType = findChildNodeByPath(parent.getPath());
1319 } else if (parent instanceof GroupingDefinition) {
1320 childOfType = findGroupingByPath(parent.getPath());
1323 if (childOfType == null) {
1324 throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1327 ChoiceCaseNode node = null;
1328 if (caseNode instanceof ChoiceCaseNode) {
1329 node = (ChoiceCaseNode) caseNode;
1331 node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1333 final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
1334 if (childNodes != null) {
1335 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1337 genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
1338 genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
1343 private static boolean isInnerType(final LeafSchemaNode leaf, final TypeDefinition<?> type) {
1344 // Deal with old parser, clearing out references to typedefs
1345 if (type instanceof ExtendedType) {
1349 // New parser with encapsulated type
1350 if (leaf.getPath().equals(type.getPath())) {
1354 // Embedded type definition with new parser. Also takes care of the old parser with bits
1355 if (leaf.getPath().equals(type.getPath().getParent())) {
1359 // Old parser uses broken Union type, which does not change its schema path
1360 if (type instanceof UnionType) {
1368 * Converts <code>leaf</code> to the getter method which is added to
1369 * <code>typeBuilder</code>.
1371 * @param typeBuilder
1372 * generated type builder to which is added getter method as
1373 * <code>leaf</code> mapping
1375 * leaf schema node which is mapped as getter method which is
1376 * added to <code>typeBuilder</code>
1378 * Module in which type was defined
1379 * @return boolean value
1381 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
1383 * <li>true - in other cases</li>
1386 private Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf, final Module module) {
1387 if (leaf == null || typeBuilder == null || leaf.isAddedByUses()) {
1391 final String leafName = leaf.getQName().getLocalName();
1392 if (leafName == null) {
1396 final Module parentModule = findParentModule(schemaContext, leaf);
1397 Type returnType = null;
1399 final TypeDefinition<?> typeDef = CompatUtils.compatLeafType(leaf);
1400 if (isInnerType(leaf, typeDef)) {
1401 if (typeDef instanceof EnumTypeDefinition) {
1402 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1403 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1404 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
1405 typeBuilder, module);
1407 if (enumBuilder != null) {
1408 returnType = enumBuilder.toInstance(typeBuilder);
1410 ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
1411 } else if (typeDef instanceof UnionTypeDefinition) {
1412 GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1413 if (genTOBuilder != null) {
1414 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1416 } else if (typeDef instanceof BitsTypeDefinition) {
1417 GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1418 if (genTOBuilder != null) {
1419 returnType = genTOBuilder.toInstance();
1422 // It is constrained version of already declared type (inner declared type exists,
1423 // onlyfor special cases (Enum, Union, Bits), which were already checked.
1424 // In order to get proper class we need to look up closest derived type
1425 // and apply restrictions from leaf type
1426 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1427 returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf,
1431 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1432 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1435 if (returnType == null) {
1439 String leafDesc = leaf.getDescription();
1440 if (leafDesc == null) {
1444 final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1445 processContextRefExtension(leaf, getter, parentModule);
1449 private static TypeDefinition<?> getBaseOrDeclaredType(final TypeDefinition<?> typeDef) {
1450 if (typeDef instanceof ExtendedType) {
1451 // Legacy behaviour returning ExtendedType is enough
1454 // Returns DerivedType in case of new parser.
1455 final TypeDefinition<?> baseType = typeDef.getBaseType();
1456 return (baseType != null && baseType.getBaseType() != null) ? baseType : typeDef;
1459 private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter,
1460 final Module module) {
1461 for (final UnknownSchemaNode node : leaf.getUnknownSchemaNodes()) {
1462 final QName nodeType = node.getNodeType();
1463 if ("context-reference".equals(nodeType.getLocalName())) {
1464 final String nodeParam = node.getNodeParameter();
1465 IdentitySchemaNode identity = null;
1466 String basePackageName = null;
1467 final Iterable<String> splittedElement = COLON_SPLITTER.split(nodeParam);
1468 final Iterator<String> iterator = splittedElement.iterator();
1469 final int length = Iterables.size(splittedElement);
1471 identity = findIdentityByName(module.getIdentities(), iterator.next());
1472 basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
1473 } else if (length == 2) {
1474 final String prefix = iterator.next();
1475 final Module dependentModule = findModuleFromImports(module.getImports(), prefix);
1476 if (dependentModule == null) {
1477 throw new IllegalArgumentException("Failed to process context-reference: unknown prefix "
1480 identity = findIdentityByName(dependentModule.getIdentities(), iterator.next());
1481 basePackageName = BindingMapping.getRootPackageName(dependentModule.getQNameModule());
1483 throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1486 if (identity == null) {
1487 throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
1491 final Class<RoutingContext> clazz = RoutingContext.class;
1492 final AnnotationTypeBuilder rc = getter.addAnnotation(clazz.getPackage().getName(),
1493 clazz.getSimpleName());
1494 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
1495 final String genTypeName = BindingMapping.getClassName(identity.getQName().getLocalName());
1496 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1501 private static IdentitySchemaNode findIdentityByName(final Set<IdentitySchemaNode> identities, final String name) {
1502 for (final IdentitySchemaNode id : identities) {
1503 if (id.getQName().getLocalName().equals(name)) {
1510 private Module findModuleFromImports(final Set<ModuleImport> imports, final String prefix) {
1511 for (final ModuleImport imp : imports) {
1512 if (imp.getPrefix().equals(prefix)) {
1513 return schemaContext.findModuleByName(imp.getModuleName(), imp.getRevision());
1519 private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1520 final boolean isReadOnly, final Module module) {
1521 if ((leaf != null) && (toBuilder != null)) {
1522 String leafDesc = leaf.getDescription();
1523 if (leafDesc == null) {
1526 Type returnType = null;
1527 final TypeDefinition<?> typeDef = CompatUtils.compatLeafType(leaf);
1528 if (typeDef instanceof UnionTypeDefinition) {
1529 // GeneratedType for this type definition should be already
1531 final QName qname = typeDef.getQName();
1532 final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1533 qname.getRevision());
1534 final ModuleContext mc = genCtx.get(unionModule);
1535 returnType = mc.getTypedefs().get(typeDef.getPath());
1536 } else if (typeDef instanceof EnumTypeDefinition && BaseTypes.ENUMERATION_QNAME.equals(typeDef.getQName())) {
1537 // Annonymous enumeration (already generated, since it is inherited via uses).
1538 LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf);
1539 QName qname = originalLeaf.getQName();
1540 final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
1541 qname.getRevision());
1542 returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath());
1544 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1546 return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
1552 * Converts <code>leaf</code> schema node to property of generated TO
1556 * generated TO builder to which is <code>leaf</code> added as
1559 * leaf schema node which is added to <code>toBuilder</code> as
1564 * boolean value which says if leaf property is|isn't read only
1565 * @return boolean value
1567 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
1568 * name equals null or if leaf is added by <i>uses</i>.</li>
1569 * <li>true - other cases</li>
1572 private static boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
1573 final Type returnType, final boolean isReadOnly) {
1574 if (returnType == null) {
1577 final String leafName = leaf.getQName().getLocalName();
1578 final String leafDesc = encodeAngleBrackets(leaf.getDescription());
1579 final GeneratedPropertyBuilder propBuilder = toBuilder.addProperty(BindingMapping.getPropertyName(leafName));
1580 propBuilder.setReadOnly(isReadOnly);
1581 propBuilder.setReturnType(returnType);
1582 propBuilder.setComment(leafDesc);
1583 toBuilder.addEqualsIdentity(propBuilder);
1584 toBuilder.addHashIdentity(propBuilder);
1585 toBuilder.addToStringProperty(propBuilder);
1590 * Converts <code>node</code> leaf list schema node to getter method of
1591 * <code>typeBuilder</code>.
1593 * @param typeBuilder
1594 * generated type builder to which is <code>node</code> added as
1597 * leaf list schema node which is added to
1598 * <code>typeBuilder</code> as getter method
1600 * @return boolean value
1602 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
1603 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
1604 * <li>false - other cases</li>
1607 private boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node, final Module module) {
1608 if (node == null || typeBuilder == null || node.isAddedByUses()) {
1612 final QName nodeName = node.getQName();
1613 if (nodeName == null) {
1617 final TypeDefinition<?> typeDef = node.getType();
1618 final Module parentModule = findParentModule(schemaContext, node);
1620 Type returnType = null;
1621 if (typeDef.getBaseType() == null) {
1622 if (typeDef instanceof EnumTypeDefinition) {
1623 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
1624 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
1625 final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
1626 typeBuilder,module);
1627 returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
1628 ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
1629 } else if (typeDef instanceof UnionTypeDefinition) {
1630 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1631 if (genTOBuilder != null) {
1632 returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
1634 } else if (typeDef instanceof BitsTypeDefinition) {
1635 final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
1636 returnType = genTOBuilder.toInstance();
1638 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1639 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1642 final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1643 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
1646 final ParameterizedType listType = Types.listTypeFor(returnType);
1647 constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType);
1651 private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition<?> typeDef,
1652 final GeneratedTypeBuilder typeBuilder, final Module parentModule) {
1653 final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(),
1654 genTOBuilder.getName());
1655 final String typedefDescription = encodeAngleBrackets(typeDef.getDescription());
1657 returnType.setDescription(typedefDescription);
1658 returnType.setReference(typeDef.getReference());
1659 returnType.setSchemaPath(typeDef.getPath().getPathFromRoot());
1660 returnType.setModuleName(parentModule.getName());
1662 genTOBuilder.setTypedef(true);
1663 genTOBuilder.setIsUnion(true);
1664 TypeProviderImpl.addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1668 final GeneratedTOBuilder unionBuilder = createUnionBuilder(genTOBuilder,typeBuilder);
1671 final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1672 method.setReturnType(returnType);
1673 method.addParameter(Types.STRING, "defaultValue");
1674 method.setAccessModifier(AccessModifier.PUBLIC);
1675 method.setStatic(true);
1677 final Set<Type> types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule);
1678 if (types == null) {
1679 ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule,
1680 Sets.<Type> newHashSet(unionBuilder.toInstance()));
1682 types.add(unionBuilder.toInstance());
1684 return returnType.toInstance();
1687 private static GeneratedTOBuilder createUnionBuilder(final GeneratedTOBuilder genTOBuilder, final GeneratedTypeBuilder typeBuilder) {
1688 final String outerCls = Types.getOuterClassName(genTOBuilder);
1689 final StringBuilder name;
1690 if (outerCls != null) {
1691 name = new StringBuilder(outerCls);
1693 name = new StringBuilder();
1695 name.append(genTOBuilder.getName());
1696 name.append("Builder");
1697 final GeneratedTOBuilderImpl unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),name.toString());
1698 unionBuilder.setIsUnionBuilder(true);
1699 return unionBuilder;
1702 private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1703 final Module module) {
1704 return addDefaultInterfaceDefinition(packageName, schemaNode, null, module);
1708 * Instantiates generated type builder with <code>packageName</code> and
1709 * <code>schemaNode</code>.
1711 * The new builder always implements
1712 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br>
1713 * If <code>schemaNode</code> is instance of GroupingDefinition it also
1714 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
1716 * If <code>schemaNode</code> is instance of
1717 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
1718 * DataNodeContainer} it can also implement nodes which are specified in
1721 * @param packageName
1722 * string with the name of the package to which
1723 * <code>schemaNode</code> belongs.
1725 * schema node for which is created generated type builder
1727 * parent type (can be null)
1728 * @return generated type builder <code>schemaNode</code>
1730 private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1731 final Type parent, final Module module) {
1732 final GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, "");
1733 if (parent == null) {
1734 it.addImplementsType(DATA_OBJECT);
1736 it.addImplementsType(BindingTypes.childOf(parent));
1738 if (!(schemaNode instanceof GroupingDefinition)) {
1739 it.addImplementsType(augmentable(it));
1742 if (schemaNode instanceof DataNodeContainer) {
1743 groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings());
1744 addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it);
1751 * Wraps the calling of the same overloaded method.
1753 * @param packageName
1754 * string with the package name to which returning generated type
1757 * schema node which provide data about the schema node name
1758 * @return generated type builder for <code>schemaNode</code>
1760 private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {
1761 return addRawInterfaceDefinition(packageName, schemaNode, "");
1765 * Returns reference to generated type builder for specified
1766 * <code>schemaNode</code> with <code>packageName</code>.
1768 * Firstly the generated type builder is searched in
1769 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
1770 * found it is created and added to <code>genTypeBuilders</code>.
1772 * @param packageName
1773 * string with the package name to which returning generated type
1776 * schema node which provide data about the schema node name
1778 * return type name prefix
1779 * @return generated type builder for <code>schemaNode</code>
1780 * @throws IllegalArgumentException
1782 * <li>if <code>schemaNode</code> is null</li>
1783 * <li>if <code>packageName</code> is null</li>
1784 * <li>if QName of schema node is null</li>
1785 * <li>if schemaNode name is null</li>
1789 private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
1790 final String prefix) {
1791 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1792 checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
1793 checkArgument(schemaNode.getQName() != null, "QName for Data Schema Node cannot be NULL.");
1794 final String schemaNodeName = schemaNode.getQName().getLocalName();
1795 checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
1798 if (prefix == null) {
1799 genTypeName = BindingMapping.getClassName(schemaNodeName);
1801 genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1804 // FIXME: Validation of name conflict
1805 final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1806 final Module module = findParentModule(schemaContext, schemaNode);
1807 qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
1808 newType.addComment(schemaNode.getDescription());
1809 newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName()));
1810 newType.setReference(schemaNode.getReference());
1811 newType.setSchemaPath(schemaNode.getPath().getPathFromRoot());
1812 newType.setModuleName(module.getName());
1814 if (!genTypeBuilders.containsKey(packageName)) {
1815 final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
1816 builders.put(genTypeName, newType);
1817 genTypeBuilders.put(packageName, builders);
1819 final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1820 if (!builders.containsKey(genTypeName)) {
1821 builders.put(genTypeName, newType);
1828 * Creates the name of the getter method name from <code>localName</code>.
1831 * string with the name of the getter method
1834 * @return string with the name of the getter method for
1835 * <code>methodName</code> in JAVA method format
1837 public static String getterMethodName(final String localName, final Type returnType) {
1838 final StringBuilder method = new StringBuilder();
1839 if (BOOLEAN.equals(returnType)) {
1840 method.append("is");
1842 method.append("get");
1844 final String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName));
1845 method.append(name);
1846 return method.toString();
1850 * Created a method signature builder as part of
1851 * <code>interfaceBuilder</code>.
1853 * The method signature builder is created for the getter method of
1854 * <code>schemaNodeName</code>. Also <code>comment</code> and
1855 * <code>returnType</code> information are added to the builder.
1857 * @param interfaceBuilder
1858 * generated type builder for which the getter method should be
1860 * @param schemaNodeName
1861 * string with schema node name. The name will be the part of the
1862 * getter method name.
1864 * string with comment for the getter method
1866 * type which represents the return type of the getter method
1867 * @return method signature builder which represents the getter method of
1868 * <code>interfaceBuilder</code>
1870 private static MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
1871 final String schemaNodeName, final String comment, final Type returnType) {
1872 final MethodSignatureBuilder getMethod = interfaceBuilder
1873 .addMethod(getterMethodName(schemaNodeName, returnType));
1874 getMethod.setComment(encodeAngleBrackets(comment));
1875 getMethod.setReturnType(returnType);
1880 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
1881 * or to <code>genTOBuilder</code> as property.
1883 * @param basePackageName
1884 * string contains the module package name
1886 * data schema node which should be added as getter method to
1887 * <code>typeBuilder</code> or as a property to
1888 * <code>genTOBuilder</code> if is part of the list key
1889 * @param typeBuilder
1890 * generated type builder for the list schema node
1891 * @param genTOBuilder
1892 * generated TO builder for the list keys
1894 * list of string which contains names of the list keys
1897 * @throws IllegalArgumentException
1899 * <li>if <code>schemaNode</code> equals null</li>
1900 * <li>if <code>typeBuilder</code> equals null</li>
1903 private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,
1904 final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys,
1905 final Module module) {
1906 checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
1907 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1909 if (schemaNode instanceof LeafSchemaNode) {
1910 final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
1911 final String leafName = leaf.getQName().getLocalName();
1912 final Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf,module);
1913 if (listKeys.contains(leafName)) {
1915 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module);
1917 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
1920 } else if (!schemaNode.isAddedByUses()) {
1921 if (schemaNode instanceof LeafListSchemaNode) {
1922 resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode, module);
1923 } else if (schemaNode instanceof ContainerSchemaNode) {
1924 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode);
1925 } else if (schemaNode instanceof ChoiceSchemaNode) {
1926 choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) schemaNode);
1927 } else if (schemaNode instanceof ListSchemaNode) {
1928 listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode);
1933 private void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
1934 final GeneratedTOBuilder genTOBuilder) {
1935 checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
1937 if (genTOBuilder != null) {
1938 final GeneratedTransferObject genTO = genTOBuilder.toInstance();
1939 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1940 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
1945 * Selects the names of the list keys from <code>list</code> and returns
1946 * them as the list of the strings
1949 * of string with names of the list keys
1950 * @return list of string which represents names of the list keys. If the
1951 * <code>list</code> contains no keys then the empty list is
1954 private static List<String> listKeys(final ListSchemaNode list) {
1955 final List<String> listKeys = new ArrayList<>();
1957 final List<QName> keyDefinition = list.getKeyDefinition();
1958 if (keyDefinition != null) {
1959 for (final QName keyDef : keyDefinition) {
1960 listKeys.add(keyDef.getLocalName());
1967 * Generates for the <code>list</code> which contains any list keys special
1968 * generated TO builder.
1970 * @param packageName
1971 * string with package name to which the list belongs
1973 * list schema node which is source of data about the list name
1974 * @return generated TO builder which represents the keys of the
1975 * <code>list</code> or null if <code>list</code> is null or list of
1976 * key definitions is null or empty.
1978 private static GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
1979 GeneratedTOBuilder genTOBuilder = null;
1980 if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
1981 final String listName = list.getQName().getLocalName() + "Key";
1982 final String genTOName = BindingMapping.getClassName(listName);
1983 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1985 return genTOBuilder;
1989 * Builds generated TO builders for <code>typeDef</code> of type
1990 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
1991 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
1992 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
1993 * enclosing transfer object.
1995 * If more then one generated TO builder is created for enclosing then all
1996 * of the generated TO builders are added to <code>typeBuilder</code> as
1997 * enclosing transfer objects.
2000 * type definition which can be of type <code>UnionType</code> or
2001 * <code>BitsTypeDefinition</code>
2002 * @param typeBuilder
2003 * generated type builder to which is added generated TO created
2004 * from <code>typeDef</code>
2006 * string with name for generated TO builder
2008 * @return generated TO builder for <code>typeDef</code>
2010 private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef,
2011 final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) {
2012 final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName());
2013 final List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();
2014 final String packageName = typeBuilder.getFullyQualifiedName();
2015 if (typeDef instanceof UnionTypeDefinition) {
2016 final List<GeneratedTOBuilder> types = ((TypeProviderImpl) typeProvider)
2017 .provideGeneratedTOBuildersForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
2018 classNameFromLeaf, leaf);
2019 genTOBuilders.addAll(types);
2021 GeneratedTOBuilder resultTOBuilder = null;
2022 if (types.isEmpty()) {
2023 throw new IllegalStateException("No GeneratedTOBuilder objects generated from union " + typeDef);
2025 resultTOBuilder = types.remove(0);
2026 for (final GeneratedTOBuilder genTOBuilder : types) {
2027 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
2030 final GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
2031 genPropBuilder.setReturnType(Types.CHAR_ARRAY);
2032 resultTOBuilder.addEqualsIdentity(genPropBuilder);
2033 resultTOBuilder.addHashIdentity(genPropBuilder);
2034 resultTOBuilder.addToStringProperty(genPropBuilder);
2036 } else if (typeDef instanceof BitsTypeDefinition) {
2037 genTOBuilders.add((((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
2038 packageName, typeDef, classNameFromLeaf, parentModule.getName()));
2040 if (!genTOBuilders.isEmpty()) {
2041 for (final GeneratedTOBuilder genTOBuilder : genTOBuilders) {
2042 typeBuilder.addEnclosingTransferObject(genTOBuilder);
2044 return genTOBuilders.get(0);
2051 * Adds the implemented types to type builder.
2053 * The method passes through the list of <i>uses</i> in
2054 * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding
2055 * generated type from {@link BindingGeneratorImpl#allGroupings
2056 * allGroupings} which is added as <i>implements type</i> to
2057 * <code>builder</code>
2059 * @param dataNodeContainer
2060 * element which contains the list of used YANG groupings
2062 * builder to which are added implemented types according to
2063 * <code>dataNodeContainer</code>
2064 * @return generated type builder with all implemented types
2066 private GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
2067 final GeneratedTypeBuilder builder) {
2068 for (final UsesNode usesNode : dataNodeContainer.getUses()) {
2069 if (usesNode.getGroupingPath() != null) {
2070 final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath()).toInstance();
2071 if (genType == null) {
2072 throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
2073 + builder.getName());
2076 builder.addImplementsType(genType);
2078 builder.addComment(genType.getDescription());
2079 builder.setDescription(genType.getDescription());
2080 builder.setModuleName(genType.getModuleName());
2081 builder.setReference(genType.getReference());
2082 builder.setSchemaPath(genType.getSchemaPath());
2089 private static boolean isNullOrEmpty(final Collection<?> list) {
2090 return list == null || list.isEmpty();
2093 private String createDescription(final Set<? extends SchemaNode> schemaNodes, final String moduleName) {
2094 final StringBuilder sb = new StringBuilder();
2096 if (!isNullOrEmpty(schemaNodes)) {
2097 final SchemaNode node = schemaNodes.iterator().next();
2099 if (node instanceof RpcDefinition) {
2100 sb.append("Interface for implementing the following YANG RPCs defined in module <b>" + moduleName + "</b>");
2101 } else if (node instanceof NotificationDefinition) {
2102 sb.append("Interface for receiving the following YANG notifications defined in module <b>" + moduleName + "</b>");
2105 sb.append(NEW_LINE);
2107 if (verboseClassComments) {
2109 sb.append(NEW_LINE);
2110 sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNodes)));
2111 sb.append("</pre>");
2112 sb.append(NEW_LINE);
2115 return replaceAllIllegalChars(sb);
2118 private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) {
2119 final StringBuilder sb = new StringBuilder();
2120 final String nodeDescription = encodeAngleBrackets(schemaNode.getDescription());
2121 final String formattedDescription = YangTemplate.formatToParagraph(nodeDescription, 0);
2123 if (!Strings.isNullOrEmpty(formattedDescription)) {
2124 sb.append(formattedDescription);
2125 sb.append(NEW_LINE);
2128 if (verboseClassComments) {
2129 final Module module = findParentModule(schemaContext, schemaNode);
2130 final StringBuilder linkToBuilderClass = new StringBuilder();
2131 final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
2132 final String className = namespace[namespace.length - 1];
2134 if (hasBuilderClass(schemaNode)) {
2135 linkToBuilderClass.append(className);
2136 linkToBuilderClass.append("Builder");
2140 sb.append("This class represents the following YANG schema fragment defined in module <b>");
2141 sb.append(module.getName());
2143 sb.append(NEW_LINE);
2145 sb.append(NEW_LINE);
2146 sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNode)));
2147 sb.append("</pre>");
2148 sb.append(NEW_LINE);
2149 sb.append("The schema path to identify an instance is");
2150 sb.append(NEW_LINE);
2152 sb.append(YangTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
2154 sb.append(NEW_LINE);
2156 if (hasBuilderClass(schemaNode)) {
2157 sb.append(NEW_LINE);
2158 sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
2159 sb.append(NEW_LINE);
2161 sb.append(linkToBuilderClass);
2162 sb.append(NEW_LINE);
2163 if (schemaNode instanceof ListSchemaNode) {
2164 final List<QName> keyDef = ((ListSchemaNode)schemaNode).getKeyDefinition();
2165 if (keyDef != null && !keyDef.isEmpty()) {
2167 sb.append(className);
2170 sb.append(NEW_LINE);
2175 return replaceAllIllegalChars(sb);
2178 private static boolean hasBuilderClass(final SchemaNode schemaNode) {
2179 if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
2180 schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
2186 private String createDescription(final Module module) {
2187 final StringBuilder sb = new StringBuilder();
2188 final String moduleDescription = encodeAngleBrackets(module.getDescription());
2189 final String formattedDescription = YangTemplate.formatToParagraph(moduleDescription, 0);
2191 if (!Strings.isNullOrEmpty(formattedDescription)) {
2192 sb.append(formattedDescription);
2193 sb.append(NEW_LINE);
2196 if (verboseClassComments) {
2198 sb.append("This class represents the following YANG schema fragment defined in module <b>");
2199 sb.append(module.getName());
2201 sb.append(NEW_LINE);
2203 sb.append(NEW_LINE);
2204 sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(module)));
2205 sb.append("</pre>");
2208 return replaceAllIllegalChars(sb);
2211 private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) {
2212 for (final ModuleContext ctx : genCtx.values()) {
2213 final GeneratedTypeBuilder result = ctx.getChildNode(path);
2214 if (result != null) {
2221 private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) {
2222 for (final ModuleContext ctx : genCtx.values()) {
2223 final GeneratedTypeBuilder result = ctx.getGrouping(path);
2224 if (result != null) {
2231 private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) {
2232 for (final ModuleContext ctx : genCtx.values()) {
2233 final GeneratedTypeBuilder result = ctx.getCase(path);
2234 if (result != null) {
2241 public Map<Module, ModuleContext> getModuleContexts() {
2246 static String replaceAllIllegalChars(final StringBuilder stringBuilder){
2247 final String ret = UNICODE_CHAR_PATTERN.matcher(stringBuilder).replaceAll("\\\\\\\\u");
2248 return ret.isEmpty() ? "" : ret;
2251 private static void annotateDeprecatedIfNecessary(final Status status, final GeneratedTypeBuilder builder) {
2252 if (status == Status.DEPRECATED) {
2253 builder.addAnnotation("", "Deprecated");