Package de.z0rdak.yawp.core.region

Enum Class RegionType

java.lang.Object

java.lang.Enum<RegionType>

de.z0rdak.yawp.core.region.RegionType

All Implemented Interfaces:

Serializable, Comparable<RegionType>, Constable

public enum RegionType
extends Enum<RegionType>

Enum to identify region type. Mainly used for region deserialization.

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
DIMENSION	Used for dimension regions.
GLOBAL	Used for a global region, spanning over all dimensional regions.
LOCAL	Used to for local, markable regions.
TEMPLATE	Used to mark a template region.

Field Summary

Fields

Modifier and Type	Field	Description
final String	type

Method Summary

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

GLOBAL

public static final RegionType GLOBAL

Used for a global region, spanning over all dimensional regions. NOT yet used.

DIMENSION

public static final RegionType DIMENSION

Used for dimension regions. Instances of DimensionalRegion.

LOCAL

public static final RegionType LOCAL

Used to for local, markable regions. Instances of IMarkableRegion.

TEMPLATE

public static final RegionType TEMPLATE

Used to mark a template region. NOT yet used.

Field Details

type

public final String type

Method Details

values

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

of

public static RegionType of(String name)