Class RemoveOwner

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.StructureTargetCommand

nl.pim16aap2.animatedarchitecture.core.commands.RemoveOwner

public class RemoveOwner
extends StructureTargetCommand

Represents the remove owner command. This command is used to remove owners from a structure.

Nested Class Summary

Nested classes/interfaces inherited from class StructureTargetCommand

StructureTargetCommand.StructureDescription

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandDefinition	COMMAND_DEFINITION

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 void	isAllowed(Structure structure, boolean hasBypassPermission)	Checks if execution of this command is allowed for the given Structure.
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, 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

Field Details

COMMAND_DEFINITION

public static final CommandDefinition COMMAND_DEFINITION

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.

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

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.

isAllowed

protected void isAllowed(Structure structure,
 boolean hasBypassPermission)

Description copied from class: StructureTargetCommand

Checks if execution of this command is allowed for the given Structure.

If it is not allowed, an exception will be thrown.

Overrides:

isAllowed in class StructureTargetCommand

Parameters:

structure - The Structure that is the target for this command.

hasBypassPermission - Whether the ICommandSender has bypass access.

toString

public @NonNull String toString()

Overrides:

toString in class StructureTargetCommand