org.pepsoft.worldpainter.layers.tunnel

Enum TunnelLayer.Mode

java.lang.Object

java.lang.Enum<TunnelLayer.Mode>

org.pepsoft.worldpainter.layers.tunnel.TunnelLayer.Mode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TunnelLayer.Mode>

Enclosing class:

TunnelLayer

public static enum TunnelLayer.Mode
extends java.lang.Enum<TunnelLayer.Mode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT_DEPTH
CUSTOM_DIMENSION
FIXED_HEIGHT
FIXED_HEIGHT_ABOVE_FLOOR
INVERTED_DEPTH

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIXED_HEIGHT

public static final TunnelLayer.Mode FIXED_HEIGHT

CONSTANT_DEPTH

public static final TunnelLayer.Mode CONSTANT_DEPTH

INVERTED_DEPTH

public static final TunnelLayer.Mode INVERTED_DEPTH

CUSTOM_DIMENSION

public static final TunnelLayer.Mode CUSTOM_DIMENSION

FIXED_HEIGHT_ABOVE_FLOOR

public static final TunnelLayer.Mode FIXED_HEIGHT_ABOVE_FLOOR

Method Detail

values

public static TunnelLayer.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TunnelLayer.Mode c : TunnelLayer.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TunnelLayer.Mode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null