org.pepsoft.minecraft

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

org.pepsoft.minecraft.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>

public enum Direction
extends java.lang.Enum<Direction>

The cardinal directions, with methods for manipulating them.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
NORTH
SOUTH
WEST

Method Summary

Modifier and Type	Method and Description
int	getDx()
int	getDy()
Direction	left()
Direction	mirror(Direction axis) Mirror this direction in an axis indicated by a separated direction.
Direction	opposite()
static Direction	parse(java.lang.String str)
Direction	right()
Direction	rotate(int steps)
java.lang.String	toString()
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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final Direction NORTH

EAST

public static final Direction EAST

SOUTH

public static final Direction SOUTH

WEST

public static final Direction WEST

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Direction>

rotate

public Direction rotate(int steps)

mirror

public Direction mirror(Direction axis)

Mirror this direction in an axis indicated by a separated direction.

Parameters:

axis - The direction of the axis in which to mirror this direction.

Returns:

This direction mirrored in the specified axis.

opposite

public Direction opposite()

left

public Direction left()

right

public Direction right()

getDx

public int getDx()

getDy

public int getDy()

parse

public static Direction parse(java.lang.String str)