Package ball.game.crossword

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

ball.game.crossword.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Crossword clue Direction.

Author:

Allen D. Ball

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACROSS
DOWN

Method Summary

Modifier and Type	Method	Description
static Direction	of(CoordinateMap<?> map)	Static method to analyze CoordinateMap to determine a Direction.
static Direction	parse(String string)	Static method to parse a String consistent with Enum.name() and Enum.toString() to a Direction.
static Direction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Direction[]	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

ACROSS

public static final Direction ACROSS

DOWN

public static final Direction DOWN

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static Direction parse(String string)

Static method to parse a String consistent with Enum.name() and Enum.toString() to a Direction.

Parameters:

string - The String to parse.

Returns:

The Direction.

of

public static Direction of(CoordinateMap<?> map)

Static method to analyze CoordinateMap to determine a Direction.

Parameters:

map - The CoordinateMap to analyze.

Returns:

The Direction.

Throws:

IllegalArgumentException - If both CoordinateMap.getRowCount() and CoordinateMap.getColumnCount() are not equal to 1.