Package com.cta4j.train.station.model

Enum Class CardinalDirection

java.lang.Object

java.lang.Enum<CardinalDirection>

com.cta4j.train.station.model.CardinalDirection

All Implemented Interfaces:

Serializable, Comparable<CardinalDirection>, Constable

@NullMarked
public enum CardinalDirection
extends Enum<CardinalDirection>

Represents the four cardinal directions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST	East direction.
NORTH	North direction.
SOUTH	South direction.
WEST	West direction.

Method Summary

Modifier and Type	Method	Description
static CardinalDirection	fromCode(String code)	Returns the CardinalDirection corresponding to the given code.
static CardinalDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CardinalDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORTH

public static final CardinalDirection NORTH

North direction.

EAST

public static final CardinalDirection EAST

East direction.

SOUTH

public static final CardinalDirection SOUTH

South direction.

WEST

public static final CardinalDirection WEST

West direction.

Method Details

values

public static CardinalDirection[] 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 CardinalDirection 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

fromCode

public static CardinalDirection fromCode(String code)

Returns the CardinalDirection corresponding to the given code.

Parameters:

code - the code representing the cardinal direction (e.g., "N", "E", "S", "W" or their full names)

Returns:

the corresponding CardinalDirection

Throws:

IllegalArgumentException - if the code does not correspond to any known cardinal direction