Package nl.pim16aap2.animatedarchitecture.core.commands

Class UpdateCreator

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.UpdateCreator

public final class UpdateCreator
extends BaseCommand

Represents a command that is used to update active Creator processes with arbitrary data in out-of-procedure order.

The exact effects of this command depend on the specific state of the creator process and its defined settings. As such, it is not recommended to give users free access to this command.

See Creator.update(String, Object).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateCreator.IFactory

Field Summary

Fields inherited from class nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

localizer, textFactory

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.

Methods inherited from class nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

availableForNonPlayers, availableForPlayers, getCommandSender, getStructure, hasAccessToAttribute, hasPermission, run, startExecution, toString, validInput

Methods inherited from class java.lang.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.validInput() 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.