adams.core.gnuplot
Enum SimplePlot.PlotType

java.lang.Object
  java.lang.Enum<SimplePlot.PlotType>
      adams.core.gnuplot.SimplePlot.PlotType

All Implemented Interfaces:

EnumWithCustomDisplay<SimplePlot.PlotType>, Serializable, Comparable<SimplePlot.PlotType>

Enclosing class:

SimplePlot

public static enum SimplePlot.PlotType
extends Enum<SimplePlot.PlotType>
implements EnumWithCustomDisplay<SimplePlot.PlotType>

Enumeration of available plot types.

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

BOXERRORBARS

BOXES

BOXXYERRORBARS

CANDELSTICKS

DOTS

ERRORBARS

ERRORLINES

FILLEDCURVES

FINANCEBARDS

FSTEPS

HISTEPS

IMPULSES

LINES

LINESPOINTS

POINTS

STEPS

VECTORS

XERRORBARS

XERRORLINES

XYERRORBARS

XYERRORLINES

YERRORBARS

YERRORLINES

Method Summary

String	getField() Returns the display string without the "numeric" or "nominal" in parentheses.
SimplePlot.PlotType	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 displays string.
static String	toString(AbstractOption option, Object object) Returns the enum as string.
static SimplePlot.PlotType	valueOf(AbstractOption option, String str) Returns an enum generated from the string.
static SimplePlot.PlotType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SimplePlot.PlotType[]	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

LINES

public static final SimplePlot.PlotType LINES

POINTS

public static final SimplePlot.PlotType POINTS

LINESPOINTS

public static final SimplePlot.PlotType LINESPOINTS

IMPULSES

public static final SimplePlot.PlotType IMPULSES

DOTS

public static final SimplePlot.PlotType DOTS

STEPS

public static final SimplePlot.PlotType STEPS

FSTEPS

public static final SimplePlot.PlotType FSTEPS

HISTEPS

public static final SimplePlot.PlotType HISTEPS

ERRORBARS

public static final SimplePlot.PlotType ERRORBARS

XERRORBARS

public static final SimplePlot.PlotType XERRORBARS

YERRORBARS

public static final SimplePlot.PlotType YERRORBARS

XYERRORBARS

public static final SimplePlot.PlotType XYERRORBARS

ERRORLINES

public static final SimplePlot.PlotType ERRORLINES

XERRORLINES

public static final SimplePlot.PlotType XERRORLINES

YERRORLINES

public static final SimplePlot.PlotType YERRORLINES

XYERRORLINES

public static final SimplePlot.PlotType XYERRORLINES

BOXES

public static final SimplePlot.PlotType BOXES

FILLEDCURVES

public static final SimplePlot.PlotType FILLEDCURVES

BOXERRORBARS

public static final SimplePlot.PlotType BOXERRORBARS

BOXXYERRORBARS

public static final SimplePlot.PlotType BOXXYERRORBARS

FINANCEBARDS

public static final SimplePlot.PlotType FINANCEBARDS

CANDELSTICKS

public static final SimplePlot.PlotType CANDELSTICKS

VECTORS

public static final SimplePlot.PlotType VECTORS

Method Detail

values

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

Returns:

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

valueOf

public static SimplePlot.PlotType 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<SimplePlot.PlotType>

Returns:

the display string

toRaw

public String toRaw()

Returns the raw enum string.

Specified by:

toRaw in interface EnumWithCustomDisplay<SimplePlot.PlotType>

Returns:

the raw enum string

parse

public SimplePlot.PlotType parse(String s)

Parses the given string and returns the associated enum.

Specified by:

parse in interface EnumWithCustomDisplay<SimplePlot.PlotType>

Parameters:

s - the string to parse

Returns:

the enum or null if not found

getField

public String getField()

Returns the display string without the "numeric" or "nominal" in parentheses.

Returns:

the field string

toString

public String toString()

Returns the displays string.

Overrides:

toString in class Enum<SimplePlot.PlotType>

Returns:

the display string

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 SimplePlot.PlotType 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