Package io.github.cottonmc.cotton.gui.widget.data

Enum Class Axis

java.lang.Object

java.lang.Enum<Axis>

io.github.cottonmc.cotton.gui.widget.data.Axis

All Implemented Interfaces:

Serializable, Comparable<Axis>, Constable

public enum Axis
extends Enum<Axis>

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
HORIZONTAL
VERTICAL

Method Summary

Modifier and Type	Method	Description
<T> T	choose(T horizontal, T vertical)	Chooses a value based on this axis.
static Axis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Axis[]	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

HORIZONTAL

public static final Axis HORIZONTAL

VERTICAL

public static final Axis VERTICAL

Method Details

values

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

choose

public <T> T choose(T horizontal,
 T vertical)

Chooses a value based on this axis.

Type Parameters:

T - the type of the value

Parameters:

horizontal - the value returned if this axis is horizontal

vertical - the value returned if this axis is vertical

Returns:

the corresponding value for this axis