binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/RpcServiceGenerator.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 java.util.Objects.requireNonNull;
  11
  12 import java.util.List;
  13 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  14 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  15 import org.opendaylight.mdsal.binding.model.api.TypeMemberComment;
  16 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  17 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
  18 import org.opendaylight.mdsal.binding.model.util.BindingTypes;
  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.QName;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
  26
  27 final class RpcServiceGenerator extends AbstractImplicitGenerator {
  28     private static final JavaTypeName CHECK_RETURN_VALUE_ANNOTATION =
  29         // Do not refer to annotation class, as it may not be available at runtime
  30         JavaTypeName.create("edu.umd.cs.findbugs.annotations", "CheckReturnValue");
  31
  32     private final List<RpcGenerator> rpcs;
  33
  34     RpcServiceGenerator(final ModuleGenerator parent, final List<RpcGenerator> rpcs) {
  35         super(parent);
  36         this.rpcs = requireNonNull(rpcs);
  37     }
  38
  39     @Override
  40     String classSuffix() {
  41         return BindingMapping.RPC_SERVICE_SUFFIX;
  42     }
  43
  44     @Override
  45     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  46         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  47         builder.addImplementsType(BindingTypes.RPC_SERVICE);
  48
  49         for (RpcGenerator rpcGen : rpcs) {
  50             final RpcEffectiveStatement rpc = rpcGen.statement();
  51             final QName qname = rpc.argument();
  52
  53             // FIXME: this may still conflict in theory
  54             final MethodSignatureBuilder method = builder.addMethod(BindingMapping.getRpcMethodName(qname));
  55
  56             method.addParameter(getChild(rpcGen, InputEffectiveStatement.class).getGeneratedType(builderFactory),
  57                 "input");
  58             method.setReturnType(Types.listenableFutureTypeFor(BindingTypes.rpcResult(
  59                 getChild(rpcGen, OutputEffectiveStatement.class).getGeneratedType(builderFactory))));
  60
  61             // FIXME: this should not be part of runtime types
  62             method.addAnnotation(CHECK_RETURN_VALUE_ANNOTATION);
  63             final String rpcName = qname.getLocalName();
  64             method.setComment(new TypeMemberComment("Invoke {@code " + rpcName + "} RPC.",
  65                 rpc.findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class).orElse(null),
  66                 "@param input of {@code " + rpcName + "}\n"
  67                     + "@return output of {@code " + rpcName + '}'));
  68         }
  69
  70         // FIXME: activate this
  71         //      addCodegenInformation(interfaceBuilder, module, "RPCs", rpcDefinitions);
  72
  73         return builder.build();
  74     }
  75 }