io.github.mainstringargs.polygon.enums

Enum Timespan

java.lang.Object

java.lang.Enum<Timespan>

io.github.mainstringargs.polygon.enums.Timespan

All Implemented Interfaces:

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

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

The Enum Timespan.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY The Day.
HOUR The Hour.
MINUTE The Minute.
MONTH The Month.
QUARTER The Quarter.
WEEK The Week.
YEAR The Year.

Method Summary

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

MINUTE

public static final Timespan MINUTE

The Minute.

HOUR

public static final Timespan HOUR

The Hour.

DAY

public static final Timespan DAY

The Day.

WEEK

public static final Timespan WEEK

The Week.

MONTH

public static final Timespan MONTH

The Month.

QUARTER

public static final Timespan QUARTER

The Quarter.

YEAR

public static final Timespan YEAR

The Year.

Method Detail

values

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

Returns:

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

valueOf

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