com.dukascopy.api
Enum DataType

java.lang.Object
  extended by java.lang.Enum<DataType>
      extended by com.dukascopy.api.DataType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DataType>

public enum DataType
extends java.lang.Enum<DataType>

The enumeration describes several data types used in JForex


Nested Class Summary
static class DataType.DataPresentationType
           
 
Enum Constant Summary
POINT_AND_FIGURE
          P&F Point and figure charts are composed of a number of columns that either consist of a series of stacked Xs or Os.
PRICE_RANGE_AGGREGATION
          Range Bars for 2 pips, 3 pips, 4 pips, etc
RENKO
          A Renko bars (bricks) are constructed by placing a brick in the next column once the price surpasses the top or bottom of the previous brick by a predefined amount
TICK_BAR
          Bar which consists of exact number of ticks
TICKS
          Just ticks
TIME_PERIOD_AGGREGATION
          Candles for periods 1 sec, 10 sec, 1 min, etc
 
Method Summary
 java.util.Set<DataType.DataPresentationType> getSupportedPresentationTypes()
           
 boolean isPresentationTypeSupported(DataType.DataPresentationType presentationType)
           
static DataType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DataType[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

TICKS

public static final DataType TICKS
Just ticks


TICK_BAR

public static final DataType TICK_BAR
Bar which consists of exact number of ticks


TIME_PERIOD_AGGREGATION

public static final DataType TIME_PERIOD_AGGREGATION
Candles for periods 1 sec, 10 sec, 1 min, etc


PRICE_RANGE_AGGREGATION

public static final DataType PRICE_RANGE_AGGREGATION
Range Bars for 2 pips, 3 pips, 4 pips, etc


POINT_AND_FIGURE

public static final DataType POINT_AND_FIGURE
P&F Point and figure charts are composed of a number of columns that either consist of a series of stacked Xs or Os.


RENKO

public static final DataType RENKO
A Renko bars (bricks) are constructed by placing a brick in the next column once the price surpasses the top or bottom of the previous brick by a predefined amount

Method Detail

values

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

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

valueOf

public static DataType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getSupportedPresentationTypes

public java.util.Set<DataType.DataPresentationType> getSupportedPresentationTypes()

isPresentationTypeSupported

public boolean isPresentationTypeSupported(DataType.DataPresentationType presentationType)