me.lucko.luckperms.api

Enum ChatMetaType

java.lang.Object

java.lang.Enum<ChatMetaType>

me.lucko.luckperms.api.ChatMetaType

All Implemented Interfaces:

Serializable, Comparable<ChatMetaType>

public enum ChatMetaType
extends Enum<ChatMetaType>

Represents a type of chat meta

Since:

3.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
PREFIX Represents a prefix
SUFFIX Represents a suffix

Method Summary

Modifier and Type	Method and Description
abstract Map.Entry<Integer,String>	getEntry(@NonNull Node node) Maps the corresponding entry from the given node
abstract boolean	matches(@NonNull Node node) Returns if the passed node matches the type
static @NonNull Optional<ChatMetaType>	ofNode(@NonNull Node node) Parses a ChatMetaType from the given node.
boolean	shouldIgnore(@NonNull Node node) Returns if the passed node should be ignored when searching for meta of this type
String	toString()
static ChatMetaType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChatMetaType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PREFIX

public static final ChatMetaType PREFIX

Represents a prefix

SUFFIX

public static final ChatMetaType SUFFIX

Represents a suffix

Method Detail

values

public static ChatMetaType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChatMetaType c : ChatMetaType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChatMetaType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

matches

public abstract boolean matches(@NonNull Node node)

Returns if the passed node matches the type

Parameters:

node - the node to test

Returns:

true if the node has the same type

shouldIgnore

public boolean shouldIgnore(@NonNull Node node)

Returns if the passed node should be ignored when searching for meta of this type

Parameters:

node - the node to test

Returns:

true if the node does not share the same type

getEntry

public abstract Map.Entry<Integer,String> getEntry(@NonNull Node node)

Maps the corresponding entry from the given node

Parameters:

node - the node to retrieve the entry from

Returns:

the entry

Throws:

IllegalStateException - if the node does not share the same type

toString

public String toString()

Overrides:

toString in class Enum<ChatMetaType>

ofNode

public static @NonNull Optional<ChatMetaType> ofNode(@NonNull Node node)

Parses a ChatMetaType from the given node.

Parameters:

node - the node

Returns:

the parsed chat meta type

Since:

3.4