bibliothek.gui.dock.station.screen.magnet
Enum MagnetRequest.Side

java.lang.Object
  extended by java.lang.Enum<MagnetRequest.Side>
      extended by bibliothek.gui.dock.station.screen.magnet.MagnetRequest.Side
All Implemented Interfaces:
Serializable, Comparable<MagnetRequest.Side>
Enclosing interface:
MagnetRequest

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

Describes one side of a ScreenDockWindow.

Author:
Benjamin Sigg

Enum Constant Summary
EAST
          the right side
NORTH
          the top side
SOUTH
          the bottom side
WEST
          the left side
 
Method Summary
 MagnetRequest.Side opposite()
          Gets the side that is opposite to this.
static MagnetRequest.Side valueOf(String name)
          Returns the enum constant of this type with the specified name.
static MagnetRequest.Side[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NORTH

public static final MagnetRequest.Side NORTH
the top side


SOUTH

public static final MagnetRequest.Side SOUTH
the bottom side


EAST

public static final MagnetRequest.Side EAST
the right side


WEST

public static final MagnetRequest.Side WEST
the left side

Method Detail

values

public static final MagnetRequest.Side[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(MagnetRequest.Side c : MagnetRequest.Side.values())
        System.out.println(c);

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

valueOf

public static MagnetRequest.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

opposite

public MagnetRequest.Side opposite()
Gets the side that is opposite to this.

Returns:
the opposite side, never null