de.cau.cs.kieler.kiml.options
Enum PortSide

java.lang.Object
  extended by java.lang.Enum<PortSide>
      extended by de.cau.cs.kieler.kiml.options.PortSide
All Implemented Interfaces:
Comparable<PortSide>

public enum PortSide
extends Enum<PortSide>

Definition of port sides on a node.

Rating yellow
(2011-03-14) reviewed by cmot, cds

Enum Constant Summary
EAST
          right side.
NORTH
          top side.
SOUTH
          bottom side.
UNDEFINED
          the side is undefined.
WEST
          left side.
 
Method Summary
static PortSide fromDirection(Direction direction)
          Get the port side that corresponds to the given direction.
 PortSide left()
          Returns the next side in counter-clockwise order.
 PortSide opposed()
          Returns the opposed side.
 PortSide right()
          Returns the next side in clockwise order.
static PortSide valueOf(int i)
          Returns the enumeration value related to the given ordinal.
static PortSide valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PortSide[] 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 PortSide UNDEFINED
the side is undefined.


NORTH

public static final PortSide NORTH
top side.


EAST

public static final PortSide EAST
right side.


SOUTH

public static final PortSide SOUTH
bottom side.


WEST

public static final PortSide WEST
left side.

Method Detail

values

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

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

valueOf

public static PortSide 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

valueOf

public static PortSide valueOf(int i)
Returns the enumeration value related to the given ordinal.

Parameters:
i - ordinal value
Returns:
the related enumeration value

right

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

Returns:
the next side in clockwise order

left

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

Returns:
the next side in counter-clockwise order

opposed

public PortSide opposed()
Returns the opposed side.

Returns:
the opposed side

fromDirection

public static PortSide fromDirection(Direction direction)
Get the port side that corresponds to the given direction.

Parameters:
direction - a direction
Returns:
the corresponding port side