com.lmax.api
Enum TimeInForce

java.lang.Object
  extended by java.lang.Enum<TimeInForce>
      extended by com.lmax.api.TimeInForce
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TimeInForce>

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

The time in force policy applicable to orders.


Enum Constant Summary
FILL_OR_KILL
           
GOOD_FOR_DAY
           
GOOD_TIL_CANCELLED
           
IMMEDIATE_OR_CANCEL
           
UNKNOWN
           
 
Method Summary
 java.lang.String asCamelCase()
          Life span of the order.
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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FILL_OR_KILL

public static final TimeInForce FILL_OR_KILL

IMMEDIATE_OR_CANCEL

public static final TimeInForce IMMEDIATE_OR_CANCEL

GOOD_FOR_DAY

public static final TimeInForce GOOD_FOR_DAY

GOOD_TIL_CANCELLED

public static final TimeInForce GOOD_TIL_CANCELLED

UNKNOWN

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

asCamelCase

public java.lang.String asCamelCase()
Life span of the order.

Returns:
The representation of this enum used by the protocol