Package cloud.commandframework.execution

Class AsynchronousCommandExecutionCoordinator<C>

java.lang.Object

cloud.commandframework.execution.CommandExecutionCoordinator<C>

cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator<C>

Type Parameters:

C - Command sender type

@API(status=STABLE)
public final class AsynchronousCommandExecutionCoordinator<C>
extends CommandExecutionCoordinator<C>

Execution coordinator parses and/or executes commands on a separate thread from the calling thread

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AsynchronousCommandExecutionCoordinator.Builder<C>	Builder for AsynchronousCommandExecutionCoordinator instances

Nested classes/interfaces inherited from class cloud.commandframework.execution.CommandExecutionCoordinator

CommandExecutionCoordinator.SimpleCoordinator<C>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull AsynchronousCommandExecutionCoordinator.Builder<C>	builder()	Create a new AsynchronousCommandExecutionCoordinator.Builder instance.
@NonNull CompletableFuture<CommandResult<C>>	coordinateExecution(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> input)	Coordinate the execution of a command and return the result
static <C> @NonNull AsynchronousCommandExecutionCoordinator.Builder<C>	newBuilder()	Deprecated. prefer builder()

Methods inherited from class cloud.commandframework.execution.CommandExecutionCoordinator

getCommandTree, simpleCoordinator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

@API(status=STABLE,
     since="1.8.0")
public static <C>
@NonNull AsynchronousCommandExecutionCoordinator.Builder<C> builder()

Create a new AsynchronousCommandExecutionCoordinator.Builder instance.

Type Parameters:

C - sender type

Returns:

new AsynchronousCommandExecutionCoordinator.Builder

Since:

1.8.0

newBuilder

@API(status=DEPRECATED,
     since="1.8.0")
@Deprecated
public static <C>
@NonNull AsynchronousCommandExecutionCoordinator.Builder<C> newBuilder()

Deprecated.

prefer builder()

Create a new AsynchronousCommandExecutionCoordinator.Builder instance

Type Parameters:

C - Command sender type

Returns:

Builder

coordinateExecution

public @NonNull CompletableFuture<CommandResult<C>> coordinateExecution(@NonNull CommandContext<C> commandContext,
 @NonNull Queue<@NonNull String> input)

Description copied from class: CommandExecutionCoordinator

Coordinate the execution of a command and return the result

Specified by:

coordinateExecution in class CommandExecutionCoordinator<C>

Parameters:

commandContext - Command context

input - Command input

Returns:

Future that completes with the result