gov.nasa.pds.label
Enum DisplayDirection

java.lang.Object
  extended by java.lang.Enum<DisplayDirection>
      extended by 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
DOWN
          Display is top-to-bottom.
LEFT
          Display is right-to-left.
RIGHT
          Display is left-to-right.
UP
          Display is bottom-to-top.
 
Method Summary
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

public static final DisplayDirection RIGHT
Display is left-to-right.


UP

public static final DisplayDirection UP
Display is bottom-to-top.


DOWN

public static final DisplayDirection DOWN
Display is 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


Copyright © 2013. All Rights Reserved.