Enum Class Enums.BarInput

java.lang.Object
java.lang.Enum<Enums.BarInput>
com.motivewave.platform.sdk.common.Enums.BarInput
All Implemented Interfaces:
Serializable, Comparable<Enums.BarInput>, Constable
Enclosing interface:
Enums

public static enum Enums.BarInput extends Enum<Enums.BarInput>
Describes values available from historical price bars.
  • Enum Constant Details

    • OPEN

      public static final Enums.BarInput OPEN
      Opening price.
    • CLOSE

      public static final Enums.BarInput CLOSE
      Closing price.
    • MIDPOINT

      public static final Enums.BarInput MIDPOINT
      Midpoint (High + Low)/2.
    • HIGH

      public static final Enums.BarInput HIGH
      High price.
    • LOW

      public static final Enums.BarInput LOW
      Low price.
    • TP

      public static final Enums.BarInput TP
      Typical Price (High + Low + Close)/3.
    • WP

      public static final Enums.BarInput WP
      Weighted Price (Open + High + Low + Close)/4.
    • TR

      public static final Enums.BarInput TR
      True Range (Range: High, Low, previous Close).
    • WAP

      public static final Enums.BarInput WAP
      Weighted Average Price (considers volume, not available from all data sources)
    • VOLUME

      public static final Enums.BarInput VOLUME
      Volume. Number of shares, contracts traded
    • OPEN_INTEREST

      public static final Enums.BarInput OPEN_INTEREST
      Open Interest
  • Method Details

    • values

      public static Enums.BarInput[] 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

      public static Enums.BarInput valueOf(String name)
      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 name
      NullPointerException - if the argument is null
    • toString

      public String 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 class Enum<Enums.BarInput>
    • getLabel

      public String getLabel()
      Gets the locale dependent label for this input.
      Returns:
      locale dependent label
    • getShortLabel

      public String getShortLabel()
      Gets the short version of the label.
      Returns:
      short version of the label
    • getDescription

      public String getDescription()
      Gets the description.
      Returns:
      description of the bar input
    • getPriceInputs

      public static Enums.BarInput[] getPriceInputs()
    • getVolumeInputs

      public static Enums.BarInput[] getVolumeInputs()