Package net.kyori.adventure.platform.fabric

Enum Class ComponentArgumentType.Format

java.lang.Object

java.lang.Enum<ComponentArgumentType.Format>

net.kyori.adventure.platform.fabric.ComponentArgumentType.Format

All Implemented Interfaces:

Serializable, Comparable<ComponentArgumentType.Format>, Constable

Enclosing class:

ComponentArgumentType

public static enum ComponentArgumentType.Format
extends Enum<ComponentArgumentType.Format>

Supported text formats for registering components.

Since:

5.1.0

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
JSON
MINIMESSAGE

Field Summary

Fields

Modifier and Type	Field	Description
static final Index<Key,ComponentArgumentType.Format>	INDEX

Method Summary

Modifier and Type	Method	Description
List<String>	examples()	Get examples of this format in use.
Key	id()	Get a unique identifier for this format.
static ComponentArgumentType.Format	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ComponentArgumentType.Format[]	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

Enum Constant Details

JSON

public static final ComponentArgumentType.Format JSON

MINIMESSAGE

public static final ComponentArgumentType.Format MINIMESSAGE

Field Details

INDEX

public static final Index<Key,ComponentArgumentType.Format> INDEX

Method Details

values

public static ComponentArgumentType.Format[] 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 ComponentArgumentType.Format 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

id

public Key id()

Get a unique identifier for this format.

Returns:

a unique identifier for this format

Since:

5.1.0

examples

public List<String> examples()

Get examples of this format in use.

Returns:

examples of this format in use, as an unmodifiable list

Since:

5.1.0