net.kyori.text.event

Enum HoverEvent.Action

java.lang.Object

java.lang.Enum<HoverEvent.Action>

net.kyori.text.event.HoverEvent.Action

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HoverEvent.Action>

Enclosing class:

HoverEvent

public static enum HoverEvent.Action
extends java.lang.Enum<HoverEvent.Action>

An enumeration of hover event actions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SHOW_ENTITY Shows an entity when hovered over.
SHOW_ITEM Shows an item instance when hovered over.
SHOW_TEXT Shows a Component when hovered over.

Field Summary

Fields

Modifier and Type	Field and Description
static NameMap<HoverEvent.Action>	NAMES The name map.

Method Summary

Modifier and Type	Method and Description
boolean	readable() Tests if this action is readable.
@NonNull java.lang.String	toString()
static HoverEvent.Action	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HoverEvent.Action[]	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

SHOW_TEXT

public static final HoverEvent.Action SHOW_TEXT

Shows a Component when hovered over.

SHOW_ITEM

public static final HoverEvent.Action SHOW_ITEM

Shows an item instance when hovered over.

SHOW_ENTITY

public static final HoverEvent.Action SHOW_ENTITY

Shows an entity when hovered over.

Field Detail

NAMES

public static final NameMap<HoverEvent.Action> NAMES

The name map.

Method Detail

values

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

Returns:

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

valueOf

public static HoverEvent.Action valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

readable

public boolean readable()

Tests if this action is readable.

Returns:

true if this action is readable, false if this action is not readable

toString

public @NonNull java.lang.String toString()

Overrides:

toString in class java.lang.Enum<HoverEvent.Action>