gov.nasa.pds.label

Enum DisplayDirection

java.lang.Object

java.lang.Enum<DisplayDirection>

gov.nasa.pds.label.DisplayDirection

All Implemented Interfaces:

Serializable, Comparable<DisplayDirection>

public enum DisplayDirection
extends Enum<DisplayDirection>

Defines the various display directions that can be used by axes within arrays and images.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_TO_TOP
DOWN Display is top-to-bottom.
LEFT Display is right-to-left.
LEFT_TO_RIGHT
RIGHT Display is left-to-right.
RIGHT_TO_LEFT
TOP_TO_BOTTOM
UP Display is bottom-to-top.

Method Summary

Methods

Modifier and Type	Method and Description
static DisplayDirection	getDirectionFromValue(String value) Looks up a display direction based on the value within the metadata.
static DisplayDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static DisplayDirection[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final DisplayDirection LEFT

Display is right-to-left.

RIGHT_TO_LEFT

public static final DisplayDirection RIGHT_TO_LEFT

RIGHT

public static final DisplayDirection RIGHT

Display is left-to-right.

LEFT_TO_RIGHT

public static final DisplayDirection LEFT_TO_RIGHT

UP

public static final DisplayDirection UP

Display is bottom-to-top.

BOTTOM_TO_TOP

public static final DisplayDirection BOTTOM_TO_TOP

DOWN

public static final DisplayDirection DOWN

Display is top-to-bottom.

TOP_TO_BOTTOM

public static final DisplayDirection TOP_TO_BOTTOM

Method Detail

values

public static DisplayDirection[] 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 (DisplayDirection c : DisplayDirection.values())
    System.out.println(c);

Returns:

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

valueOf

public static DisplayDirection 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

getDirectionFromValue

public static DisplayDirection getDirectionFromValue(String value)

Looks up a display direction based on the value within the metadata.

Parameters:

value - the metadata value

Returns:

the display direciton corresponding to the metadata value, or null if not found