sila_java.library.server_base.command.observable

Interface RunnableCommandTask<ParamType,ResultType>

Type Parameters:

ParamType - The command parameter type

ResultType - The command result type

All Superinterfaces:

AutoCloseable

public interface RunnableCommandTask<ParamType,ResultType>
extends AutoCloseable

Runnable command task

Method Summary

Modifier and Type	Method and Description
default void	close() Called when the command id becomes invalid
default void	onFinish(ObservableCommandWrapper<ParamType,ResultType> command, boolean withError)
default void	onNewCommand(ObservableCommandWrapper<ParamType,ResultType> newCommand) Called when a new command is added in the command manager
default void	preRun(ParamType parameters, UUID commandExecutionUUID)
ResultType	run(ObservableCommandWrapper<ParamType,ResultType> command) Run the command task
default void	validate(ParamType parameters)

Method Detail

run

ResultType run(ObservableCommandWrapper<ParamType,ResultType> command)
        throws StatusRuntimeException

Run the command task

Parameters:

command - The command object linked to this task

Returns:

The task result

Throws:

StatusRuntimeException - If an error occur during the task

validate

default void validate(ParamType parameters)
               throws StatusRuntimeException

Throws:

StatusRuntimeException

preRun

default void preRun(ParamType parameters,
                    UUID commandExecutionUUID)

onFinish

default void onFinish(ObservableCommandWrapper<ParamType,ResultType> command,
                      boolean withError)

close

default void close()

Called when the command id becomes invalid

Specified by:

close in interface AutoCloseable

onNewCommand

default void onNewCommand(ObservableCommandWrapper<ParamType,ResultType> newCommand)

Called when a new command is added in the command manager

Parameters:

newCommand - The new command added