com.dukascopy.api.feed

Enum CreationPoint

java.lang.Object

java.lang.Enum<CreationPoint>

com.dukascopy.api.feed.CreationPoint

All Implemented Interfaces:

Serializable, Comparable<CreationPoint>

public enum CreationPoint
extends Enum<CreationPoint>

This enum represents the data (e.g. LineBreak, Renko) creation point. This enum is necessary for data feeds, which uses time sessions.

Example: if Line Break session is Period.ONE_MIN and creation point is CLOSE, then next Line Break line is created between the close price of finished Period.ONE_MIN candle and previous N-Line Break lines.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE Indicates that Line Break line calculation will be according to the CLOSE price of desired session length.
H_L_2 Indicates that Line Break line calculation will be according to the (HIGH+LOW)/2 price of desired session length.
HIGH Indicates that Line Break line calculation will be according to the HIGH price of desired session length.
LOW Indicates that Line Break line calculation will be according to the LOW price of desired session length.
O_C_2 Indicates that Line Break line calculation will be according to the (OPEN+CLOSE)/2 price of desired session length.
OPEN Indicates that Line Break line calculation will be according to the OPEN price of desired session length.

Method Summary

Methods

Modifier and Type	Method and Description
static RenkoCreationPoint	convertToRenkoCreationPoint(CreationPoint creationPoint)
static CreationPoint	valueOf(String name) Returns the enum constant of this type with the specified name.
static CreationPoint[]	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

OPEN

public static final CreationPoint OPEN

Indicates that Line Break line calculation will be according to the OPEN price of desired session length.

CLOSE

public static final CreationPoint CLOSE

Indicates that Line Break line calculation will be according to the CLOSE price of desired session length.

HIGH

public static final CreationPoint HIGH

Indicates that Line Break line calculation will be according to the HIGH price of desired session length.

LOW

public static final CreationPoint LOW

Indicates that Line Break line calculation will be according to the LOW price of desired session length.

H_L_2

public static final CreationPoint H_L_2

Indicates that Line Break line calculation will be according to the (HIGH+LOW)/2 price of desired session length.

O_C_2

public static final CreationPoint O_C_2

Indicates that Line Break line calculation will be according to the (OPEN+CLOSE)/2 price of desired session length.

Method Detail

values

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

Returns:

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

valueOf

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

convertToRenkoCreationPoint

public static RenkoCreationPoint convertToRenkoCreationPoint(CreationPoint creationPoint)