com.ampro.robinhood.endpoint.orders.enums

Enum TimeInForce

java.lang.Object

java.lang.Enum<TimeInForce>

com.ampro.robinhood.endpoint.orders.enums.TimeInForce

All Implemented Interfaces:

RobinhoodEnum, java.io.Serializable, java.lang.Comparable<TimeInForce>

public enum TimeInForce
extends java.lang.Enum<TimeInForce>
implements RobinhoodEnum

The time and/or duration an order will be active.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILL_OR_KILL
GOOD_FOR_DAY
GOOD_UNTIL_CANCELED
IMMEDIATE_OR_CANCEL
ON_MARKET_OPEN

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue() Get the Robinhood API's string that corresponds to this enum
static TimeInForce	parse(java.lang.String s) Parse a TimeInForce enum from a Robinhood API formatted string
java.lang.String	toString()
static TimeInForce	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimeInForce[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ampro.robinhood.endpoint.RobinhoodEnum

println

Enum Constant Detail

ON_MARKET_OPEN

public static final TimeInForce ON_MARKET_OPEN

IMMEDIATE_OR_CANCEL

public static final TimeInForce IMMEDIATE_OR_CANCEL

FILL_OR_KILL

public static final TimeInForce FILL_OR_KILL

GOOD_FOR_DAY

public static final TimeInForce GOOD_FOR_DAY

GOOD_UNTIL_CANCELED

public static final TimeInForce GOOD_UNTIL_CANCELED

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static TimeInForce parse(java.lang.String s)

Parse a TimeInForce enum from a Robinhood API formatted string

Parameters:

s - The string to parse from

Returns:

The TimeInForce parsed or null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TimeInForce>

getValue

public java.lang.String getValue()

Description copied from interface: RobinhoodEnum

Get the Robinhood API's string that corresponds to this enum

Specified by:

getValue in interface RobinhoodEnum

Returns:

The enum as a Robinhood JSON formatted string.