com.softwarefx.chartfx.server
Enum HighLowClose

java.lang.Object
  java.lang.Enum<HighLowClose>
      com.softwarefx.chartfx.server.HighLowClose

All Implemented Interfaces:

Serializable, Comparable<HighLowClose>

public enum HighLowClose
extends Enum<HighLowClose>

This enum gets the index value of a series for a HighLowClose chart.

Enum Constant Summary

CLOSE
The Close Series in a HighLowClose chart (index 1).

HIGH
The High Series in a HighLowClose chart (index 2).

LOW
The Low Series in a HighLowClose chart (index 0).

Method Summary

static EnumSet<HighLowClose>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static HighLowClose	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(EnumSet<HighLowClose> value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(HighLowClose value) Returns a numeric value that represents the given EnumSet or Enum item.
static HighLowClose	valueOf(String name) Returns the enum constant of this type with the specified name.
static HighLowClose[]	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

LOW

public static final HighLowClose LOW

The Low Series in a HighLowClose chart (index 0).

CLOSE

public static final HighLowClose CLOSE

The Close Series in a HighLowClose chart (index 1).

HIGH

public static final HighLowClose HIGH

The High Series in a HighLowClose chart (index 2).

Method Detail

values

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

Returns:

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

valueOf

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

getEnumSetValue

public static EnumSet<HighLowClose> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static HighLowClose getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(HighLowClose value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<HighLowClose> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.