c72b854dd887405a8d5e8db3cda177466f97d2bb
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / actors / 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.datastore.actors.client;
9
10 import javax.annotation.Nullable;
11
12 /**
13  * This interface is used to pass the unit of work via the actors mailbox. The command can alter behavior of the actor
14  * by returning a new behavior.
15  *
16  * @author Robert Varga
17  */
18 @FunctionalInterface
19 public interface InternalCommand {
20     /**
21      * Run command actions.
22      *
23      * @return Next behavior to use in the client actor
24      */
25     @Nullable ClientActorBehavior execute();
26 }