Package cds.healpix
Enum CompassPoint.Cardinal
- java.lang.Object
-
- java.lang.Enum<CompassPoint.Cardinal>
-
- cds.healpix.CompassPoint.Cardinal
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<CompassPoint.Cardinal>
- Enclosing class:
- CompassPoint
public static enum CompassPoint.Cardinal extends java.lang.Enum<CompassPoint.Cardinal>
Enum defining the compass cardinal points.- Author:
- F.-X. Pineau
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CompassPoint.Cardinal
nextClockwise()
Returns the next cardinal point in the clockwise direction.CompassPoint.Cardinal
nextCounterClockwise()
Returns the next cardinal point in the counter-clockwise direction.static CompassPoint.Cardinal
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CompassPoint.Cardinal[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
N
public static final CompassPoint.Cardinal N
North.
-
E
public static final CompassPoint.Cardinal E
East.
-
S
public static final CompassPoint.Cardinal S
South.
-
W
public static final CompassPoint.Cardinal W
West.
-
-
Method Detail
-
values
public static CompassPoint.Cardinal[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CompassPoint.Cardinal c : CompassPoint.Cardinal.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CompassPoint.Cardinal valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
nextClockwise
public CompassPoint.Cardinal nextClockwise()
Returns the next cardinal point in the clockwise direction.- Returns:
- the next cardinal point in the clockwise direction.
-
nextCounterClockwise
public CompassPoint.Cardinal nextCounterClockwise()
Returns the next cardinal point in the counter-clockwise direction.- Returns:
- the next cardinal point in the counter-clockwise direction.
-
-