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.annotations.Beta;
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import javax.annotation.CheckReturnValue;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.yang.common.RpcResult;
  15
  16 /**
  17  * Interface extended by all interfaces generated for a YANG {@code action}.
  18  *
  19  * @author Robert Varga
  20  */
  21 @Beta
  22 @FunctionalInterface
  23 public interface Action<P extends DataObject, I extends RpcInput, O extends RpcOutput> {
  24     /**
  25      * Invoke the action.
  26      *
  27      * @param path Invocation path
  28      * @param input Input argument
  29      * @return Future result of invocation
  30      * @throws NullPointerException if any of the arguments are null
  31      */
  32     @CheckReturnValue
  33     @NonNull FluentFuture<@NonNull RpcResult<@NonNull O>> invoke(@NonNull InstanceIdentifier<P> path, @NonNull I input);
  34 }