Enum Class Enums.BarInput
- All Implemented Interfaces:
Serializable
,Comparable<Enums.BarInput>
,Constable
- Enclosing interface:
Enums
Describes values available from historical price bars.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionClosing price.High price.Low price.Midpoint (High + Low)/2.Opening price.Open InterestTypical Price (High + Low + Close)/3.True Range (Range: High, Low, previous Close).Volume.Weighted Average Price (considers volume, not available from all data sources)Weighted Price (Open + High + Low + Close)/4. -
Method Summary
Modifier and TypeMethodDescriptionstatic Enums.BarInput
fromShortLabel
(String lbl) Gets the description.getLabel()
Gets the locale dependent label for this input.static Enums.BarInput[]
Gets the short version of the label.static Enums.BarInput[]
toString()
This method has been overridden to display a user friendly version of the input type for use in combo boxes etc.static Enums.BarInput
Returns the enum constant of this class with the specified name.static Enums.BarInput[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OPEN
Opening price. -
CLOSE
Closing price. -
MIDPOINT
Midpoint (High + Low)/2. -
HIGH
High price. -
LOW
Low price. -
TP
Typical Price (High + Low + Close)/3. -
WP
Weighted Price (Open + High + Low + Close)/4. -
TR
True Range (Range: High, Low, previous Close). -
WAP
Weighted Average Price (considers volume, not available from all data sources) -
VOLUME
Volume. Number of shares, contracts traded -
OPEN_INTEREST
Open Interest
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
toString
This method has been overridden to display a user friendly version of the input type for use in combo boxes etc. Use the name() method to retrieve the programmatic version of the enum.- Overrides:
toString
in classEnum<Enums.BarInput>
-
getLabel
Gets the locale dependent label for this input.- Returns:
- locale dependent label
-
getShortLabel
Gets the short version of the label.- Returns:
- short version of the label
-
getDescription
Gets the description.- Returns:
- description of the bar input
-
getPriceInputs
-
getVolumeInputs
-
fromShortLabel
-