Caplin Systems - LegType (FX Integration API Documentation)

java.lang.Object
- java.lang.Enum<LegType>
- - com.caplin.motif.fx.trading.LegType

All Implemented Interfaces:

Serializable, Comparable<LegType>
```
public enum LegType
extends Enum<LegType>
```
The LegType denotes the set of enums that represent the type of leg types available in the Motif.

Enum Constant Summary

Enum Constants
Enum Constant Description

FAR
The far leg of a trade

NEAR
The near leg of a trade

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`toString()`
`static LegType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static LegType[]`	`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

- Enum Constant Detail
  - NEAR
```
public static final LegType NEAR
```
    The near leg of a trade
  - FAR
```
public static final LegType FAR
```
    The far leg of a trade
- Method Detail
  - values
```
public static LegType[] 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 (LegType c : LegType.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LegType valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<LegType>