Enum Class SwapMode

java.lang.Object

java.lang.Enum<SwapMode>

com.hammy275.immersivemc.api.common.immersive.SwapMode

All Implemented Interfaces:

Serializable, Comparable<SwapMode>, Constable

public enum SwapMode
extends Enum<SwapMode>

The type of swap that should be performed. Found as part of ItemSwapAmount for how many items to swap into and/or out of an Immersive.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Swap as many items as possible.
CONSTANT	Swap a constant number of items.
SINGLE	Only swap one item.
SPLIT	Swap the held stack, split evenly into multiple slots.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINGLE

public static final SwapMode SINGLE

Only swap one item.

SPLIT

public static final SwapMode SPLIT

Swap the held stack, split evenly into multiple slots.

ALL

public static final SwapMode ALL

Swap as many items as possible.

CONSTANT

public static final SwapMode CONSTANT

Swap a constant number of items.

Method Details

values

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