Module org.refcodes.graphical

Package org.refcodes.graphical

Enum Class GridMode

java.lang.Object

java.lang.Enum<GridMode>

org.refcodes.graphical.GridMode

All Implemented Interfaces:

Serializable, Comparable<GridMode>, Constable

public enum GridMode
extends Enum<GridMode>

The Enum GridMode.

Author:

steiner

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
CLOSED	The grid is closed (math) on its top, bottom, left and right sides.
NONE
PERIODIC	The grid extends outside the top back to the bottom (and vice versa), outside the left hand side back to the right hand side (and vice versa).

Method Summary

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

CLOSED

public static final GridMode CLOSED

The grid is closed (math) on its top, bottom, left and right sides.

PERIODIC

public static final GridMode PERIODIC

The grid extends outside the top back to the bottom (and vice versa), outside the left hand side back to the right hand side (and vice versa).

NONE

public static final GridMode NONE

Method Details

values

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