com.dxfeed.event.candle

Class CandlePriceLevel

java.lang.Object

com.dxfeed.event.candle.CandlePriceLevel

All Implemented Interfaces:

CandleSymbolAttribute<CandlePriceLevel>

public class CandlePriceLevel
extends Object
implements CandleSymbolAttribute<CandlePriceLevel>

Candle price level attribute of CandleSymbol defines how candles shall be aggregated in respect to price interval. The negative or infinite values of price interval are treated as exceptional.

• Price interval may be equal to zero. It means every unique price creates a particular candle to aggregate all events with this price for the chosen CandlePeriod.
• Non-zero price level creates sequence of intervals starting from 0: ...,[-pl;0),[0;pl),[pl;2*pl),...,[n*pl,n*pl+pl). Events aggregated by chosen CandlePeriod and price intervals.

Implementation details

This attribute is encoded in a symbol string with MarketEventSymbols.getAttributeStringByKey, changeAttributeStringByKey, and removeAttributeStringByKey methods. The key to use with these methods is available via ATTRIBUTE_KEY constant. The value that this key shall be set to is equal to the corresponding CandlePriceLevel.toString()

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_KEY The attribute key that is used to store the value of CandlePriceLevel in a symbol string using methods of MarketEventSymbols class.
static CandlePriceLevel	DEFAULT Default price level corresponds to Double.NaN

Method Summary

Modifier and Type	Method and Description
String	changeAttributeForSymbol(String symbol) Returns candle event symbol string with this candle price level set.
void	checkInAttributeImpl(CandleSymbol candleSymbol) Internal method that initializes attribute in the candle symbol.
boolean	equals(Object o) Indicates whether this price level is the same as another one.
static CandlePriceLevel	getAttributeForSymbol(String symbol) Returns candle price level of the given candle symbol string.
double	getValue() Returns price level value.
int	hashCode() Returns hash code of this price level.
static String	normalizeAttributeForSymbol(String symbol) Returns candle symbol string with the normalized representation of the candle price level attribute.
static CandlePriceLevel	parse(String s) Parses string representation of candle price level into object.
String	toString() Returns string representation of this price level.
static CandlePriceLevel	valueOf(double value) Returns candle price level with the given value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final CandlePriceLevel DEFAULT

Default price level corresponds to Double.NaN

ATTRIBUTE_KEY

public static final String ATTRIBUTE_KEY

The attribute key that is used to store the value of CandlePriceLevel in a symbol string using methods of MarketEventSymbols class. The value of this constant is "pl". The value that this key shall be set to is equal to the corresponding CandlePriceLevel.toString()

See Also:

Constant Field Values

Method Detail

getValue

public double getValue()

Returns price level value. For example, the value of 1 represents [0;1), [1;2) and so on intervals to build candles.

Returns:

price level value.

equals

public boolean equals(Object o)

Indicates whether this price level is the same as another one. The same price level has the same value.

Overrides:

equals in class Object

Returns:

true if this price level is the same as another one.

hashCode

public int hashCode()

Returns hash code of this price level.

Overrides:

hashCode in class Object

Returns:

hash code of this price level.

toString

public String toString()

Returns string representation of this price level. The string representation is composed of value. This string representation can be converted back into object with parse(String) method.

Overrides:

toString in class Object

Returns:

string representation of this price level.

changeAttributeForSymbol

public String changeAttributeForSymbol(String symbol)

Returns candle event symbol string with this candle price level set.

Specified by:

changeAttributeForSymbol in interface CandleSymbolAttribute<CandlePriceLevel>

Parameters:

symbol - original candle event symbol.

Returns:

candle event symbol string with this candle price level set.

checkInAttributeImpl

public void checkInAttributeImpl(CandleSymbol candleSymbol)

Internal method that initializes attribute in the candle symbol.

Specified by:

checkInAttributeImpl in interface CandleSymbolAttribute<CandlePriceLevel>

Parameters:

candleSymbol - candle symbol.

Throws:

IllegalStateException - if used outside of internal initialization logic.

parse

public static CandlePriceLevel parse(String s)

Parses string representation of candle price level into object. Any string that was returned by toString() can be parsed and case is ignored for parsing.

Parameters:

s - string representation of candle price level.

Returns:

candle price level.

Throws:

IllegalArgumentException - if the string representation is invalid.

valueOf

public static CandlePriceLevel valueOf(double value)

Returns candle price level with the given value.

Parameters:

value - candle price level value.

Returns:

candle price level with the given value and type.

getAttributeForSymbol

public static CandlePriceLevel getAttributeForSymbol(String symbol)

Returns candle price level of the given candle symbol string. The result is DEFAULT if the symbol does not have candle price level attribute.

Parameters:

symbol - candle symbol string.

Returns:

candle price level of the given candle symbol string.

normalizeAttributeForSymbol

public static String normalizeAttributeForSymbol(String symbol)

Returns candle symbol string with the normalized representation of the candle price level attribute.

Parameters:

symbol - candle symbol string.

Returns:

candle symbol string with the normalized representation of the the candle price level attribute.