Class ListStructures

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.ListStructures

public class ListStructures
extends BaseCommand

Represents a command to list a number of structures matching a single StructureRetrieverFactory. This is basically only useful for String-based look-ups (as there aren't duplicate matches otherwise), but I don't judge.

Field Summary

Fields inherited from class BaseCommand

executor, localizer

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<?>	executeCommand(PermissionsStatus permissions)	Executes the command.
CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
@NonNull String	toString()

Methods inherited from class BaseCommand

availableForNonPlayers, availableForPlayers, getCommandSender, getStructure, hasAccessToAttribute, hasPermission, run, runWithRawResult, runWithRawResult, sendGenericErrorMessage, startExecution, validateInput

Methods inherited from class Object

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

Method Details

getCommand

public CommandDefinition getCommand()

Description copied from class: BaseCommand

Gets the CommandDefinition that contains the definition of this BaseCommand.

Specified by:

getCommand in class BaseCommand

Returns:

The CommandDefinition that contains the definition of this BaseCommand.

executeCommand

protected CompletableFuture<?> executeCommand(PermissionsStatus permissions)

Description copied from class: BaseCommand

Executes the command. This method is only called if BaseCommand.validateInput() and BaseCommand.hasPermission() are true.

Note that this method is called asynchronously.

Specified by:

executeCommand in class BaseCommand

Parameters:

permissions - Whether the ICommandSender has user and/or admin permissions.

Returns:

The future of the command execution.

toString

public @NonNull String toString()

Overrides:

toString in class BaseCommand