com.opengamma.strata.pricer.capfloor

Class IborCapletFloorletPeriodAmounts

java.lang.Object

com.opengamma.strata.pricer.capfloor.IborCapletFloorletPeriodAmounts

All Implemented Interfaces:

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

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

A map of double values keyed by Ibor caplet/floorlet periods.

The double values should represent the same metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static IborCapletFloorletPeriodAmounts.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
Optional<Double>	findAmount(IborCapletFloorletPeriod period) Gets a double amount for the provided Ibor caplet/floorlet.
double	getAmount(IborCapletFloorletPeriod period) Gets a double amount for the provided Ibor caplet/floorlet.
ImmutableMap<IborCapletFloorletPeriod,Double>	getAmounts() Gets the map of Ibor caplet/floorlet periods to the double amount.
int	hashCode()
static IborCapletFloorletPeriodAmounts.Meta	meta() The meta-bean for IborCapletFloorletPeriodAmounts.
IborCapletFloorletPeriodAmounts.Meta	metaBean()
static IborCapletFloorletPeriodAmounts	of(Map<IborCapletFloorletPeriod,Double> doubleMap) Obtains an instance of double amounts.
IborCapletFloorletPeriodAmounts.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 IborCapletFloorletPeriodAmounts of(Map<IborCapletFloorletPeriod,Double> doubleMap)

Obtains an instance of double amounts.

Parameters:

doubleMap - the map of doubles

Returns:

the instance

findAmount

public Optional<Double> findAmount(IborCapletFloorletPeriod period)

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

Parameters:

period - the ibor caplet/floorlet

Returns:

the double amount, empty if missing

getAmount

public double getAmount(IborCapletFloorletPeriod period)

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

Parameters:

period - the ibor caplet/floorlet

Returns:

the double amount

Throws:

IllegalArgumentException - if the period is missing

meta

public static IborCapletFloorletPeriodAmounts.Meta meta()

The meta-bean for IborCapletFloorletPeriodAmounts.

Returns:

the meta-bean, not null

builder

public static IborCapletFloorletPeriodAmounts.Builder builder()

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

Returns:

the builder, not null

metaBean

public IborCapletFloorletPeriodAmounts.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getAmounts

public ImmutableMap<IborCapletFloorletPeriod,Double> getAmounts()

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

Returns:

the value of the property, not null

toBuilder

public IborCapletFloorletPeriodAmounts.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