Package dev.kitteh.factions.integration.permcontext

Enum Class Contexts

java.lang.Object

java.lang.Enum<Contexts>

dev.kitteh.factions.integration.permcontext.Contexts

All Implemented Interfaces:

Context, Serializable, Comparable<Contexts>, Constable

@NullMarked
public enum Contexts
extends Enum<Contexts>
implements Context

Default FactionsUUID contexts.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FACTION_ID
IS_PEACEFUL
IS_PERMANENT
ROLE_AT_LEAST
ROLE_AT_MOST
TERRITORY_ID
TERRITORY_IS_SAFEZONE
TERRITORY_IS_WARZONE
TERRITORY_IS_WILDERNESS
TERRITORY_RELATION

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FACTIONSUUID_NAMESPACE	The FactionsUUID namespace.

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the context name, without any namespacing.
String	getNamespace()	Gets the namespace for this context.
Set<String>	getPossibleValues()	Gets known possible values for the context.
Set<String>	getValues(org.bukkit.entity.Player player)	Gets the values for a given player at this moment in time.
static Contexts	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Contexts[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.kitteh.factions.integration.permcontext.Context

getNamespacedName

Enum Constant Details

FACTION_ID

public static final Contexts FACTION_ID

IS_PEACEFUL

public static final Contexts IS_PEACEFUL

IS_PERMANENT

public static final Contexts IS_PERMANENT

TERRITORY_RELATION

public static final Contexts TERRITORY_RELATION

TERRITORY_IS_SAFEZONE

public static final Contexts TERRITORY_IS_SAFEZONE

TERRITORY_IS_WILDERNESS

public static final Contexts TERRITORY_IS_WILDERNESS

TERRITORY_IS_WARZONE

public static final Contexts TERRITORY_IS_WARZONE

TERRITORY_ID

public static final Contexts TERRITORY_ID

ROLE_AT_LEAST

public static final Contexts ROLE_AT_LEAST

ROLE_AT_MOST

public static final Contexts ROLE_AT_MOST

Field Details

FACTIONSUUID_NAMESPACE

public static final String FACTIONSUUID_NAMESPACE

The FactionsUUID namespace. Should not be used by another plugin.

See Also:

• Constant Field Values

Method Details

values

public static Contexts[] 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 Contexts 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

getName

public String getName()

Description copied from interface: Context

Gets the context name, without any namespacing. Format should be lowercase words separated by hyphens (-).

Specified by:

getName in interface Context

Returns:

name

getNamespace

public String getNamespace()

Description copied from interface: Context

Gets the namespace for this context. Namespaces should be the plugin name, lowercased. Other plugins using this class should not use factionsuuid as their namespace.

Specified by:

getNamespace in interface Context

Returns:

namespace

getPossibleValues

public Set<String> getPossibleValues()

Description copied from interface: Context

Gets known possible values for the context.

Specified by:

getPossibleValues in interface Context

Returns:

immutable set of possible values

getValues

public Set<String> getValues(org.bukkit.entity.Player player)

Description copied from interface: Context

Gets the values for a given player at this moment in time.

Specified by:

getValues in interface Context

Parameters:

player - player

Returns:

immutable set of current values