Class StructureTargetCommand

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.StructureTargetCommand

Direct Known Subclasses:

AddOwner, Delete, Info, Lock, MovePowerBlock, RemoveOwner, SetBlocksToMove, SetOpenDirection, SetOpenStatus, SetProperty

public abstract class StructureTargetCommand
extends BaseCommand

Represents a command that relates to an existing structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	StructureTargetCommand.StructureDescription	A simple description of a structure.

Field Summary

Fields

Modifier and Type	Field	Description
protected final StructureAttribute	structureAttribute
protected final StructureRetriever	structureRetriever

Fields inherited from class BaseCommand

executor, localizer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StructureTargetCommand(ICommandSender commandSender, IExecutor executor, StructureRetriever structureRetriever, StructureAttribute structureAttribute)
protected	StructureTargetCommand(ICommandSender commandSender, IExecutor executor, StructureRetriever structureRetriever, StructureAttribute structureAttribute, boolean sendUpdatedInfo, @Nullable CommandFactory commandFactory)

Method Summary

Modifier and Type	Method	Description
protected final CompletableFuture<?>	executeCommand(PermissionsStatus permissions)	Executes the command.
protected List<Property<?>>	getRequiredProperties()	Gets all required properties for this command.
protected final StructureTargetCommand.StructureDescription	getRetrievedStructureDescription(@Nullable Structure retrieverResult)	Gets the structure description of the retrieverResult.
protected final StructureTargetCommand.StructureDescription	getRetrievedStructureDescription(@Nullable Structure retrieverResult, IMessageable messageable)	Gets the structure description of the retrieverResult.
@Nullable Structure	getRetrieverResult()	The result of the structureRetriever.
StructureAttribute	getStructureAttribute()
StructureRetriever	getStructureRetriever()
protected void	handleDatabaseActionCancelled(Structure retrieverResult)	Called by handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action was cancelled.
protected void	handleDatabaseActionFail(Structure retrieverResult)	Called by handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action failed.
protected final void	handleDatabaseActionResult(DatabaseManager.ActionResult result, Structure structure)	Handles the results of a database action by informing the user of any non-success states.
protected void	handleDatabaseActionSuccess(Structure retrieverResult)	Called by handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action was successful.
protected boolean	hasRequiredProperties(Structure structure, List<Property<?>> requiredProperties)	Checks if the Structure has all the required properties.
protected void	isAllowed(Structure structure, boolean bypassPermission)	Checks if execution of this command is allowed for the given Structure.
protected void	notifyMissingProperties(Structure structure)	Notifies the ICommandSender that the targeted Structure is missing required properties.
protected abstract CompletableFuture<?>	performAction(Structure structure)	Performs the action of this command on the Structure.
protected void	sendUpdatedInfo(Structure structure)	Sends the updated info of the structure to the ICommandSender.
@NonNull String	toString()

Methods inherited from class BaseCommand

availableForNonPlayers, availableForPlayers, getCommand, 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

structureRetriever

protected final StructureRetriever structureRetriever

structureAttribute

protected final StructureAttribute structureAttribute

Constructor Details

StructureTargetCommand

@Contract("_, _, _, _, true, null -> fail")
protected StructureTargetCommand(ICommandSender commandSender,
 IExecutor executor,
 StructureRetriever structureRetriever,
 StructureAttribute structureAttribute,
 boolean sendUpdatedInfo,
 @Nullable CommandFactory commandFactory)

StructureTargetCommand

protected StructureTargetCommand(ICommandSender commandSender,
 IExecutor executor,
 StructureRetriever structureRetriever,
 StructureAttribute structureAttribute)

Method Details

executeCommand

protected final 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.

sendUpdatedInfo

protected void sendUpdatedInfo(Structure structure)

Sends the updated info of the structure to the ICommandSender.

Only applies if sendUpdatedInfo is true.

Parameters:

structure - The structure to send the updated info of.

notifyMissingProperties

protected void notifyMissingProperties(Structure structure)

Notifies the ICommandSender that the targeted Structure is missing required properties.

Parameters:

structure - The Structure that is missing the required properties.

isAllowed

protected void isAllowed(Structure structure,
 boolean bypassPermission)
                  throws CommandExecutionException

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

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

Parameters:

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

bypassPermission - Whether the ICommandSender has bypass access.

Throws:

CommandExecutionException - If the ICommandSender is not allowed to perform the action on the Structure.

hasRequiredProperties

protected boolean hasRequiredProperties(Structure structure,
 List<Property<?>> requiredProperties)

Checks if the Structure has all the required properties.

See Structure.hasProperties(Collection).

Parameters:

structure - The Structure to check.

requiredProperties - The required properties.

Returns:

True if the Structure has all the required properties.

performAction

protected abstract CompletableFuture<?> performAction(Structure structure)

Performs the action of this command on the Structure.

Parameters:

structure - The Structure to perform the action on.

Returns:

The future of the command execution.

getRetrievedStructureDescription

protected final StructureTargetCommand.StructureDescription getRetrievedStructureDescription(@Nullable Structure retrieverResult)

Gets the structure description of the retrieverResult.

This is a shortcut for getRetrievedStructureDescription(Structure, IMessageable) with BaseCommand.getCommandSender() as the IMessageable.

Parameters:

retrieverResult - The Structure that was retrieved.

Returns:

The structure description of the retrieverResult.

getRetrievedStructureDescription

protected final StructureTargetCommand.StructureDescription getRetrievedStructureDescription(@Nullable Structure retrieverResult,
 IMessageable messageable)

Gets the structure description of the retrieverResult.

Parameters:

retrieverResult - The Structure that was retrieved.

messageable - The IMessageable to use for localization.

Returns:

The structure description of the retrieverResult.

getRequiredProperties

protected List<Property<?>> getRequiredProperties()

Gets all required properties for this command.

If targeted structure does not have all required properties, the command will not be executed.

By default, this returns an empty list. Subclasses that require specific properties should override this method.

Returns:

A list of all required properties.

handleDatabaseActionCancelled

protected void handleDatabaseActionCancelled(Structure retrieverResult)

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

handleDatabaseActionSuccess

protected void handleDatabaseActionSuccess(Structure retrieverResult)

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

handleDatabaseActionFail

protected void handleDatabaseActionFail(Structure retrieverResult)

Called by handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action failed.

handleDatabaseActionResult

protected final void handleDatabaseActionResult(DatabaseManager.ActionResult result,
 Structure structure)

Handles the results of a database action by informing the user of any non-success states.

To customize the handling, you can override handleDatabaseActionFail(Structure), handleDatabaseActionCancelled(Structure), or handleDatabaseActionSuccess(Structure).

Parameters:

result - The result obtained from the database.

structure - The structure that was the target of the command.

toString

public @NonNull String toString()

Overrides:

toString in class BaseCommand

getStructureRetriever

public StructureRetriever getStructureRetriever()

getStructureAttribute

public StructureAttribute getStructureAttribute()

getRetrieverResult

public @Nullable Structure getRetrieverResult()

The result of the structureRetriever.

This will not be available until after executeCommand(PermissionsStatus) has started, but before performAction(Structure) is called.

Even after the result has been set, it may still be null in case no doors were found.