adams.data.jai.flattener
Enum Histogram.HistogramType

java.lang.Object
  java.lang.Enum<Histogram.HistogramType>
      adams.data.jai.flattener.Histogram.HistogramType

All Implemented Interfaces:

EnumWithCustomDisplay<Histogram.HistogramType>, Serializable, Comparable<Histogram.HistogramType>

Enclosing class:

Histogram

public static enum Histogram.HistogramType
extends Enum<Histogram.HistogramType>
implements EnumWithCustomDisplay<Histogram.HistogramType>

The type of histogram to generate.

Version:

$Revision: 4779 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

EIGHT_BIT
8-bit.

RGB
RGB.

Method Summary

Histogram.HistogramType	parse(String s) Parses the given string and returns the associated enum.
String	toDisplay() Returns the display string.
String	toRaw() Returns the raw enum string.
String	toString() Returns the display string.
static String	toString(AbstractOption option, Object object) Returns the enum as string.
static Histogram.HistogramType	valueOf(AbstractOption option, String str) Returns an enum generated from the string.
static Histogram.HistogramType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Histogram.HistogramType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EIGHT_BIT

public static final Histogram.HistogramType EIGHT_BIT

8-bit.

RGB

public static final Histogram.HistogramType RGB

RGB.

Method Detail

values

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

Returns:

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

valueOf

public static Histogram.HistogramType 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

toDisplay

public String toDisplay()

Returns the display string.

Specified by:

toDisplay in interface EnumWithCustomDisplay<Histogram.HistogramType>

Returns:

the display string

toRaw

public String toRaw()

Returns the raw enum string.

Specified by:

toRaw in interface EnumWithCustomDisplay<Histogram.HistogramType>

Returns:

the raw enum string

toString

public String toString()

Returns the display string.

Overrides:

toString in class Enum<Histogram.HistogramType>

Returns:

the display string

parse

public Histogram.HistogramType parse(String s)

Parses the given string and returns the associated enum.

Specified by:

parse in interface EnumWithCustomDisplay<Histogram.HistogramType>

Parameters:

s - the string to parse

Returns:

the enum or null if not found

toString

public static String toString(AbstractOption option,
                              Object object)

Returns the enum as string.

Parameters:

option - the current option

object - the enum object to convert

Returns:

the generated string

valueOf

public static Histogram.HistogramType valueOf(AbstractOption option,
                                              String str)

Returns an enum generated from the string.

Parameters:

option - the current option

str - the string to convert to an enum

Returns:

the generated enum or null in case of error