Direction

java.lang.Object
- java.lang.Enum<Direction>
- - Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>
```
public enum Direction
extends Enum<Direction>
```
Cardinal direction on a grid. Note that you can iterate through directions with the syntax:
```
    for (Direction d : Direction.values()) {
       ...
    }
    
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

EAST

NORTH

SOUTH

WEST

Enum Constants
Enum Constant and Description
`EAST`
`NORTH`
`SOUTH`
`WEST`

Method Summary

Methods
Modifier and Type	Method and Description
`Point`	`forward(Point p)` The point one step forward in this direction.
`Point`	`forward(Point p, int n)` The point n steps forward in this direction.
`abstract Point`	`forward(Point p, int n, Point overwrite)` Computes the point n steps forward in this direction, saves it to overwrite, and then returns overwrite.
`static Direction`	`fromInt(int i)`
`static Direction`	`fromTo(Point a, Point b)` Returns the larger direction from a to b, favoring the vertical.
`boolean`	`isHorizontal()` True for East and West
`boolean`	`isVertical()` True for North and South
`abstract Direction`	`left()` The direction 90-degrees to the left.
`Direction`	`left(int n)` The direction 90*n-degrees to the left.
`int`	`numTurns(Direction d)` The number of turns needed to reach direction d from this direction.
`abstract Direction`	`opposite()` Returns the direction 180 degrees from this one.
`static Direction`	`random()` Uniformly distributed random direction.
`static Direction`	`random(Random r)` Uniformly distributed random direction.
`abstract Direction`	`right()` The direction 90-degrees to the right.
`Direction`	`right(int n)` The direction 90*n-degrees to the right.
`abstract int`	`toInt()` Returns a number between 0 and 3: NORTH = 0, EAST = 1, ...
`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
  - NORTH
```
public static final Direction NORTH
```
  - WEST
```
public static final Direction WEST
```
  - SOUTH
```
public static final Direction SOUTH
```
  - EAST
```
public static final Direction EAST
```
- 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
  - random
```
public static Direction random()
```
    Uniformly distributed random direction.
  - random
```
public static Direction random(Random r)
```
    Uniformly distributed random direction.
  - left
```
public Direction left(int n)
```
    The direction 90*n-degrees to the left.
  - right
```
public Direction right(int n)
```
    The direction 90*n-degrees to the right.
  - left
```
public abstract Direction left()
```
    The direction 90-degrees to the left.
  - right
```
public abstract Direction right()
```
    The direction 90-degrees to the right.
  - isHorizontal
```
public boolean isHorizontal()
```
    True for East and West
  - isVertical
```
public boolean isVertical()
```
    True for North and South
  - numTurns
```
public int numTurns(Direction d)
```
    The number of turns needed to reach direction d from this direction.
  - fromTo
```
public static Direction fromTo(Point a,
               Point b)
```
    Returns the larger direction from a to b, favoring the vertical.
  - opposite
```
public abstract Direction opposite()
```
    Returns the direction 180 degrees from this one.
  - forward
```
public Point forward(Point p)
```
    The point one step forward in this direction.
  - forward
```
public Point forward(Point p,
            int n)
```
    The point n steps forward in this direction.
  - forward
```
public abstract Point forward(Point p,
            int n,
            Point overwrite)
```
    Computes the point n steps forward in this direction, saves it to overwrite, and then returns overwrite.
  - toInt
```
public abstract int toInt()
```
    Returns a number between 0 and 3: NORTH = 0, EAST = 1, ...
  - fromInt
```
public static Direction fromInt(int i)
```

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

WEST

SOUTH

EAST

Method Detail

values

valueOf

random

random

left

right

left

right

isHorizontal

isVertical

numTurns

fromTo

opposite

forward

forward

forward

toInt

fromInt