Enum Class ComponentIteratorFlag

java.lang.Object

java.lang.Enum<ComponentIteratorFlag>

net.kyori.adventure.text.ComponentIteratorFlag

All Implemented Interfaces:

Serializable, Comparable<ComponentIteratorFlag>, Constable

public enum ComponentIteratorFlag
extends Enum<ComponentIteratorFlag>

Flags to modify the behaviour of a component iterator.

Since:

4.9.0

See Also:

• Component.iterator(ComponentIteratorType, java.util.Set)
• Component.iterable(ComponentIteratorType, java.util.Set)
• Component.spliterator(ComponentIteratorType, java.util.Set)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCLUDE_HOVER_SHOW_ENTITY_NAME	Includes the name of entities inside entity hover events.
INCLUDE_HOVER_SHOW_TEXT_COMPONENT	Includes the components inside text hover events.
INCLUDE_TRANSLATABLE_COMPONENT_ARGUMENTS	Includes the arguments of translatable components.

Method Summary

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

INCLUDE_HOVER_SHOW_ENTITY_NAME

public static final ComponentIteratorFlag INCLUDE_HOVER_SHOW_ENTITY_NAME

Includes the name of entities inside entity hover events.

Since:

4.9.0

INCLUDE_HOVER_SHOW_TEXT_COMPONENT

public static final ComponentIteratorFlag INCLUDE_HOVER_SHOW_TEXT_COMPONENT

Includes the components inside text hover events.

Since:

4.9.0

INCLUDE_TRANSLATABLE_COMPONENT_ARGUMENTS

public static final ComponentIteratorFlag INCLUDE_TRANSLATABLE_COMPONENT_ARGUMENTS

Includes the arguments of translatable components.

Since:

4.9.0

Method Details

values

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