Package nl.pim16aap2.animatedarchitecture.core.commands

Class AddOwner

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.StructureTargetCommand

nl.pim16aap2.animatedarchitecture.core.commands.AddOwner

public class AddOwner
extends StructureTargetCommand

Represents the command that adds co-owners to a given structure.

Nested Class Summary

Nested classes/interfaces inherited from class nl.pim16aap2.animatedarchitecture.core.commands.StructureTargetCommand

StructureTargetCommand.StructureDescription

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandDefinition	COMMAND_DEFINITION
protected static final PermissionLevel	DEFAULT_PERMISSION_LEVEL	The default value to use for targetPermissionLevel when none is specified.

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

structureAttribute, structureRetriever

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

localizer, textFactory

Method Summary

Modifier and Type	Method	Description
CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
protected void	handleDatabaseActionSuccess()	Called by StructureTargetCommand.handleDatabaseActionResult(DatabaseManager.ActionResult) when the database action was successful.
protected boolean	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.
String	toString()
protected boolean	validInput()	Checks if the input is valid before starting any potentially expensive tasks.

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Details

COMMAND_DEFINITION

public static final CommandDefinition COMMAND_DEFINITION

DEFAULT_PERMISSION_LEVEL

protected static final PermissionLevel DEFAULT_PERMISSION_LEVEL

The default value to use for targetPermissionLevel when none is specified.

Method Details

handleDatabaseActionSuccess

protected void handleDatabaseActionSuccess()

Description copied from class: StructureTargetCommand

Called by StructureTargetCommand.handleDatabaseActionResult(DatabaseManager.ActionResult) 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.

validInput

protected boolean validInput()

Description copied from class: BaseCommand

Checks if the input is valid before starting any potentially expensive tasks.

Overrides:

validInput in class BaseCommand

Returns:

True if the input is valid.

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 boolean isAllowed(Structure structure,
 boolean hasBypassPermission)

Description copied from class: StructureTargetCommand

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

Overrides:

isAllowed in class StructureTargetCommand

Parameters:

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

hasBypassPermission - Whether the ICommandSender has bypass access.

Returns:

True if execution of this command is allowed.

toString

public String toString()

Overrides:

toString in class BaseCommand