opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/InternalCommand.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.controller.cluster.access.client;
   9
  10 import javax.annotation.Nonnull;
  11 import javax.annotation.Nullable;
  12
  13 /**
  14  * This interface is used to pass the unit of work via the actors mailbox. The command can alter behavior of the actor
  15  * by returning a new behavior.
  16  *
  17  * @author Robert Varga
  18  */
  19 @FunctionalInterface
  20 public interface InternalCommand {
  21     /**
  22      * Run command actions.
  23      *
  24      * @param currentBehavior Current Behavior
  25      * @return Next behavior to use in the client actor
  26      */
  27     @Nullable ClientActorBehavior execute(@Nonnull ClientActorBehavior currentBehavior);
  28 }