Interface GenericEnum<E>

Type Parameters:

E - java enum

All Known Subinterfaces:

GenericIndicatorEnum, GenericIsoEnum<I>, GenericSymbolizedEnum<S>

All Known Implementing Classes:

AccountBalanceTimelinePointType, AccountLedgerAggregation, AccountLedgerEntryType, AccountLedgerSource, AccountTradingPlatform, AccountType, ActionEventSeverity, ActionStatus, AnalysisFilter, AntherSignal, ApiErrorReason, ApiQueryParameterType, BalancePerformanceMetric, BalancePerformancePeriod, Broker, Country, Currency, DataSource, EmailTemplate, EODTechnicalIndicatorFunction, ExpansionState, ImportFormat, IncomingPingType, IndicatorType, InsightType, JobConcurrencyPolicy, JobIdempotencyPolicy, JobStatus, JobTriggerType, JobType, Language, MarketEventSeverity, MarketNewsImageStatus, MarketNewsSentimentGrade, MarketNewsSentimentLabel, MarketPriceFetchRequestStatus, MarketTimeInterval, MetaTrader4TradeType, OptionType, PositionCloseReason, PositionDurationFilter, PositionFamily, PositionOrderType, PositionTransactionType, PositionType, RecordTimeInterval, RecurringNotificationFrequency, RecurringNotificationType, StrategyImplementationType, StrategySignalState, SymbolAliasType, SymbolRegistryAttribute, SymbolRegistryEntrySortField, SymbolRevision, SymbolType, TransactionDirection, TransactionStatus, TransactionType, TrendDirection, TrendRegime, UserRole

public interface GenericEnum<E>

Base enum giving core attributes used throughout the app.

Version:

1.0.1

Author:

Stephen Prizio

Method Summary

Modifier and Type	Method	Description
static <E extends Enum<E> & GenericEnum<E>> List<EnumDisplay>	convertAllToEnumDisplay(E[] genericEnums)	Converts an array of GenericEnum into a List of EnumDisplay.
static <E extends Enum<E> & GenericEnum<E>> List<EnumDisplay>	convertAllToEnumDisplay(Collection<E> genericEnums)	Converts a Collection of GenericEnum into a List of EnumDisplay.
static <E extends Enum<E> & GenericEnum<E>> EnumDisplay	convertToEnumDisplay(E genericEnum)	Converts a GenericEnum into an EnumDisplay.
static <E extends Enum<E> & GenericEnum<E>> TreeSet<String>	getAsSortedSetOfKeys(E[] values, Function<E,String> mappingFunction)	Returns a sorted set of keys for the given E and mapping function.
static <E extends Enum<E> & GenericEnum<E>> E	getByCode(Class<E> clazz, String code)	Obtains the associated enum by its code.
String	getCode()	Obtains the enum code, unique id used for fetching.
default E	getEnum(Class<E> enumClass)	Returns the base enum type.
String	getLabel()	Obtains the enum label, display string.

Method Details

getCode

String getCode()

Obtains the enum code, unique id used for fetching.

Returns:

code

getLabel

String getLabel()

Obtains the enum label, display string.

Returns:

display string

getEnum

default E getEnum(Class<E> enumClass)

Returns the base enum type.

Parameters:

enumClass - Class

Returns:

E

getByCode

static <E extends Enum<E> & GenericEnum<E>> E getByCode(Class<E> clazz,
 String code)

Obtains the associated enum by its code.

Type Parameters:

E - java enum

Parameters:

clazz - enum class

code - enum code

Returns:

E

convertToEnumDisplay

static <E extends Enum<E> & GenericEnum<E>>
EnumDisplay convertToEnumDisplay(E genericEnum)

Converts a GenericEnum into an EnumDisplay.

Type Parameters:

E - java enum

Parameters:

genericEnum - GenericEnum

Returns:

EnumDisplay

convertAllToEnumDisplay

static <E extends Enum<E> & GenericEnum<E>>
List<EnumDisplay> convertAllToEnumDisplay(E[] genericEnums)

Converts an array of GenericEnum into a List of EnumDisplay.

Type Parameters:

E - java enum

Parameters:

genericEnums - array of GenericEnum

Returns:

List of EnumDisplay

convertAllToEnumDisplay

static <E extends Enum<E> & GenericEnum<E>>
List<EnumDisplay> convertAllToEnumDisplay(Collection<E> genericEnums)

Converts a Collection of GenericEnum into a List of EnumDisplay.

Type Parameters:

E - java enum

Parameters:

genericEnums - Collection of GenericEnum

Returns:

List of EnumDisplay

getAsSortedSetOfKeys

static <E extends Enum<E> & GenericEnum<E>>
TreeSet<String> getAsSortedSetOfKeys(E[] values,
 Function<E,String> mappingFunction)

Returns a sorted set of keys for the given E and mapping function.

Type Parameters:

E - E child of GenericEnum

Parameters:

values - array of E

mappingFunction - Function

Returns:

TreeSet