com.opengamma.strata.product.common

Enum CapFloor

java.lang.Object

java.lang.Enum<CapFloor>

com.opengamma.strata.product.common.CapFloor

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<CapFloor>

public enum CapFloor
extends Enum<CapFloor>
implements NamedEnum

Flag indicating whether a financial instrument is "cap" or a "floor".

Specifies whether the financial instrument is cap or a floor. For example, in an interest rate cap the buyer receives payments at the end of each period in which the interest rate exceeds the agreed strike price.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAP Cap.
FLOOR Floor.

Method Summary

Modifier and Type	Method and Description
boolean	isCap() Checks if the type is 'Cap'.
boolean	isFloor() Checks if the type is 'Floor'.
static CapFloor	of(String name) Obtains an instance from the specified name.
CapFloor	opposite() Supplies the opposite of this value.
String	toString() Returns the formatted name of the type.
static CapFloor	valueOf(String name) Returns the enum constant of this type with the specified name.
static CapFloor[]	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.opengamma.strata.collect.named.NamedEnum

getName

Methods inherited from interface com.opengamma.strata.collect.named.Named

of

Enum Constant Detail

CAP

public static final CapFloor CAP

Cap.

FLOOR

public static final CapFloor FLOOR

Floor.

Method Detail

values

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

Returns:

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

valueOf

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

of

public static CapFloor of(String name)

Obtains an instance from the specified name.

Parsing handles the mixed case form produced by toString() and the upper and lower case variants of the enum constant name.

Parameters:

name - the name to parse

Returns:

the type

Throws:

IllegalArgumentException - if the name is not known

isCap

public boolean isCap()

Checks if the type is 'Cap'.

Returns:

true if cap, false if floor

isFloor

public boolean isFloor()

Checks if the type is 'Floor'.

Returns:

true if floor, false if cap

opposite

public CapFloor opposite()

Supplies the opposite of this value.

Returns:

the opposite value

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<CapFloor>

Returns:

the formatted string representing the type