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.keyAware;
  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.binding.contract.StatementNamespace;
  28 import org.opendaylight.yangtools.yang.common.Ordering;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  32
  33 /**
  34  * Generator corresponding to a {@code list} statement.
  35  */
  36 final class ListGenerator extends CompositeSchemaTreeGenerator<ListEffectiveStatement, ListRuntimeType> {
  37     private final @Nullable KeyGenerator keyGen;
  38
  39     ListGenerator(final ListEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
  40         super(statement, parent);
  41         keyGen = statement.findFirstEffectiveSubstatement(KeyEffectiveStatement.class)
  42             .map(key -> new KeyGenerator(key, parent, this))
  43             .orElse(null);
  44     }
  45
  46     @Override
  47     StatementNamespace namespace() {
  48         return StatementNamespace.LIST;
  49     }
  50
  51     @Nullable KeyGenerator keyGenerator() {
  52         return keyGen;
  53     }
  54
  55     @Override
  56     void pushToInference(final SchemaInferenceStack dataTree) {
  57         dataTree.enterDataTree(statement().argument());
  58     }
  59
  60     @Override
  61     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  62         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  63         addImplementsChildOf(builder);
  64         addAugmentable(builder);
  65         addUsesInterfaces(builder, builderFactory);
  66         addConcreteInterfaceMethods(builder);
  67
  68         final ModuleGenerator module = currentModule();
  69         module.addQNameConstant(builder, localName());
  70
  71         if (keyGen != null) {
  72             // Add yang.binding.Identifiable and its key() method
  73             final GeneratedType keyType = keyGen.getGeneratedType(builderFactory);
  74             builder.addImplementsType(keyAware(keyType));
  75             builder.addMethod(Naming.KEY_AWARE_KEY_NAME)
  76                 .setReturnType(keyType)
  77                 .addAnnotation(OVERRIDE_ANNOTATION);
  78         }
  79
  80         addGetterMethods(builder, builderFactory);
  81
  82         annotateDeprecatedIfNecessary(builder);
  83         builderFactory.addCodegenInformation(module, statement(), builder);
  84         builder.setModuleName(module.statement().argument().getLocalName());
  85         //    builder.setSchemaPath(node.getPath());
  86
  87         return builder.build();
  88     }
  89
  90     private @Nullable KeyRuntimeType keyRuntimeType() {
  91         final var gen = keyGen;
  92         return gen != null ? gen.runtimeType().orElseThrow() : null;
  93     }
  94
  95     @Override
  96     Type methodReturnType(final TypeBuilderFactory builderFactory) {
  97         final Type generatedType = super.methodReturnType(builderFactory);
  98         // We are wrapping the generated type in either a List or a Map based on presence of the key
  99         if (keyGen != null && statement().ordering() == Ordering.SYSTEM) {
 100             return Types.mapTypeFor(keyGen.getGeneratedType(builderFactory), generatedType);
 101         }
 102
 103         return Types.listTypeFor(generatedType);
 104     }
 105
 106     @Override
 107     MethodSignatureBuilder constructGetter(final GeneratedTypeBuilderBase<?> builder, final Type returnType) {
 108         final MethodSignatureBuilder ret = super.constructGetter(builder, returnType)
 109             .setMechanics(ValueMechanics.NULLIFY_EMPTY);
 110
 111         final MethodSignatureBuilder nonnull = builder
 112             .addMethod(Naming.getNonnullMethodName(localName().getLocalName()))
 113             .setReturnType(returnType)
 114             .setDefault(true);
 115         annotateDeprecatedIfNecessary(nonnull);
 116
 117         return ret;
 118     }
 119
 120     @Override
 121     CompositeRuntimeTypeBuilder<ListEffectiveStatement, ListRuntimeType> createBuilder(
 122             final ListEffectiveStatement statement) {
 123         return new CompositeRuntimeTypeBuilder<>(statement) {
 124             @Override
 125             ListRuntimeType build(final GeneratedType type, final ListEffectiveStatement statement,
 126                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 127                 // FIXME: the key here is not rebased correctly :(
 128                 return new DefaultListRuntimeType(type, statement, children, augments, keyRuntimeType());
 129             }
 130         };
 131     }
 132 }