io.github.mainstringargs.polygon.enums

Enum TickerSort

java.lang.Object

java.lang.Enum<TickerSort>

io.github.mainstringargs.polygon.enums.TickerSort

All Implemented Interfaces:

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

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

The enum Ticker sort.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TICKER_ASCENDING The ticker ascending.
TICKER_DESCENDING The ticker descending.
TYPE_ASCENDING The type ascending.
TYPE_DESCENDING The type descending.

Method Summary

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

TICKER_ASCENDING

public static final TickerSort TICKER_ASCENDING

The ticker ascending.

TICKER_DESCENDING

public static final TickerSort TICKER_DESCENDING

The ticker descending.

TYPE_ASCENDING

public static final TickerSort TYPE_ASCENDING

The type ascending.

TYPE_DESCENDING

public static final TickerSort TYPE_DESCENDING

The type descending.

Method Detail

values

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

Returns:

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

valueOf

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