bibliothek.gui.dock.station.screen.magnet

Enum MagnetRequest.Side

java.lang.Object

java.lang.Enum<MagnetRequest.Side>

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

Enum Constants

Enum Constant and Description
EAST the right side
NORTH the top side
SOUTH the bottom side
WEST the left side

Method Summary

Modifier and Type	Method and Description
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 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 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 MagnetRequest.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 (MagnetRequest.Side c : MagnetRequest.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 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

NullPointerException - if the argument is null

opposite

public MagnetRequest.Side opposite()

Gets the side that is opposite to this.

Returns:

the opposite side, never null