de.cau.cs.kieler.klodd.hierarchical.structures.slimgraph
Enum KSlimNode.Side

java.lang.Object
  extended by java.lang.Enum<KSlimNode.Side>
      extended by de.cau.cs.kieler.klodd.hierarchical.structures.slimgraph.KSlimNode.Side
All Implemented Interfaces:
Comparable<KSlimNode.Side>
Enclosing class:
KSlimNode

public static enum KSlimNode.Side
extends Enum<KSlimNode.Side>

Definition of sides of a node. The order of side definitions ensures that the default enumeration comparator implementation respects the node sides found in clockwise order.

Rating red

Enum Constant Summary
EAST
          east side.
NORTH
          north side.
SOUTH
          south side.
UNDEFINED
          the side is undefined.
WEST
          west side.
 
Method Summary
 KSlimNode.Side left()
          Returns the next side in counter-clockwise order.
 KSlimNode.Side opposed()
          Returns the opposed side.
 KSlimNode.Side right()
          Returns the next side in clockwise order.
static KSlimNode.Side valueOf(String name)
          Returns the enum constant of this type with the specified name.
static KSlimNode.Side[] 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

UNDEFINED

public static final KSlimNode.Side UNDEFINED
the side is undefined.


NORTH

public static final KSlimNode.Side NORTH
north side.


EAST

public static final KSlimNode.Side EAST
east side.


SOUTH

public static final KSlimNode.Side SOUTH
south side.


WEST

public static final KSlimNode.Side WEST
west side.

Method Detail

values

public static KSlimNode.Side[] 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 (KSlimNode.Side c : KSlimNode.Side.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static KSlimNode.Side 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

right

public KSlimNode.Side right()
Returns the next side in clockwise order.

Returns:
the next side in clockwise order

left

public KSlimNode.Side left()
Returns the next side in counter-clockwise order.

Returns:
the next side in counter-clockwise order

opposed

public KSlimNode.Side opposed()
Returns the opposed side.

Returns:
the opposed side