binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/Action.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, 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.yangtools.yang.binding;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import edu.umd.cs.findbugs.annotations.CheckReturnValue;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.common.RpcResult;
  14
  15 /**
  16  * Interface extended by all interfaces generated for a YANG {@code action}.
  17  *
  18  * @author Robert Varga
  19  */
  20 public non-sealed interface Action<P extends InstanceIdentifier<?>, I extends RpcInput, O extends RpcOutput>
  21         extends BindingContract<Action<P, I, O>> {
  22     /**
  23      * Invoke the action.
  24      *
  25      * @param path Invocation path
  26      * @param input Input argument
  27      * @return Future result of invocation
  28      * @throws NullPointerException if any of the arguments are null
  29      * @throws IllegalArgumentException if {@code path} is {@link InstanceIdentifier#isWildcarded()}
  30      */
  31     @CheckReturnValue
  32     @NonNull ListenableFuture<@NonNull RpcResult<@NonNull O>> invoke(@NonNull P path, @NonNull I input);
  33 }