io.github.mainstringargs.polygon.enums

Enum FinancialSort

java.lang.Object

java.lang.Enum<FinancialSort>

io.github.mainstringargs.polygon.enums.FinancialSort

All Implemented Interfaces:

APIName, java.io.Serializable, java.lang.Comparable<FinancialSort>

public enum FinancialSort
extends java.lang.Enum<FinancialSort>
implements APIName

The enum Financial sort.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALENDAR_DATE_ASCENDING Calendar date ascending financial sort.
CALENDAR_DATE_DESCENDING Calendar date descending financial sort.
REPORT_PERIOD_ASCENDING Report period ascending financial sort.
REPORT_PERIOD_DESCENDING Report period descending financial sort

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAPIName() Gets the API name.
static FinancialSort	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FinancialSort[]	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

REPORT_PERIOD_ASCENDING

public static final FinancialSort REPORT_PERIOD_ASCENDING

Report period ascending financial sort.

REPORT_PERIOD_DESCENDING

public static final FinancialSort REPORT_PERIOD_DESCENDING

Report period descending financial sort

CALENDAR_DATE_ASCENDING

public static final FinancialSort CALENDAR_DATE_ASCENDING

Calendar date ascending financial sort.

CALENDAR_DATE_DESCENDING

public static final FinancialSort CALENDAR_DATE_DESCENDING

Calendar date descending financial sort.

Method Detail

values

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

Returns:

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

valueOf

public static FinancialSort valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAPIName

public java.lang.String getAPIName()

Description copied from interface: APIName

Gets the API name.

Specified by:

getAPIName in interface APIName

Returns:

the API name