Package nl.pim16aap2.animatedarchitecture.core.commands

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

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 nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

localizer, textFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StructureTargetCommand(ICommandSender commandSender, ILocalizer localizer, ITextFactory textFactory, StructureRetriever structureRetriever, StructureAttribute structureAttribute)
protected	StructureTargetCommand(ICommandSender commandSender, ILocalizer localizer, ITextFactory textFactory, 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	getRetrieverResult()	The result of the structureRetriever.
StructureAttribute	getStructureAttribute()
StructureRetriever	getStructureRetriever()
protected void	handleDatabaseActionCancelled()	Called by handleDatabaseActionResult(DatabaseManager.ActionResult) when the database action was cancelled.
protected void	handleDatabaseActionFail()	Called by handleDatabaseActionResult(DatabaseManager.ActionResult) when the database action failed.
protected final void	handleDatabaseActionResult(DatabaseManager.ActionResult result)	Handles the results of a database action by informing the user of any non-success states.
protected void	handleDatabaseActionSuccess()	Called by handleDatabaseActionResult(DatabaseManager.ActionResult) when the database action was successful.
protected boolean	hasRequiredProperties(Structure structure, List<Property<?>> requiredProperties)	Checks if the Structure has all the required properties.
protected boolean	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.
void	setRetrieverResult(@Nullable Structure retrieverResult)	The result of the structureRetriever.

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

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

Field Details

structureRetriever

protected final StructureRetriever structureRetriever

structureAttribute

protected final StructureAttribute structureAttribute

Constructor Details

StructureTargetCommand

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

StructureTargetCommand

protected StructureTargetCommand(ICommandSender commandSender,
 ILocalizer localizer,
 ITextFactory textFactory,
 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.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.

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

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

Parameters:

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

bypassPermission - Whether the ICommandSender has bypass access.

Returns:

True if execution of this command is allowed.

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()

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()

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

handleDatabaseActionSuccess

protected void handleDatabaseActionSuccess()

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

handleDatabaseActionFail

protected void handleDatabaseActionFail()

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

handleDatabaseActionResult

protected final void handleDatabaseActionResult(DatabaseManager.ActionResult result)

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

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

Parameters:

result - The result obtained from the database.

getStructureRetriever

public StructureRetriever getStructureRetriever()

getStructureAttribute

public StructureAttribute getStructureAttribute()

getRetrieverResult

@Nullable
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.

setRetrieverResult

public void setRetrieverResult(@Nullable
 @Nullable Structure retrieverResult)

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.