Package nl.pim16aap2.animatedarchitecture.core.commands

Class BaseCommand

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

Direct Known Subclasses:

Cancel, Confirm, Debug, InspectPowerBlock, ListStructures, Menu, NewStructure, Restart, SetName, Specify, StopStructures, StructureTargetCommand, UpdateCreator, Version

public abstract class BaseCommand
extends Object

Represents the base AnimatedArchitecture command.

This handles all the basics shared by all commands and contains some utility methods for common actions.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ILocalizer	localizer
protected final ITextFactory	textFactory

Constructor Summary

Constructors

Constructor	Description
BaseCommand(ICommandSender commandSender, ILocalizer localizer, ITextFactory textFactory)

Method Summary

Modifier and Type	Method	Description
protected boolean	availableForNonPlayers()	Checks if this BaseCommand is available for non-IPlayers (e.g. the server).
protected boolean	availableForPlayers()	Checks if this BaseCommand is available for IPlayers.
protected abstract CompletableFuture<?>	executeCommand(PermissionsStatus permissions)	Executes the command.
abstract CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
ICommandSender	getCommandSender()	The entity (e.g. player, server, or command block) that initiated the command.
protected CompletableFuture<Optional<Structure>>	getStructure(StructureRetriever doorRetriever, PermissionLevel permissionLevel)	Attempts to get an Structure based on the provided StructureRetrieverFactory and the current ICommandSender.
protected boolean	hasAccessToAttribute(Structure door, StructureAttribute doorAttribute, boolean hasBypassPermission)	Checks if the commandSender has access to a given StructureAttribute for a given structure.
protected CompletableFuture<PermissionsStatus>	hasPermission()	Checks if the ICommandSender has the required permissions to use this command.
final CompletableFuture<?>	run()	Executes the command.
protected final CompletableFuture<?>	startExecution()	Starts the execution of this command.
String	toString()
protected boolean	validInput()	Checks if the input is valid before starting any potentially expensive tasks.

Methods inherited from class java.lang.Object

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

Field Details

localizer

protected final ILocalizer localizer

textFactory

protected final ITextFactory textFactory

Constructor Details

BaseCommand

public BaseCommand(ICommandSender commandSender,
 ILocalizer localizer,
 ITextFactory textFactory)

Method Details

getCommand

public abstract CommandDefinition getCommand()

Gets the CommandDefinition that contains the definition of this BaseCommand.

Returns:

The CommandDefinition that contains the definition of this BaseCommand.

validInput

protected boolean validInput()

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

Returns:

True if the input is valid.

hasAccessToAttribute

protected boolean hasAccessToAttribute(Structure door,
 StructureAttribute doorAttribute,
 boolean hasBypassPermission)

Checks if the commandSender has access to a given StructureAttribute for a given structure.

Parameters:

door - The structure to check.

doorAttribute - The StructureAttribute to check.

hasBypassPermission - Whether the commandSender has bypass permission or not.

Returns:

True if the command sender has access to the provided attribute for the given structure.

availableForPlayers

protected boolean availableForPlayers()

Checks if this BaseCommand is available for IPlayers.

Returns:

True if an IPlayer can execute this command.

availableForNonPlayers

protected boolean availableForNonPlayers()

Checks if this BaseCommand is available for non-IPlayers (e.g. the server).

Returns:

True if a non-IPlayer can execute this command.

run

public final CompletableFuture<?> run()

Executes the command.

Returns:

The result of the execution.

startExecution

protected final CompletableFuture<?> startExecution()

Starts the execution of this command. It performs the permission check (See hasPermission()) and runs executeCommand(PermissionsStatus) if the ICommandSender has access to either the user or the admin permission.

executeCommand

protected abstract CompletableFuture<?> executeCommand(PermissionsStatus permissions)

Executes the command. This method is only called if validInput() and hasPermission() are true.

Note that this method is called asynchronously.

Parameters:

permissions - Whether the ICommandSender has user and/or admin permissions.

Returns:

The future of the command execution.

getStructure

protected CompletableFuture<Optional<Structure>> getStructure(StructureRetriever doorRetriever,
 PermissionLevel permissionLevel)

Attempts to get an Structure based on the provided StructureRetrieverFactory and the current ICommandSender.

If no structure is found, the ICommandSender will be informed.

Parameters:

doorRetriever - The StructureRetrieverFactory to use

permissionLevel - The minimum PermissionLevel required to retrieve the structure.

Returns:

The Structure if one could be retrieved.

hasPermission

protected CompletableFuture<PermissionsStatus> hasPermission()

Checks if the ICommandSender has the required permissions to use this command. See CommandDefinition.getUserPermission() and CommandDefinition.getAdminPermission().

Returns:

A pair of booleans that indicates whether the user has access to the user and admin permission nodes respectively. For both, true indicates that they do have access to the node and false that they do not.

toString

public String toString()

Overrides:

toString in class Object

getCommandSender

public ICommandSender getCommandSender()

The entity (e.g. player, server, or command block) that initiated the command.

This is the entity that is held responsible for the command (i.e. their permissions are checked, and they will receive error/success/information messages when applicable).