io.github.mainstringargs.alpaca.enums

Enum BarsTimeFrame

java.lang.Object

java.lang.Enum<BarsTimeFrame>

io.github.mainstringargs.alpaca.enums.BarsTimeFrame

All Implemented Interfaces:

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

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

The Enum BarsTimeFrame.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIFTEEN_MINUTE Fifteen minute bars time frame.
FIVE_MINUTE Five minute bars time frame.
ONE_DAY One day bars time frame.
ONE_MIN One min bars time frame.

Method Summary

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

ONE_MIN

public static final BarsTimeFrame ONE_MIN

One min bars time frame.

FIVE_MINUTE

public static final BarsTimeFrame FIVE_MINUTE

Five minute bars time frame.

FIFTEEN_MINUTE

public static final BarsTimeFrame FIFTEEN_MINUTE

Fifteen minute bars time frame.

ONE_DAY

public static final BarsTimeFrame ONE_DAY

One day bars time frame.

Method Detail

values

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

Returns:

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

valueOf

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