Class CommandDefinition

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.CommandDefinition

public final class CommandDefinition
extends Object

Represents the various commands that are used along with their user/admin permission nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandDefinition	ADD_OWNER
static final CommandDefinition	CANCEL
static final CommandDefinition	CONFIRM
static final CommandDefinition	DEBUG
static final CommandDefinition	DELETE
static final CommandDefinition	INFO
static final CommandDefinition	INSPECT_POWER_BLOCK
static final CommandDefinition	LIST_STRUCTURES
static final CommandDefinition	LOCK
static final CommandDefinition	MENU
static final CommandDefinition	MOVE_POWER_BLOCK
static final CommandDefinition	NEW_STRUCTURE
static final CommandDefinition	REMOVE_OWNER
static final CommandDefinition	RESTART
static final CommandDefinition	SET_BLOCKS_TO_MOVE
static final CommandDefinition	SET_NAME
static final CommandDefinition	SET_OPEN_DIRECTION
static final CommandDefinition	SET_OPEN_STATUS
static final CommandDefinition	SET_PROPERTY
static final CommandDefinition	SPECIFY
static final CommandDefinition	STOP_STRUCTURES
static final CommandDefinition	TOGGLE
static final CommandDefinition	UPDATE_CREATOR
static final CommandDefinition	VERSION

Constructor Summary

Constructors

Constructor	Description
CommandDefinition(String name, @Nullable String userPermission, @Nullable String adminPermission)

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
Optional<String>	getAdminPermission()
String	getLowestPermission()	Retrieves the lowest permissions level of the current command.
String	getName()
Optional<String>	getUserPermission()
int	hashCode()
@NonNull String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ADD_OWNER

public static final CommandDefinition ADD_OWNER

CANCEL

public static final CommandDefinition CANCEL

CONFIRM

public static final CommandDefinition CONFIRM

DEBUG

public static final CommandDefinition DEBUG

DELETE

public static final CommandDefinition DELETE

INFO

public static final CommandDefinition INFO

INSPECT_POWER_BLOCK

public static final CommandDefinition INSPECT_POWER_BLOCK

LIST_STRUCTURES

public static final CommandDefinition LIST_STRUCTURES

LOCK

public static final CommandDefinition LOCK

MENU

public static final CommandDefinition MENU

MOVE_POWER_BLOCK

public static final CommandDefinition MOVE_POWER_BLOCK

NEW_STRUCTURE

public static final CommandDefinition NEW_STRUCTURE

REMOVE_OWNER

public static final CommandDefinition REMOVE_OWNER

RESTART

public static final CommandDefinition RESTART

SET_BLOCKS_TO_MOVE

public static final CommandDefinition SET_BLOCKS_TO_MOVE

SET_NAME

public static final CommandDefinition SET_NAME

SET_PROPERTY

public static final CommandDefinition SET_PROPERTY

SET_OPEN_DIRECTION

public static final CommandDefinition SET_OPEN_DIRECTION

SET_OPEN_STATUS

public static final CommandDefinition SET_OPEN_STATUS

SPECIFY

public static final CommandDefinition SPECIFY

STOP_STRUCTURES

public static final CommandDefinition STOP_STRUCTURES

TOGGLE

public static final CommandDefinition TOGGLE

UPDATE_CREATOR

public static final CommandDefinition UPDATE_CREATOR

VERSION

public static final CommandDefinition VERSION

Constructor Details

CommandDefinition

public CommandDefinition(String name,
 @Nullable String userPermission,
 @Nullable String adminPermission)

Method Details

getLowestPermission

public String getLowestPermission()

Retrieves the lowest permissions level of the current command.

Returns:

The lowest permission level available. If the command has both a user and an admin permission, the user permission will be returned. If it only has an admin permission, that will be returned instead.

Throws:

NullPointerException - When this command has neither a user permission nor an admin permission.

toString

public @NonNull String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

getUserPermission

public Optional<String> getUserPermission()

getAdminPermission

public Optional<String> getAdminPermission()