Enum Class JSONOptions.HoverEventValueMode

java.lang.Object

java.lang.Enum<JSONOptions.HoverEventValueMode>

net.kyori.adventure.text.serializer.json.JSONOptions.HoverEventValueMode

All Implemented Interfaces:

Serializable, Comparable<JSONOptions.HoverEventValueMode>, Constable

Enclosing class:

JSONOptions

public static enum JSONOptions.HoverEventValueMode
extends Enum<JSONOptions.HoverEventValueMode>

Configure how to emit hover event values.

Since:

4.15.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Include all hover event fields, for maximum compatibility.
CAMEL_CASE	Only emit the 1.16+ hover events using the hoverEvent field.
SNAKE_CASE	Only emit the 1.21.5+ hover events using the hover_event field.
VALUE_FIELD	Only emit the pre-1.16 hover event value field.

Method Summary

Modifier and Type	Method	Description
static JSONOptions.HoverEventValueMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JSONOptions.HoverEventValueMode[]	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

SNAKE_CASE

public static final JSONOptions.HoverEventValueMode SNAKE_CASE

Only emit the 1.21.5+ hover events using the hover_event field.

Since:

4.20.0

CAMEL_CASE

public static final JSONOptions.HoverEventValueMode CAMEL_CASE

Only emit the 1.16+ hover events using the hoverEvent field.

Since:

4.15.0

VALUE_FIELD

public static final JSONOptions.HoverEventValueMode VALUE_FIELD

Only emit the pre-1.16 hover event value field.

Since:

4.15.0

ALL

public static final JSONOptions.HoverEventValueMode ALL

Include all hover event fields, for maximum compatibility.

Since:

4.15.0

Method Details

values

public static JSONOptions.HoverEventValueMode[] 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 JSONOptions.HoverEventValueMode 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