com.opengamma.strata.product.option

Enum BarrierType

java.lang.Object

java.lang.Enum<BarrierType>

com.opengamma.strata.product.option.BarrierType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<BarrierType>

public enum BarrierType
extends Enum<BarrierType>
implements NamedEnum

The barrier type of barrier event.

This defines the barrier type of Barrier.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Down
UP Up

Method Summary

Modifier and Type	Method and Description
boolean	isDown() Checks if the type is 'Down'.
static BarrierType	of(String name) Obtains an instance from the specified name.
String	toString() Returns the formatted name of the type.
static BarrierType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BarrierType[]	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

DOWN

public static final BarrierType DOWN

Down

UP

public static final BarrierType UP

Up

Method Detail

values

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

Returns:

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

valueOf

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

isDown

public boolean isDown()

Checks if the type is 'Down'.

Returns:

true if down, false if up

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<BarrierType>

Returns:

the formatted string representing the type