Enum Class PositionFamily

java.lang.Object

java.lang.Enum<PositionFamily>

com.bluebell.greenhouse.platform.enums.position.PositionFamily

All Implemented Interfaces:

GenericEnum<PositionFamily>, Serializable, Comparable<PositionFamily>, Constable

public enum PositionFamily
extends Enum<PositionFamily>
implements GenericEnum<PositionFamily>

Representation of a Position's family, indicating the type of financial derivative being used in the market.

Version:

2.0.6

Author:

Stephen Prizio

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CFD
FOREX
FUTURE
OPTION
SHARE

Method Summary

Modifier and Type	Method	Description
static PositionFamily	fromAccountType(AccountType accountType)	Resolves a PositionFamily from an AccountType.
static PositionFamily	fromSymbolType(SymbolType symbolType)	Resolves a PositionFamily from a SymbolType when the mapping is explicit.
static PositionFamily	fromTradePlatform(AccountTradingPlatform accountTradingPlatform)	Resolves a PositionFamily from a AccountTradingPlatform.
static PositionFamily	resolve(SymbolType symbolType, AccountType accountType, AccountTradingPlatform accountPlatform)	Resolves the effective PositionFamily from the available context.
static PositionFamily	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PositionFamily[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GenericEnum

getCode, getEnum, getLabel

Enum Constant Details

CFD

public static final PositionFamily CFD

FOREX

public static final PositionFamily FOREX

FUTURE

public static final PositionFamily FUTURE

OPTION

public static final PositionFamily OPTION

SHARE

public static final PositionFamily SHARE

Method Details

values

public static PositionFamily[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PositionFamily valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromSymbolType

public static PositionFamily fromSymbolType(SymbolType symbolType)

Resolves a PositionFamily from a SymbolType when the mapping is explicit.

Parameters:

symbolType - SymbolType

Returns:

PositionFamily

fromAccountType

public static PositionFamily fromAccountType(AccountType accountType)

Resolves a PositionFamily from an AccountType.

Parameters:

accountType - AccountType

Returns:

PositionFamily

fromTradePlatform

public static PositionFamily fromTradePlatform(AccountTradingPlatform accountTradingPlatform)

Resolves a PositionFamily from a AccountTradingPlatform.

Parameters:

accountTradingPlatform - AccountTradingPlatform

Returns:

PositionFamily

resolve

public static PositionFamily resolve(SymbolType symbolType,
 AccountType accountType,
 AccountTradingPlatform accountPlatform)

Resolves the effective PositionFamily from the available context.

Parameters:

symbolType - SymbolType

accountType - AccountType

accountPlatform - account trade platform

Returns:

PositionFamily