org.tinfour.utils

Enum GridSpecification.CellPosition

java.lang.Object

java.lang.Enum<GridSpecification.CellPosition>

org.tinfour.utils.GridSpecification.CellPosition

All Implemented Interfaces:

Serializable, Comparable<GridSpecification.CellPosition>

Enclosing class:

GridSpecification

public static enum GridSpecification.CellPosition
extends Enum<GridSpecification.CellPosition>

Specifies how the cells are oriented relative to the coordinates of the of the grid. If CenterOfCell is specified, then the coordinates for the lower-left corner of the grid would lie in the center of the cell. If the CornerOfCell argument was specified, then the corner of the grid would lay on the lower-left corner of the cell.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CenterOfCell The coordinates give the center of the cell.
CornerOfCell The coordinates given the lower-left corner of the cell

Method Summary

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

CenterOfCell

public static final GridSpecification.CellPosition CenterOfCell

The coordinates give the center of the cell.

CornerOfCell

public static final GridSpecification.CellPosition CornerOfCell

The coordinates given the lower-left corner of the cell

Method Detail

values

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

Returns:

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

valueOf

public static GridSpecification.CellPosition 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