Package com.refinedmods.refinedstorage.api.storage

Enum Class StorageState

java.lang.Object

java.lang.Enum<StorageState>

com.refinedmods.refinedstorage.api.storage.StorageState

All Implemented Interfaces:

Serializable, Comparable<StorageState>, Constable

@API(status=STABLE,
     since="2.0.0-milestone.3.3")
public enum StorageState
extends Enum<StorageState>

The storage state can be cached and obtained by StateTrackedStorage.

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
FULL	The storage is active and full.
INACTIVE	There is a storage present in the container, but the container is inactive.
NEAR_CAPACITY	The storage is active and has less than 25% capacity left.
NONE	There is no storage in the container.
NORMAL	The storage is active and has enough capacity to store more resources.

Method Summary

Modifier and Type	Method	Description
static StorageState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StorageState[]	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 StorageState NONE

There is no storage in the container.

INACTIVE

public static final StorageState INACTIVE

There is a storage present in the container, but the container is inactive.

NORMAL

public static final StorageState NORMAL

The storage is active and has enough capacity to store more resources.

NEAR_CAPACITY

public static final StorageState NEAR_CAPACITY

The storage is active and has less than 25% capacity left.

FULL

public static final StorageState FULL

The storage is active and full.

Method Details

values

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