Package dev.kitteh.factions.permissible

Enum Class PermissibleActions

java.lang.Object

java.lang.Enum<PermissibleActions>

dev.kitteh.factions.permissible.PermissibleActions

All Implemented Interfaces:

PermissibleAction, Serializable, Comparable<PermissibleActions>, Constable

@AvailableSince("4.0.0")
@NullMarked
public enum PermissibleActions
extends Enum<PermissibleActions>
implements PermissibleAction

Default permissible actions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface dev.kitteh.factions.permissible.PermissibleAction

PermissibleAction.Simple, PermissibleAction.WithPrerequisite

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAN
BUILD
BUTTON
CONTAINER
DESTROY
DISBAND
DOOR
ECONOMY
FLY
FROSTWALK
HOME
INVITE
ITEM
KICK
LEVER
LISTCLAIMS
PAINBUILD
PLATE
PROMOTE
SETHOME
SETWARP
SHIELD
TERRITORY
TNTDEPOSIT
TNTWITHDRAW
UPGRADE
WARP
ZONE

Method Summary

Modifier and Type	Method	Description
String	description()	Long description, such as "Opening any block that can store items".
@Nullable Upgrade	prerequisite()	Prerequisite for this permissible action to appear to users, if present.
String	shortDescription()	Short description text, such as "open containers".
String	toString()
static PermissibleActions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PermissibleActions[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.kitteh.factions.permissible.PermissibleAction

name

Enum Constant Details

BUILD

public static final PermissibleActions BUILD

DESTROY

public static final PermissibleActions DESTROY

PAINBUILD

public static final PermissibleActions PAINBUILD

ITEM

public static final PermissibleActions ITEM

CONTAINER

public static final PermissibleActions CONTAINER

BUTTON

public static final PermissibleActions BUTTON

DOOR

public static final PermissibleActions DOOR

LEVER

public static final PermissibleActions LEVER

PLATE

public static final PermissibleActions PLATE

FROSTWALK

public static final PermissibleActions FROSTWALK

INVITE

public static final PermissibleActions INVITE

KICK

public static final PermissibleActions KICK

BAN

public static final PermissibleActions BAN

PROMOTE

public static final PermissibleActions PROMOTE

DISBAND

public static final PermissibleActions DISBAND

ECONOMY

public static final PermissibleActions ECONOMY

TERRITORY

public static final PermissibleActions TERRITORY

HOME

public static final PermissibleActions HOME

SETHOME

public static final PermissibleActions SETHOME

LISTCLAIMS

public static final PermissibleActions LISTCLAIMS

WARP

public static final PermissibleActions WARP

SETWARP

public static final PermissibleActions SETWARP

TNTDEPOSIT

public static final PermissibleActions TNTDEPOSIT

TNTWITHDRAW

public static final PermissibleActions TNTWITHDRAW

SHIELD

public static final PermissibleActions SHIELD

FLY

public static final PermissibleActions FLY

UPGRADE

public static final PermissibleActions UPGRADE

ZONE

public static final PermissibleActions ZONE

Method Details

values

public static PermissibleActions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PermissibleActions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

description

public String description()

Description copied from interface: PermissibleAction

Long description, such as "Opening any block that can store items".

Specified by:

description in interface PermissibleAction

Returns:

description

shortDescription

public String shortDescription()

Description copied from interface: PermissibleAction

Short description text, such as "open containers".

Specified by:

shortDescription in interface PermissibleAction

Returns:

short description

prerequisite

public @Nullable Upgrade prerequisite()

Description copied from interface: PermissibleAction

Prerequisite for this permissible action to appear to users, if present.

Specified by:

prerequisite in interface PermissibleAction

Returns:

prerequisite or null if not present

toString

public String toString()

Overrides:

toString in class Enum<PermissibleActions>