Package io.github.somesourcecode.someguiapi.scene.lore

Enum Class WrapType

java.lang.Object

java.lang.Enum<WrapType>

io.github.somesourcecode.someguiapi.scene.lore.WrapType

All Implemented Interfaces:

Serializable, Comparable<WrapType>, java.lang.constant.Constable

public enum WrapType
extends Enum<WrapType>

Represents the type of wrapping that should be applied to a paragraph. It determines where the text should be wrapped when it reaches the end of the line.

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHARACTER	Wrapping should be applied at the end of the line, regardless of the position of the last word.
NONE	No wrapping should be applied.
WORD	Wrapping should be applied at the end of the line, but only after the last word.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final WrapType NONE

No wrapping should be applied.

Since:

2.0.0

CHARACTER

public static final WrapType CHARACTER

Wrapping should be applied at the end of the line, regardless of the position of the last word.

Since:

2.0.0

WORD

public static final WrapType WORD

Wrapping should be applied at the end of the line, but only after the last word.

Since:

2.0.0

Method Details

values

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