binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ListGenerator.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.generator.impl.reactor;
   9
  10 import static org.opendaylight.mdsal.binding.model.ri.BindingTypes.identifiable;
  11
  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.yangtools.yang.binding.contract.Naming;
  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;
  31
  32 /**
  33  * Generator corresponding to a {@code list} statement.
  34  */
  35 final class ListGenerator extends CompositeSchemaTreeGenerator<ListEffectiveStatement, ListRuntimeType> {
  36     private final @Nullable KeyGenerator keyGen;
  37
  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))
  42             .orElse(null);
  43     }
  44
  45     @Override
  46     StatementNamespace namespace() {
  47         return StatementNamespace.LIST;
  48     }
  49
  50     @Nullable KeyGenerator keyGenerator() {
  51         return keyGen;
  52     }
  53
  54     @Override
  55     void pushToInference(final SchemaInferenceStack dataTree) {
  56         dataTree.enterDataTree(statement().argument());
  57     }
  58
  59     @Override
  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);
  66
  67         final ModuleGenerator module = currentModule();
  68         module.addQNameConstant(builder, localName());
  69
  70         if (keyGen != null) {
  71             // Add yang.binding.Identifiable and its key() method
  72             final GeneratedType keyType = keyGen.getGeneratedType(builderFactory);
  73             builder.addImplementsType(identifiable(keyType));
  74             builder.addMethod(Naming.IDENTIFIABLE_KEY_NAME)
  75                 .setReturnType(keyType)
  76                 .addAnnotation(OVERRIDE_ANNOTATION);
  77         }
  78
  79         addGetterMethods(builder, builderFactory);
  80
  81         annotateDeprecatedIfNecessary(builder);
  82         builderFactory.addCodegenInformation(module, statement(), builder);
  83         builder.setModuleName(module.statement().argument().getLocalName());
  84         //    builder.setSchemaPath(node.getPath());
  85
  86         return builder.build();
  87     }
  88
  89     private @Nullable KeyRuntimeType keyRuntimeType() {
  90         final var gen = keyGen;
  91         return gen != null ? gen.runtimeType().orElseThrow() : null;
  92     }
  93
  94     @Override
  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);
 100         }
 101
 102         return Types.listTypeFor(generatedType);
 103     }
 104
 105     @Override
 106     MethodSignatureBuilder constructGetter(final GeneratedTypeBuilderBase<?> builder, final Type returnType) {
 107         final MethodSignatureBuilder ret = super.constructGetter(builder, returnType)
 108             .setMechanics(ValueMechanics.NULLIFY_EMPTY);
 109
 110         final MethodSignatureBuilder nonnull = builder
 111             .addMethod(Naming.getNonnullMethodName(localName().getLocalName()))
 112             .setReturnType(returnType)
 113             .setDefault(true);
 114         annotateDeprecatedIfNecessary(nonnull);
 115
 116         return ret;
 117     }
 118
 119     @Override
 120     CompositeRuntimeTypeBuilder<ListEffectiveStatement, ListRuntimeType> createBuilder(
 121             final ListEffectiveStatement statement) {
 122         return new CompositeRuntimeTypeBuilder<>(statement) {
 123             @Override
 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());
 128             }
 129         };
 130     }
 131 }