Enum Class Side

java.lang.Object

java.lang.Enum<Side>

com.quantfinlib.orderbook.Side

All Implemented Interfaces:

Serializable, Comparable<Side>, Constable

public enum Side
extends Enum<Side>

Order side.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUY
SELL

Method Summary

Modifier and Type	Method	Description
Side	opposite()
int	sign()	+1 for BUY, -1 for SELL — for signed cost/slippage arithmetic.
static Side	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Side[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BUY

public static final Side BUY

SELL

public static final Side SELL

Method Details

values

public static Side[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Side valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

sign

public int sign()

+1 for BUY, -1 for SELL — for signed cost/slippage arithmetic.

opposite

public Side opposite()