Caplin Systems - BuySell (FX Integration API Documentation)

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

All Implemented Interfaces:

Serializable, Comparable<BuySell>
```
public enum BuySell
extends Enum<BuySell>
```
Represents either a BUY or SELL side of a trade.

Enum Constant Summary

Enum Constants
Enum Constant Description

BUY
The BUY side of a trade

SELL
The SELL side of a trade

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BuySell`	`opposite()`	Returns the opposite side.
`static BuySell`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static BuySell[]`	`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 BuySell BUY
```
    The BUY side of a trade
  - SELL
```
public static final BuySell SELL
```
    The SELL side of a trade
- Method Detail
  - values
```
public static BuySell[] 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 (BuySell c : BuySell.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BuySell 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
  - opposite
```
public BuySell opposite()
```
    Returns the opposite side.
    
    Returns:
    
    the opposite side.