com.dukascopy.api.feed

Enum RenkoCreationPoint

java.lang.Object

java.lang.Enum<RenkoCreationPoint>

com.dukascopy.api.feed.RenkoCreationPoint

All Implemented Interfaces:

Serializable, Comparable<RenkoCreationPoint>

public enum RenkoCreationPoint
extends Enum<RenkoCreationPoint>

This enum represents the renko creation point. Renko bars are created from sessions.

Example: if renko session is Period.ONE_MIN and creation point is CLOSE, then renko bars are created between the close prices of two sequential Period.ONE_MIN candles.

Author:

janis.garsils

Enum Constant Summary

Enum Constants

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

Method Summary

Methods

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

Indicates that renko calculation will be according to the OPEN price of desired renko session.

CLOSE

public static final RenkoCreationPoint CLOSE

Indicates that renko calculation will be according to the CLOSE price of desired renko session.

HIGH

public static final RenkoCreationPoint HIGH

Indicates that renko calculation will be according to the HIGH price of desired renko session.

LOW

public static final RenkoCreationPoint LOW

Indicates that renko calculation will be according to the LOW price of desired renko session.

H_L_2

public static final RenkoCreationPoint H_L_2

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

O_C_2

public static final RenkoCreationPoint O_C_2

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

Method Detail

values

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

Returns:

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

valueOf

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

convertToCreationPoint

public static CreationPoint convertToCreationPoint(RenkoCreationPoint renkoCreationPoint)