io.github.mainstringargs.alpaca.enums

Enum PortfolioPeriodUnit

java.lang.Object

java.lang.Enum<PortfolioPeriodUnit>

io.github.mainstringargs.alpaca.enums.PortfolioPeriodUnit

All Implemented Interfaces:

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

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

The enum Portfolio period unit.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY Day portfolio period unit.
MONTH Month portfolio period unit.
WEEK Week portfolio period unit.
YEAR Year portfolio period unit.

Method Summary

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

DAY

public static final PortfolioPeriodUnit DAY

Day portfolio period unit.

WEEK

public static final PortfolioPeriodUnit WEEK

Week portfolio period unit.

MONTH

public static final PortfolioPeriodUnit MONTH

Month portfolio period unit.

YEAR

public static final PortfolioPeriodUnit YEAR

Year portfolio period unit.

Method Detail

values

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

Returns:

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

valueOf

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