org.smallmind.nutsnbolts.layout

Enum Gap

java.lang.Object

java.lang.Enum<Gap>

org.smallmind.nutsnbolts.layout.Gap

All Implemented Interfaces:

Serializable, Comparable<Gap>

public enum Gap
extends Enum<Gap>

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE
RELATED
UNRELATED

Method Summary

Modifier and Type	Method and Description
abstract double	getGap(ParaboxPlatform platform)
static Gap	valueOf(String name) Returns the enum constant of this type with the specified name.
static Gap[]	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

NONE

public static final Gap NONE

RELATED

public static final Gap RELATED

UNRELATED

public static final Gap UNRELATED

Method Detail

values

public static Gap[] 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 (Gap c : Gap.values())
    System.out.println(c);

Returns:

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

valueOf

public static Gap valueOf(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:

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

NullPointerException - if the argument is null

getGap

public abstract double getGap(ParaboxPlatform platform)