Package nl.pim16aap2.animatedarchitecture.core.commands

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DelayedCommandInputRequest.IFactory<T>

Nested classes/interfaces inherited from class nl.pim16aap2.animatedarchitecture.core.util.delayedinput.DelayedInputRequest

DelayedInputRequest.Status

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected void	cleanup()	Runs after the request has closed.
boolean	equals(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.
String	toString()

Methods inherited from class nl.pim16aap2.animatedarchitecture.core.util.delayedinput.DelayedInputRequest

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

Methods inherited from class java.lang.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 false boolean is returned to indicate incorrect command usage.

Parameters:

input - The input object to provide.

Returns:

When the input is of the correct type, commandOutput is returned, otherwise false.

cleanup

protected void cleanup()

Description copied from class: DelayedInputRequest

Runs after the request has closed. Either because input was provided or because the request timed out.

See DelayedInputRequest.getStatus().

Overrides:

cleanup in class DelayedInputRequest<T>

toString

public String toString()

Overrides:

toString in class DelayedInputRequest<T>

equals

public boolean equals(Object o)

Overrides:

equals in class DelayedInputRequest<T>

canEqual

protected boolean canEqual(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().