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.ri.BindingTypes.identifiable;
12 import java.util.List;
13 import org.eclipse.jdt.annotation.Nullable;
14 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultListRuntimeType;
15 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
16 import org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics;
17 import org.opendaylight.mdsal.binding.model.api.Type;
18 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
19 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
20 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
21 import org.opendaylight.mdsal.binding.model.ri.Types;
22 import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
23 import org.opendaylight.mdsal.binding.runtime.api.KeyRuntimeType;
24 import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
25 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
26 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
27 import org.opendaylight.yangtools.yang.common.Ordering;
28 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
33 * Generator corresponding to a {@code list} statement.
35 final class ListGenerator extends CompositeSchemaTreeGenerator<ListEffectiveStatement, ListRuntimeType> {
36 private final @Nullable KeyGenerator keyGen;
38 ListGenerator(final ListEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
39 super(statement, parent);
40 keyGen = statement.findFirstEffectiveSubstatement(KeyEffectiveStatement.class)
41 .map(key -> new KeyGenerator(key, parent, this))
46 StatementNamespace namespace() {
47 return StatementNamespace.LIST;
50 @Nullable KeyGenerator keyGenerator() {
55 void pushToInference(final SchemaInferenceStack dataTree) {
56 dataTree.enterDataTree(statement().argument());
60 GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
61 final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
62 addImplementsChildOf(builder);
63 addAugmentable(builder);
64 addUsesInterfaces(builder, builderFactory);
65 addConcreteInterfaceMethods(builder);
67 final ModuleGenerator module = currentModule();
68 module.addQNameConstant(builder, localName());
71 // Add yang.binding.Identifiable and its key() method
72 final GeneratedType keyType = keyGen.getGeneratedType(builderFactory);
73 builder.addImplementsType(identifiable(keyType));
74 builder.addMethod(BindingMapping.IDENTIFIABLE_KEY_NAME)
75 .setReturnType(keyType)
76 .addAnnotation(OVERRIDE_ANNOTATION);
79 addGetterMethods(builder, builderFactory);
81 annotateDeprecatedIfNecessary(builder);
82 builderFactory.addCodegenInformation(module, statement(), builder);
83 builder.setModuleName(module.statement().argument().getLocalName());
84 // builder.setSchemaPath(node.getPath());
86 return builder.build();
89 private @Nullable KeyRuntimeType keyRuntimeType() {
90 final var gen = keyGen;
91 return gen != null ? gen.runtimeType().orElseThrow() : null;
95 Type methodReturnType(final TypeBuilderFactory builderFactory) {
96 final Type generatedType = super.methodReturnType(builderFactory);
97 // We are wrapping the generated type in either a List or a Map based on presence of the key
98 if (keyGen != null && statement().ordering() == Ordering.SYSTEM) {
99 return Types.mapTypeFor(keyGen.getGeneratedType(builderFactory), generatedType);
102 return Types.listTypeFor(generatedType);
106 MethodSignatureBuilder constructGetter(final GeneratedTypeBuilderBase<?> builder, final Type returnType) {
107 final MethodSignatureBuilder ret = super.constructGetter(builder, returnType)
108 .setMechanics(ValueMechanics.NULLIFY_EMPTY);
110 final MethodSignatureBuilder nonnull = builder
111 .addMethod(BindingMapping.getNonnullMethodName(localName().getLocalName()))
112 .setReturnType(returnType)
114 annotateDeprecatedIfNecessary(nonnull);
120 CompositeRuntimeTypeBuilder<ListEffectiveStatement, ListRuntimeType> createBuilder(
121 final ListEffectiveStatement statement) {
122 return new CompositeRuntimeTypeBuilder<>(statement) {
124 ListRuntimeType build(final GeneratedType type, final ListEffectiveStatement statement,
125 final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
126 // FIXME: the key here is not rebased correctly :(
127 return new DefaultListRuntimeType(type, statement, children, augments, keyRuntimeType());