net.infonode.util

Class Direction

public final class Direction extends Enum

An enum class for directions, up, down, left, right.

Version: $Revision: 1.6 $

Author: $Author: jesper $

Field Summary
static Direction[]DIRECTIONS
Array containing all directions.
static DirectionDOWN
Down direction.
static DirectionLEFT
Left direction.
static DirectionRIGHT
Right direction.
static DirectionUP
Up direction.
Method Summary
static Directiondecode(ObjectInputStream in)
Decodes a direction from a stream.
static Direction[]getDirections()
Gets all directions.
DirectiongetNextCCW()
Returns the direction that is one quarter of a revolution counter clock wise.
DirectiongetNextCW()
Returns the direction that is one quarter of a revolution clock wise.
DirectiongetOpposite()
Returns the opposite direction.
booleanisHorizontal()
Returns true if the direction is horizontal.

Field Detail

DIRECTIONS

public static final Direction[] DIRECTIONS
Array containing all directions.

DOWN

public static final Direction DOWN
Down direction.

LEFT

public static final Direction LEFT
Left direction.

RIGHT

public static final Direction RIGHT
Right direction.

UP

public static final Direction UP
Up direction.

Method Detail

decode

public static Direction decode(ObjectInputStream in)
Decodes a direction from a stream.

Parameters: in the stream containing the direction

Returns: the direction

Throws: IOException if there is a stream error

getDirections

public static Direction[] getDirections()
Gets all directions.

Returns: all directions

Since: 1.1.0

getNextCCW

public Direction getNextCCW()
Returns the direction that is one quarter of a revolution counter clock wise.

Returns: the direction that is one quarter of a revolution counter clock wise

getNextCW

public Direction getNextCW()
Returns the direction that is one quarter of a revolution clock wise.

Returns: the direction that is one quarter of a revolution clock wise

getOpposite

public Direction getOpposite()
Returns the opposite direction.

Returns: the opposite direction

isHorizontal

public boolean isHorizontal()
Returns true if the direction is horizontal.

Returns: true if the direction is horizontal