Class Direction

java.lang.Object
net.infonode.util.Enum
net.infonode.util.Direction
All Implemented Interfaces:
Serializable, Writable

public final class Direction extends Enum
An enum class for directions, up, down, left, right.
See Also:
  • Field Details

    • UP

      public static final Direction UP
      Up direction.
    • DOWN

      public static final Direction DOWN
      Down direction.
    • LEFT

      public static final Direction LEFT
      Left direction.
    • DIRECTIONS

      public static final Direction[] DIRECTIONS
      Array containing all directions.
  • Method Details

    • getNextCW

      public Direction getNextCW()
      Returns the direction that is one quarter of a revolution clock wise.
      Returns:
      the direction that is one quarter of a revolution clock wise
    • getNextCCW

      public Direction getNextCCW()
      Returns the direction that is one quarter of a revolution counter clock wise.
      Returns:
      the direction that is one quarter of a revolution counter clock wise
    • isHorizontal

      public boolean isHorizontal()
      Returns true if the direction is horizontal.
      Returns:
      true if the direction is horizontal
    • getOpposite

      public Direction getOpposite()
      Returns the opposite direction.
      Returns:
      the opposite direction
    • getDirections

      public static Direction[] getDirections()
      Gets all directions.
      Returns:
      all directions
      Since:
      1.1.0
    • decode

      public static Direction decode(ObjectInputStream in) throws IOException
      Decodes a direction from a stream.
      Parameters:
      in - the stream containing the direction
      Returns:
      the direction
      Throws:
      IOException - if there is a stream error