Enum ECartesianAxis2D

java.lang.Object

java.lang.Enum<ECartesianAxis2D>

de.xima.fc.common.geometry.ECartesianAxis2D

All Implemented Interfaces:

Serializable, Comparable<ECartesianAxis2D>

public enum ECartesianAxis2D
extends Enum<ECartesianAxis2D>

An enumeration representing the two dimensions in a 2D cartesian coordinate system.

Since:

8.4.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
X	The X-axis, representing the horizontal dimension.
Y	The Y-axis, representing the vertical dimension.

Method Summary

Modifier and Type	Method	Description
ECartesianAxis2D	opposite()	Returns the opposite axis of this axis.
static ECartesianAxis2D	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ECartesianAxis2D[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

X

public static final ECartesianAxis2D X

The X-axis, representing the horizontal dimension.

Y

public static final ECartesianAxis2D Y

The Y-axis, representing the vertical dimension.

Method Details

values

public static ECartesianAxis2D[] values()

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

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ECartesianAxis2D 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 ECartesianAxis2D opposite()

Returns the opposite axis of this axis. The opposite of X is Y and vice versa.

Returns:

The opposite axis.