com.opengamma.strata.product.swap

Enum FixedAccrualMethod

java.lang.Object

java.lang.Enum<FixedAccrualMethod>

com.opengamma.strata.product.swap.FixedAccrualMethod

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<FixedAccrualMethod>

public enum FixedAccrualMethod
extends Enum<FixedAccrualMethod>
implements NamedEnum

The method of accruing interest on a notional amount using a fixed rate.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT The default method.
OVERNIGHT_COMPOUNDED_ANNUAL_RATE Defines overnight compounding using an annual rate.

Method Summary

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

DEFAULT

public static final FixedAccrualMethod DEFAULT

The default method.

The notional accrues no interest.

This is the most common type for fixed legs.

OVERNIGHT_COMPOUNDED_ANNUAL_RATE

public static final FixedAccrualMethod OVERNIGHT_COMPOUNDED_ANNUAL_RATE

Defines overnight compounding using an annual rate.

The notional accrues interest on an overnight basis using an annual fixed rate.

This is the most common type for Brazilian style fixed legs.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<FixedAccrualMethod>

Returns:

the formatted string representing the type