Direction

java.lang.Object

java.lang.Enum<Direction>

ch.nolix.systemapi.gui.box.Direction

All Implemented Interfaces:: Serializable, Comparable<Direction>, Constable

public enum Direction extends Enum<Direction>

A Direction defines the horizontal, vertical or diagonals options in a box.

Author:: Silvan Wyss

Nested Class Summary

Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E>
Enum Constant Summary

Enum Constants

Enum Constant

Description

DIAGONAL_LEFT_DOWN

DIAGONAL_LEFT_UP

HORIZONTAL

VERTICAL
Method Summary

Modifier and Type

Method

Description

static Direction

fromSpecification(INode<?> specification)

static Direction

valueOf(String name)

Returns the enum constant of this class with the specified name.

static Direction[]

values()

Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- HORIZONTAL
  
  public static final Direction HORIZONTAL
- VERTICAL
  
  public static final Direction VERTICAL
- DIAGONAL_LEFT_UP
  
  public static final Direction DIAGONAL_LEFT_UP
- DIAGONAL_LEFT_DOWN
  
  public static final Direction DIAGONAL_LEFT_DOWN
Method Details
- values
  
  public static Direction[] values()
  
  Returns an array containing the constants of this enum class, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum class, in the order they are declared
- valueOf
  
  public static Direction valueOf(String name)
  
  Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
  
  NullPointerException - if the argument is null
- fromSpecification
  
  public static Direction fromSpecification(INode<?> specification)
  
  Parameters:
  
  specification -
  
  Returns:
  
  a Direction from the given specification.
  
  Throws:
  
  RuntimeException - if the given specification does not represent a Direction.