Package org.spongepowered.api.world.volume

Enum Class StorageType

java.lang.Object

java.lang.Enum<StorageType>

org.spongepowered.api.world.volume.StorageType

All Implemented Interfaces:

Serializable, Comparable<StorageType>, Constable

public enum StorageType
extends Enum<StorageType>

Storage types that can be used for storing blocks and biomes. These are used when obtaining new copies. Storage obtained from the implementation should be assumed to be STANDARD unless specified otherwise.

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
STANDARD	The standard storage method used by the implementation.
THREAD_SAFE	A thread-safe storage solution.

Method Summary

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

STANDARD

public static final StorageType STANDARD

The standard storage method used by the implementation. Not guaranteed to provide anything but single threaded capabilities.

THREAD_SAFE

public static final StorageType THREAD_SAFE

A thread-safe storage solution. Reads and writes are atomic. Necessary for multi-threaded applications, but single threaded ones might suffer for extra overhead.

Method Details

values

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