io.github.mainstringargs.alpaca.enums

Enum OrderSide

java.lang.Object

java.lang.Enum<OrderSide>

io.github.mainstringargs.alpaca.enums.OrderSide

All Implemented Interfaces:

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

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

The Enum OrderSide.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUY The buy.
SELL The sell.

Method Summary

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

BUY

public static final OrderSide BUY

The buy.

SELL

public static final OrderSide SELL

The sell.

Method Detail

values

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

Returns:

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

valueOf

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