com.dxfeed.event.market

Enum ShortSaleRestriction

java.lang.Object

java.lang.Enum<ShortSaleRestriction>

com.dxfeed.event.market.ShortSaleRestriction

All Implemented Interfaces:

Serializable, Comparable<ShortSaleRestriction>

public enum ShortSaleRestriction
extends Enum<ShortSaleRestriction>

Short sale restriction on an instrument.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Short sale restriction is active.
INACTIVE Short sale restriction is inactive.
UNDEFINED Short sale restriction is undefined, unknown or inapplicable.

Method Summary

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

Short sale restriction is undefined, unknown or inapplicable.

ACTIVE

public static final ShortSaleRestriction ACTIVE

Short sale restriction is active.

INACTIVE

public static final ShortSaleRestriction INACTIVE

Short sale restriction is inactive.

Method Detail

values

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

Returns:

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

valueOf

public static ShortSaleRestriction 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 ShortSaleRestriction valueOf(int code)

Returns restriction 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.