Module de.unistuttgart.informatik.fius.icge.simulation

Package de.unistuttgart.informatik.fius.icge.simulation

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

de.unistuttgart.informatik.fius.icge.simulation.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

The four fundamental directions possible in the simulation.

NORTH is at the top of the screen (Position.getY() getting smaller)

EAST is at the right of the screen (Position.getX() getting bigger)

SOUTH is at the bottom of the screen (Position.getY() getting bigger)

WEST is at the left of the screen (Position.getX() getting smaller)

Author:

Tim Neumann

See Also:

Position

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST	The east direction; at the right of the screen (Position.getX() getting bigger)
NORTH	the north direction; at the top of the screen (Position.getY() getting smaller)
SOUTH	The south direction; at the bottom of the screen (Position.getY() getting bigger)
WEST	The west direction; at the left of the screen (Position.getX() getting smaller)

Method Summary

Modifier and Type	Method	Description
Direction	clockWiseNext()	Get the direction that is next in a clock wise rotation
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

the north direction; at the top of the screen (Position.getY() getting smaller)

EAST

public static final Direction EAST

The east direction; at the right of the screen (Position.getX() getting bigger)

SOUTH

public static final Direction SOUTH

The south direction; at the bottom of the screen (Position.getY() getting bigger)

WEST

public static final Direction WEST

The west direction; at the left of the screen (Position.getX() getting smaller)

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

clockWiseNext

public Direction clockWiseNext()

Get the direction that is next in a clock wise rotation

Returns:

The next direction