Package nl.pim16aap2.animatedarchitecture.core.commands

Class DelayedCommand<T>

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.DelayedCommand<T>

Direct Known Subclasses:

AddOwnerDelayed, RemoveOwnerDelayed, SetBlocksToMoveDelayed, SetOpenDirectionDelayed, SetOpenStatusDelayed

public abstract class DelayedCommand<T>
extends Object

Represents a delayed command.

A delayed command allows "starting" the command while only knowing the target structure. This is useful when the structure is already known (e.g. after having been selected in a GUI), but the other specific data is not.

An example usage of this system could be changing the name of a structure via a GUI. Using the GUI, the user has to select a structure to apply the change to, but we'll need to wait for user input to update the name. For a user, having to use specify the structure they would need to change in a command or something would be rather awkward, so this way we can remember that information and not require the user to input duplicate data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DelayedCommand.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected final javax.inject.Provider<CommandFactory>	commandFactory
protected final DelayedCommandInputManager	delayedCommandInputManager
protected final DelayedCommandInputRequest.IFactory<T>	inputRequestFactory
protected final ILocalizer	localizer
protected final ITextFactory	textFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelayedCommand(DelayedCommand.Context context, DelayedCommandInputRequest.IFactory<T> inputRequestFactory, Class<T> delayedInputClz)

Method Summary

Modifier and Type	Method	Description
protected abstract CompletableFuture<?>	delayedInputExecutor(ICommandSender commandSender, StructureRetriever structureRetriever, T delayedInput)	The method that is run once delayed input is received.
protected abstract CommandDefinition	getCommandDefinition()
protected abstract String	inputRequestMessage(ICommandSender commandSender, StructureRetriever structureRetriever)	Retrieves the message that will be sent to the command sender after initialization of a delayed input request.
CompletableFuture<?>	provideDelayedInput(ICommandSender commandSender, T data)	Provides the delayed input if there is currently an active DelayedCommandInputRequest for the ICommandSender.
CompletableFuture<?>	runDelayed(ICommandSender commandSender, StructureRetriever structureRetriever)	Starts the (new) DelayedInputRequest for this delayed command.
CompletableFuture<?>	runDelayed(ICommandSender commandSender, Creator creator, Function<T,CompletableFuture<?>> executor, @Nullable Supplier<String> initMessageSupplier)	Starts the (new) DelayedInputRequest for this delayed command.

Methods inherited from class java.lang.Object

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

Field Details

delayedCommandInputManager

protected final DelayedCommandInputManager delayedCommandInputManager

localizer

protected final ILocalizer localizer

textFactory

protected final ITextFactory textFactory

commandFactory

protected final javax.inject.Provider<CommandFactory> commandFactory

inputRequestFactory

protected final DelayedCommandInputRequest.IFactory<T> inputRequestFactory

Constructor Details

DelayedCommand

protected DelayedCommand(DelayedCommand.Context context,
 DelayedCommandInputRequest.IFactory<T> inputRequestFactory,
 Class<T> delayedInputClz)

Method Details

runDelayed

public CompletableFuture<?> runDelayed(ICommandSender commandSender,
 Creator creator,
 Function<T,CompletableFuture<?>> executor,
 @Nullable
 @Nullable Supplier<String> initMessageSupplier)

Starts the (new) DelayedInputRequest for this delayed command.

The DelayedCommandInputRequest will be used to retrieve the values that are required to execute the command. The player will be asked to use the command (again, if needed) to supply the missing data.

These missing data can be supplied using provideDelayedInput(ICommandSender, T). Once the data are supplied, the command will be executed.

Parameters:

commandSender - The entity that sent the command and is held responsible (i.e. permissions, communication) for its execution.

creator - A Creator that will wait for the input.

runDelayed

public CompletableFuture<?> runDelayed(ICommandSender commandSender,
 StructureRetriever structureRetriever)

Starts the (new) DelayedInputRequest for this delayed command.

The DelayedCommandInputRequest will be used to retrieve the values that are required to execute the command. The player will be asked to use the command (again, if needed) to supply the missing data.

These missing data can be supplied using provideDelayedInput(ICommandSender, T). Once the data are supplied, the command will be executed.

Parameters:

commandSender - The entity that sent the command and is held responsible (i.e. permissions, communication) for its execution.

structureRetriever - A StructureRetrieverFactory that references the target structure.

Returns:

See BaseCommand.run().

provideDelayedInput

public CompletableFuture<?> provideDelayedInput(ICommandSender commandSender,
 T data)

Provides the delayed input if there is currently an active DelayedCommandInputRequest for the ICommandSender. After processing the input, the new command will be executed immediately.

If no active DelayedCommandInputRequest can be found for the command sender, the command sender will be informed about it (e.g. "We are not waiting for a command!").

Parameters:

commandSender - The ICommandSender for which to look for an active DelayedCommandInputRequest that can be fulfilled.

data - The data specified by the user.

Returns:

See ToolUser.handleInput(Object).

getCommandDefinition

protected abstract CommandDefinition getCommandDefinition()

delayedInputExecutor

protected abstract CompletableFuture<?> delayedInputExecutor(ICommandSender commandSender,
 StructureRetriever structureRetriever,
 T delayedInput)

The method that is run once delayed input is received.

It processes the new input and executes the command using the previously-provided data (see runDelayed(ICommandSender, StructureRetriever)).

Parameters:

commandSender - The entity that sent the command and is held responsible (i.e. permissions, communication) for its execution.

structureRetriever - A StructureRetrieverFactory that references the target structure.

delayedInput - The delayed input that was retrieved.

Returns:

See BaseCommand.run().

inputRequestMessage

protected abstract String inputRequestMessage(ICommandSender commandSender,
 StructureRetriever structureRetriever)

Retrieves the message that will be sent to the command sender after initialization of a delayed input request.

Parameters:

commandSender - The user responsible for the delayed command.

structureRetriever - The structure retriever as currently specified.

Returns:

The init message for the delayed input request.