com.dxfeed.event.market

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

com.dxfeed.event.market.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Direction of the price movement. For example tick direction for last trade price.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Current price is lower than previous price.
UNDEFINED Direction is undefined, unknown or inapplicable.
UP Current price is higher than previous price.
ZERO Current price is equal to the only known price value suitable for price direction computation.
ZERO_DOWN Current price is the same as previous price and is lower than the last known price of different value.
ZERO_UP Current price is the same as previous price and is higher than the last known price of different value.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns integer code that is used in flag bits.
static Direction	valueOf(int code) Returns direction by integer code bit pattern.
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

UNDEFINED

public static final Direction UNDEFINED

Direction is undefined, unknown or inapplicable. It includes cases with undefined price value or when direction computation was not performed.

DOWN

public static final Direction DOWN

Current price is lower than previous price.

ZERO_DOWN

public static final Direction ZERO_DOWN

Current price is the same as previous price and is lower than the last known price of different value.

ZERO

public static final Direction ZERO

Current price is equal to the only known price value suitable for price direction computation. Unlike UNDEFINED the ZERO direction implies that current price is defined and direction computation was duly performed but has failed to detect any upward or downward price movement. It is also reported for cases when price sequence was broken and direction computation was restarted anew.

ZERO_UP

public static final Direction ZERO_UP

Current price is the same as previous price and is higher than the last known price of different value.

UP

public static final Direction UP

Current price is higher than previous price.

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static Direction valueOf(int code)

Returns direction by integer code bit pattern.

Parameters:

code - integer code.

Returns:

restriction.

Throws:

ArrayIndexOutOfBoundsException - if code is invalid.

getCode

public int getCode()

Returns integer code that is used in flag bits.

Returns:

integer code.