Enum Direction

forge-game/src/main/java/forge/game/Direction.java:25–83

Represents a direction (left or right).

 *  Represents a direction (left or right).
 */
public enum Direction {
	Left,
	Right;

	private static final String LEFT = "Left";
	private static final String RIGHT = "Right";
	/** Immutable list of all directions (in order, Left and Right). */
	private static final List<Direction> listOfDirections =
			List.of(getDefaultDirection(), getDefaultDirection().getOtherDirection());

	/** @return The default direction. */
	public static final Direction getDefaultDirection() { return Left; }

	/** @return Immutable list of all directions (in order, Left and Right). */
	public static List<Direction> getListOfDirections() { return listOfDirections; }

	/** @return True if and only if this is the default direction. */
	public boolean isDefaultDirection() {
		return this.equals(getDefaultDirection());
	}

	/**
	 * Get the index by which the turn order is shifted, given this Direction.
	 * @return 1 or -1.
	 */
	public int getShift() {
		if (this.isDefaultDirection()) {
			return 1;
		}
		return -1;
	}

	/**
	 * Give the other Direction.
	 * @return Right if this is Left, and vice versa.
	 */
	public Direction getOtherDirection() {
		switch (this) {
		case Left:
			return Direction.Right;
		case Right:
			return Direction.Left;
		}
		return null;
	}

	/**
	 * {@inheritDoc}
	 */
	public String toString() {
		switch (this) {
		case Left:
			return LEFT;
		case Right:
			return RIGHT;
		}
		return null;
	}