Enum Class PlaceholderType

java.lang.Object

java.lang.Enum<PlaceholderType>

io.github.miniplaceholders.api.types.PlaceholderType

All Implemented Interfaces:

Serializable, Comparable<PlaceholderType>, Constable

public enum PlaceholderType
extends Enum<PlaceholderType>

Type of Placeholder.

Since:

3.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUDIENCE	The audience placeholder type.
GLOBAL	The global placeholder type.
RELATIONAL	The relational placeholder type.

Method Summary

Modifier and Type	Method	Description
static PlaceholderType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlaceholderType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GLOBAL

public static final PlaceholderType GLOBAL

The global placeholder type.
It does not require any type of audience to operate.

AUDIENCE

public static final PlaceholderType AUDIENCE

The audience placeholder type.
Obtains information from a provided audience.

RELATIONAL

public static final PlaceholderType RELATIONAL

The relational placeholder type.
Requires 2 audiences to work, these audiences need to be of the same type.

Method Details

values

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