2 * Copyright (c) 2021 PANTHEON.tech, s.r.o. 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.reactor;
10 import static org.opendaylight.mdsal.binding.model.util.BindingTypes.identifiable;
12 import org.eclipse.jdt.annotation.Nullable;
13 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
14 import org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics;
15 import org.opendaylight.mdsal.binding.model.api.Type;
16 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
17 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
18 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
19 import org.opendaylight.mdsal.binding.model.util.Types;
20 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
21 import org.opendaylight.yangtools.yang.common.Ordering;
22 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
28 * Generator corresponding to a {@code list} statement.
30 final class ListGenerator extends AbstractCompositeGenerator<ListEffectiveStatement> {
31 private final @Nullable KeyGenerator keyGen;
33 ListGenerator(final ListEffectiveStatement statement, final AbstractCompositeGenerator<?> parent) {
34 super(statement, parent);
35 keyGen = statement.findFirstEffectiveSubstatement(KeyEffectiveStatement.class)
36 .map(key -> new KeyGenerator(key, parent, this))
40 @Nullable KeyGenerator keyGenerator() {
45 void pushToInference(final SchemaInferenceStack dataTree) {
46 dataTree.enterDataTree(statement().getIdentifier());
50 GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
51 final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
52 addImplementsChildOf(builder);
53 addAugmentable(builder);
54 addUsesInterfaces(builder, builderFactory);
55 addConcreteInterfaceMethods(builder);
57 final ModuleGenerator module = currentModule();
58 module.addQNameConstant(builder, localName().getLocalName());
61 // Add yang.binding.Identifiable and its key() method
62 final GeneratedType keyType = keyGen.getGeneratedType(builderFactory);
63 builder.addImplementsType(identifiable(keyType));
64 builder.addMethod(BindingMapping.IDENTIFIABLE_KEY_NAME)
65 .setReturnType(keyType)
66 .addAnnotation(OVERRIDE_ANNOTATION);
69 addGetterMethods(builder, builderFactory);
71 annotateDeprecatedIfNecessary(builder);
72 if (builderFactory instanceof TypeBuilderFactory.Codegen) {
73 addCodegenInformation(module, statement(), builder);
75 builder.setModuleName(module.statement().argument().getLocalName());
76 // builder.setSchemaPath(node.getPath());
78 return builder.build();
82 Type methodReturnType(final TypeBuilderFactory builderFactory) {
83 final Type generatedType = super.methodReturnType(builderFactory);
84 // We are wrapping the generated type in either a List or a Map based on presence of the key
86 final Ordering ordering = statement()
87 .findFirstEffectiveSubstatementArgument(OrderedByEffectiveStatement.class)
88 .orElse(Ordering.SYSTEM);
89 if (ordering == Ordering.SYSTEM) {
90 return Types.mapTypeFor(keyGen.getGeneratedType(builderFactory), generatedType);
94 return Types.listTypeFor(generatedType);
98 MethodSignatureBuilder constructGetter(final GeneratedTypeBuilderBase<?> builder, final Type returnType) {
99 final MethodSignatureBuilder ret = super.constructGetter(builder, returnType)
100 .setMechanics(ValueMechanics.NULLIFY_EMPTY);
102 final MethodSignatureBuilder nonnull = builder
103 .addMethod(BindingMapping.getNonnullMethodName(localName().getLocalName()))
104 .setReturnType(returnType)
106 annotateDeprecatedIfNecessary(nonnull);