Class DelayedCommandInputRequest<T>

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.util.delayedinput.DelayedInputRequest<T>

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

Type Parameters:

T - The type of data that is to be retrieved from the player.

public final class DelayedCommandInputRequest<T>
extends DelayedInputRequest<T>

Represents a request for delayed additional input for a command.

Taking the AddOwner command as an example, it could be initialized using a GUI, in which case it is known who the ICommandSender is and what the target Structure is. However, for some GUIs (e.g. Spigot), it is not yet known who the target player is and what the desired permission level is. This class can then be used to retrieve the additional data that is required to execute the command.

This class manages the lifecycle of delayed command input, including registration with the DelayedCommandInputManager, sending appropriate messages to the command sender, handling timeouts, and executing the command once input is received.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DelayedCommandInputRequest.ContextProvider
static interface	DelayedCommandInputRequest.IFactory<T>	The factory interface for creating DelayedCommandInputRequest instances.

Nested classes/interfaces inherited from class DelayedInputRequest

DelayedInputRequest.Status

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(@Nullable Object other)
protected void	cleanup()	Performs cleanup when the request is completed, timed out, or cancelled.
boolean	equals(@Nullable Object o)
protected CompletableFuture<?>	getCommandOutput()	The output of the command.
int	hashCode()
CompletableFuture<?>	provide(Object input)	Provides the input object as input for this input request.
@NonNull String	toString()

Methods inherited from class DelayedInputRequest

cancel, cancelled, completed, exceptionally, getInputResult, getStatus, set, success, timedOut

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

provide

public CompletableFuture<?> provide(Object input)

Provides the input object as input for this input request. See DelayedInputRequest.set(Object).

If the provided input is not of the correct type as defined by inputClass, a future containing a null value is returned to indicate incorrect input type.

Parameters:

input - The input object to provide.

Returns:

When the input is of the correct type, commandOutput is returned, otherwise an exception is thrown (not as a future).

Throws:

IllegalArgumentException - If the input object is not of the correct type.

cleanup

protected void cleanup()

Performs cleanup when the request is completed, timed out, or cancelled.

This method:

1. Deregisters this request from the DelayedCommandInputManager
2. Sends appropriate messages to the command sender about timeout or cancellation if applicable

Overrides:

cleanup in class DelayedInputRequest<T>

toString

public @NonNull String toString()

Overrides:

toString in class DelayedInputRequest<T>

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class DelayedInputRequest<T>

canEqual

protected boolean canEqual(@Nullable Object other)

Overrides:

canEqual in class DelayedInputRequest<T>

hashCode

public int hashCode()

Overrides:

hashCode in class DelayedInputRequest<T>

getCommandOutput

protected CompletableFuture<?> getCommandOutput()

The output of the command. See BaseCommand.run().