Class SetOpenStatusDelayed

java.lang.Object

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

nl.pim16aap2.animatedarchitecture.core.commands.SetOpenStatusDelayed

@Singleton
public class SetOpenStatusDelayed
extends DelayedCommand<Boolean>

Delayed version of SetOpenStatus.

This command is used to set the open status of a structure.

The open status can be provided as delayed input.

Nested Class Summary

Nested classes/interfaces inherited from class DelayedCommand

DelayedCommand.Context

Field Summary

Fields inherited from class DelayedCommand

commandFactory, delayedCommandInputManager, inputRequestFactory

Constructor Summary

Constructors

Constructor	Description
SetOpenStatusDelayed(DelayedCommand.Context context, DelayedCommandInputRequest.IFactory<Boolean> inputRequestFactory)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<?>	delayedInputExecutor(ICommandSender commandSender, StructureRetriever structureRetriever, Boolean isOpen)	The method that is run once delayed input is received.
protected CommandDefinition	getCommandDefinition()	Gets the command definition for this delayed command.
protected String	inputRequestMessage(ICommandSender commandSender, StructureRetriever structureRetriever)	Retrieves the message that will be sent to the command sender after initialization of a delayed input request.
@NonNull String	toString()

Methods inherited from class DelayedCommand

provideDelayedInput, runDelayed, runDelayed

Methods inherited from class Object

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

Constructor Details

SetOpenStatusDelayed

@Inject
public SetOpenStatusDelayed(DelayedCommand.Context context,
 DelayedCommandInputRequest.IFactory<Boolean> inputRequestFactory)

Method Details

getCommandDefinition

protected CommandDefinition getCommandDefinition()

Description copied from class: DelayedCommand

Gets the command definition for this delayed command.

Specified by:

getCommandDefinition in class DelayedCommand<Boolean>

Returns:

The command definition.

delayedInputExecutor

protected CompletableFuture<?> delayedInputExecutor(ICommandSender commandSender,
 StructureRetriever structureRetriever,
 Boolean isOpen)

Description copied from class: DelayedCommand

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 DelayedCommand.runDelayed(ICommandSender, StructureRetriever)).

Specified by:

delayedInputExecutor in class DelayedCommand<Boolean>

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.

isOpen - The delayed input that was retrieved.

Returns:

See BaseCommand.run().

inputRequestMessage

protected String inputRequestMessage(ICommandSender commandSender,
 StructureRetriever structureRetriever)

Description copied from class: DelayedCommand

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

Specified by:

inputRequestMessage in class DelayedCommand<Boolean>

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.

toString

public @NonNull String toString()

Overrides:

toString in class DelayedCommand<Boolean>