com.opengamma.strata.product.credit

Enum PaymentOnDefault

java.lang.Object

java.lang.Enum<PaymentOnDefault>

com.opengamma.strata.product.credit.PaymentOnDefault

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<PaymentOnDefault>

public enum PaymentOnDefault
extends Enum<PaymentOnDefault>
implements NamedEnum

The payment on default.

Whether the accrued premium is paid in the event of a default.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCRUED_PREMIUM The accrued premium.
NONE None.

Method Summary

Modifier and Type	Method and Description
boolean	isAccruedInterest() Check if the accrued premium is paid.
static PaymentOnDefault	of(String name) Obtains an instance from the specified name.
String	toString() Returns the formatted name of the type.
static PaymentOnDefault	valueOf(String name) Returns the enum constant of this type with the specified name.
static PaymentOnDefault[]	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

ACCRUED_PREMIUM

public static final PaymentOnDefault ACCRUED_PREMIUM

The accrued premium.

If the credit event happens between coupon dates, the accrued premium is paid.

NONE

public static final PaymentOnDefault NONE

None.

Even if the credit event happens between coupon dates, the accrued premium is not paid.

Method Detail

values

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

Returns:

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

valueOf

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

isAccruedInterest

public boolean isAccruedInterest()

Check if the accrued premium is paid.

Returns:

true if the accrued premium is paid, false otherwise

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<PaymentOnDefault>

Returns:

the formatted string representing the type