Package xyz.gmitch215.socketmc.util

Enum Class Arm

java.lang.Object

java.lang.Enum<Arm>

xyz.gmitch215.socketmc.util.Arm

All Implemented Interfaces:

Serializable, Comparable<Arm>, Constable

public enum Arm
extends Enum<Arm>

Represents a player's arm.

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
LEFT	Represents the left arm.
RIGHT	Represents the right arm.

Method Summary

Modifier and Type	Method	Description
static @NotNull Arm	byOrdinal(int ordinal)	Gets the Arm by its ordinal.
@NotNull Arm	opposite()	Returns the opposite arm.
static Arm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Arm[]	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

LEFT

public static final Arm LEFT

Represents the left arm.

RIGHT

public static final Arm RIGHT

Represents the right arm.

Method Details

values

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

opposite

@NotNull
public @NotNull Arm opposite()

Returns the opposite arm.

Returns:

the opposite arm

byOrdinal

@NotNull
public static @NotNull Arm byOrdinal(int ordinal)

Gets the Arm by its ordinal.

Parameters:

ordinal -

Returns:

Arm by ordinal