org.codetome.hexameter.core.api

Enum HexagonalGridLayout

java.lang.Object

java.lang.Enum<HexagonalGridLayout>

org.codetome.hexameter.core.api.HexagonalGridLayout

All Implemented Interfaces:

Serializable, Comparable<HexagonalGridLayout>

public enum HexagonalGridLayout
extends Enum<HexagonalGridLayout>

This enum represents the possible shapes a HexagonalGrid can have. The name HexagonalGridLayout might seem inconsistent with the other names in this package but since the name GridLayout is so common (in SWT for example) using this name seemed appropriate.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMPTY An empty grid.
HEXAGONAL The hexagonal layout must have equal width and height and it must be odd.
RECTANGULAR A rectangular layout has no special rules.
TRAPEZOID A trapezoid layout has no special rules.
TRIANGULAR A triangular layout must have equal width and height.

Method Summary

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

RECTANGULAR

public static final HexagonalGridLayout RECTANGULAR

A rectangular layout has no special rules.

HEXAGONAL

public static final HexagonalGridLayout HEXAGONAL

The hexagonal layout must have equal width and height and it must be odd.

TRIANGULAR

public static final HexagonalGridLayout TRIANGULAR

A triangular layout must have equal width and height.

TRAPEZOID

public static final HexagonalGridLayout TRAPEZOID

A trapezoid layout has no special rules.

EMPTY

public static final HexagonalGridLayout EMPTY

An empty grid.

Method Detail

values

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

Returns:

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

valueOf

public static HexagonalGridLayout 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

getGridLayoutStrategy

public GridLayoutStrategy getGridLayoutStrategy()