Direction (Gridarta)

java.lang.Object
- java.lang.Enum<Direction>
- - net.sf.gridarta.model.direction.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>
```
public enum Direction
extends java.lang.Enum<Direction>
```
A direction.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DOWN` Down.
`EAST` East.
`NORTH` North.
`NORTH_EAST` North east.
`NORTH_WEST` North west.
`SOUTH` South.
`SOUTH_EAST` South east.
`SOUTH_WEST` South west.
`UP` Up.
`WEST` West.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDx()` Returns the relative x direction.
`int`	`getDy()` Returns the relative y direction.
`int`	`getDz()` Returns the relative z direction.
`java.lang.String`	`getId()` Returns the identification string.
`static Direction`	`valueOf(java.lang.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
  - NORTH
```
public static final Direction NORTH
```
    North.
  - EAST
```
public static final Direction EAST
```
    East.
  - SOUTH
```
public static final Direction SOUTH
```
    South.
  - WEST
```
public static final Direction WEST
```
    West.
  - NORTH_EAST
```
public static final Direction NORTH_EAST
```
    North east.
  - SOUTH_EAST
```
public static final Direction SOUTH_EAST
```
    South east.
  - SOUTH_WEST
```
public static final Direction SOUTH_WEST
```
    South west.
  - NORTH_WEST
```
public static final Direction NORTH_WEST
```
    North west.
  - UP
```
public static final Direction UP
```
    Up.
  - DOWN
```
public static final Direction DOWN
```
    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(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getDx
```
public int getDx()
```
    Returns the relative x direction.
    
    Returns:
    
    the relative x direction
  - getDy
```
public int getDy()
```
    Returns the relative y direction.
    
    Returns:
    
    the relative y direction
  - getDz
```
public int getDz()
```
    Returns the relative z direction.
    
    Returns:
    
    the relative z direction
  - getId
```
@NotNull
public java.lang.String getId()
```
    Returns the identification string.
    
    Returns:
    
    the identification string

Enum Direction

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NORTH

EAST

SOUTH

WEST

NORTH_EAST

SOUTH_EAST

SOUTH_WEST

NORTH_WEST

UP

DOWN

Method Detail

values

valueOf

getDx

getDy

getDz

getId