com.github.davidmoten.geo

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

com.github.davidmoten.geo.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Directions on a WGS84 projection. top = north, bottom = south, left = west, right = east.

Author:

dave

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM
LEFT
RIGHT
TOP

Method Summary

Methods

Modifier and Type	Method and Description
Direction	opposite() Returns the opposite 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

BOTTOM

public static final Direction BOTTOM

TOP

public static final Direction TOP

LEFT

public static final Direction LEFT

RIGHT

public static final Direction RIGHT

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

opposite

public Direction opposite()

Returns the opposite direction. For example LEFT.opposite() == RIGHT.

Returns:

the opposite direction