Class Lock

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.StructureTargetCommand

nl.pim16aap2.animatedarchitecture.core.commands.Lock

public class Lock
extends StructureTargetCommand

Represents the command that is used to change whether a structure is locked.

Nested Class Summary

Nested classes/interfaces inherited from class StructureTargetCommand

StructureTargetCommand.StructureDescription

Field Summary

Fields inherited from class StructureTargetCommand

structureAttribute, structureRetriever

Fields inherited from class BaseCommand

executor, localizer

Method Summary

Modifier and Type	Method	Description
CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
protected void	handleDatabaseActionSuccess(@Nullable Structure retrieverResult)	Called by StructureTargetCommand.handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action was successful.
protected CompletableFuture<?>	performAction(Structure structure)	Performs the action of this command on the Structure.
@NonNull String	toString()

Methods inherited from class StructureTargetCommand

executeCommand, getRequiredProperties, getRetrievedStructureDescription, getRetrievedStructureDescription, getRetrieverResult, getStructureAttribute, getStructureRetriever, handleDatabaseActionCancelled, handleDatabaseActionFail, handleDatabaseActionResult, hasRequiredProperties, isAllowed, notifyMissingProperties, sendUpdatedInfo

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

handleDatabaseActionSuccess

protected void handleDatabaseActionSuccess(@Nullable Structure retrieverResult)

Description copied from class: StructureTargetCommand

Called by StructureTargetCommand.handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action was successful.

Overrides:

handleDatabaseActionSuccess in class StructureTargetCommand

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.

performAction

protected CompletableFuture<?> performAction(Structure structure)

Description copied from class: StructureTargetCommand

Performs the action of this command on the Structure.

Specified by:

performAction in class StructureTargetCommand

Parameters:

structure - The Structure to perform the action on.

Returns:

The future of the command execution.

toString

public @NonNull String toString()

Overrides:

toString in class StructureTargetCommand