Package com.opengamma.strata.pricer.capfloor

Class IborCapletFloorletPeriodCurrencyAmounts

java.lang.Object

com.opengamma.strata.pricer.capfloor.IborCapletFloorletPeriodCurrencyAmounts

All Implemented Interfaces:

Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class IborCapletFloorletPeriodCurrencyAmounts
extends Object
implements org.joda.beans.ImmutableBean, Serializable

A map of currency amounts keyed by Ibor caplet/floorlet periods.

The currency amounts should represent the same metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IborCapletFloorletPeriodCurrencyAmounts.Builder	The bean-builder for IborCapletFloorletPeriodCurrencyAmounts.
static class	IborCapletFloorletPeriodCurrencyAmounts.Meta	The meta-bean for IborCapletFloorletPeriodCurrencyAmounts.

Method Summary

Modifier and Type	Method	Description
static IborCapletFloorletPeriodCurrencyAmounts.Builder	builder()	Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
Optional<CurrencyAmount>	findAmount(IborCapletFloorletPeriod period)	Gets a currency amount for the provided Ibor caplet/floorlet.
CurrencyAmount	getAmount(IborCapletFloorletPeriod period)	Gets a currency amount for the provided Ibor caplet/floorlet.
ImmutableMap<IborCapletFloorletPeriod,CurrencyAmount>	getAmounts()	Gets the map of Ibor caplet/floorlet periods to the currency amount.
int	hashCode()
static IborCapletFloorletPeriodCurrencyAmounts.Meta	meta()	The meta-bean for IborCapletFloorletPeriodCurrencyAmounts.
IborCapletFloorletPeriodCurrencyAmounts.Meta	metaBean()
static IborCapletFloorletPeriodCurrencyAmounts	of(Map<IborCapletFloorletPeriod,CurrencyAmount> currencyAmountMap)	Obtains an instance of currency amounts.
IborCapletFloorletPeriodCurrencyAmounts.Builder	toBuilder()	Returns a builder that allows this bean to be mutated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static IborCapletFloorletPeriodCurrencyAmounts of(Map<IborCapletFloorletPeriod,CurrencyAmount> currencyAmountMap)

Obtains an instance of currency amounts.

Parameters:

currencyAmountMap - the map of currency amounts

Returns:

the instance

findAmount

public Optional<CurrencyAmount> findAmount(IborCapletFloorletPeriod period)

Gets a currency amount for the provided Ibor caplet/floorlet.

Parameters:

period - the ibor caplet/floorlet

Returns:

the currency amount, empty if missing

getAmount

public CurrencyAmount getAmount(IborCapletFloorletPeriod period)

Gets a currency amount for the provided Ibor caplet/floorlet.

Parameters:

period - the ibor caplet/floorlet

Returns:

the currency amount

Throws:

IllegalArgumentException - if the period is missing

meta

public static IborCapletFloorletPeriodCurrencyAmounts.Meta meta()

The meta-bean for IborCapletFloorletPeriodCurrencyAmounts.

Returns:

the meta-bean, not null

builder

public static IborCapletFloorletPeriodCurrencyAmounts.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public IborCapletFloorletPeriodCurrencyAmounts.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getAmounts

public ImmutableMap<IborCapletFloorletPeriod,CurrencyAmount> getAmounts()

Gets the map of Ibor caplet/floorlet periods to the currency amount.

Returns:

the value of the property, not null

toBuilder

public IborCapletFloorletPeriodCurrencyAmounts.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object