Enum Class ItemTranslationContext

java.lang.Object

java.lang.Enum<ItemTranslationContext>

com.github.darksoulq.abyssallib.server.translation.ItemTranslationContext

All Implemented Interfaces:

Serializable, Comparable<ItemTranslationContext>, Constable

public enum ItemTranslationContext
extends Enum<ItemTranslationContext>

Represents the context in which an item's component is being translated.

This allows translation providers to differentiate between an item's default name, a player-set custom name, or lines within the item's lore.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM_NAME	Indicates that the custom, player-set name of the item is being translated.
LORE	Indicates that a line within the item's lore is being translated.
NAME	Indicates that the default, unedited name of the item is being translated.

Method Summary

Modifier and Type	Method	Description
static ItemTranslationContext	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ItemTranslationContext[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NAME

public static final ItemTranslationContext NAME

Indicates that the default, unedited name of the item is being translated.

CUSTOM_NAME

public static final ItemTranslationContext CUSTOM_NAME

Indicates that the custom, player-set name of the item is being translated.

LORE

public static final ItemTranslationContext LORE

Indicates that a line within the item's lore is being translated.

Method Details

values

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