cds.healpix

Enum CompassPoint.Ordinal

java.lang.Object

java.lang.Enum<CompassPoint.Ordinal>

cds.healpix.CompassPoint.Ordinal

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CompassPoint.Ordinal>

Enclosing class:

CompassPoint

public static enum CompassPoint.Ordinal
extends java.lang.Enum<CompassPoint.Ordinal>

Enum defining the compass ordinal points.

Author:

F.-X. Pineau

Enum Constant Summary

Enum Constants

Enum Constant and Description
NE Northeast.
NW Northwest.
SE Southeast.
SW Southwest.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NE

public static final CompassPoint.Ordinal NE

Northeast.

SE

public static final CompassPoint.Ordinal SE

Southeast.

SW

public static final CompassPoint.Ordinal SW

Southwest.

NW

public static final CompassPoint.Ordinal NW

Northwest.

Method Detail

values

public static CompassPoint.Ordinal[] 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.Ordinal c : CompassPoint.Ordinal.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.Ordinal 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 name

java.lang.NullPointerException - if the argument is null