Package net.kyori.adventure.text

Enum ComponentIteratorFlag

java.lang.Object

java.lang.Enum<ComponentIteratorFlag>

net.kyori.adventure.text.ComponentIteratorFlag

All Implemented Interfaces:

Serializable, Comparable<ComponentIteratorFlag>

@NonExtendable
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)

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 type with the specified name.
static ComponentIteratorFlag[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static ComponentIteratorFlag[] 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 (ComponentIteratorFlag c : ComponentIteratorFlag.values())
    System.out.println(c);

Returns:

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

valueOf

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