Class ImmutableFixedInflationSwapConvention
- java.lang.Object
-
- com.opengamma.strata.product.swap.type.ImmutableFixedInflationSwapConvention
-
- All Implemented Interfaces:
Named
,FixedInflationSwapConvention
,SingleCurrencySwapConvention
,TradeConvention
,Serializable
,org.joda.beans.Bean
,org.joda.beans.ImmutableBean
public final class ImmutableFixedInflationSwapConvention extends Object implements FixedInflationSwapConvention, org.joda.beans.ImmutableBean, Serializable
A market convention for Fixed-Inflation swap trades.This defines the market convention for a Fixed-Inflation single currency swap. The convention is formed by combining two swap leg conventions in the same currency.
The convention is defined by four key dates.
- Trade date, the date that the trade is agreed
- Spot date, the base for date calculations, typically 2 business days after the trade date
- Start date, the date on which the interest calculation starts, often the same as the spot date
- End date, the date on which the interest calculation ends, typically a number of years after the start date
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableFixedInflationSwapConvention.Builder
The bean-builder forImmutableFixedInflationSwapConvention
.static class
ImmutableFixedInflationSwapConvention.Meta
The meta-bean forImmutableFixedInflationSwapConvention
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImmutableFixedInflationSwapConvention.Builder
builder()
Returns a builder used to create an instance of the bean.boolean
equals(Object obj)
FixedRateSwapLegConvention
getFixedLeg()
Gets the market convention of the fixed leg.InflationRateSwapLegConvention
getFloatingLeg()
Gets the market convention of the floating leg.String
getName()
Gets the convention name, such as 'USD-FIXED-6M-LIBOR-3M'.DaysAdjustment
getSpotDateOffset()
Gets the offset of the spot value date from the trade date.int
hashCode()
static ImmutableFixedInflationSwapConvention.Meta
meta()
The meta-bean forImmutableFixedInflationSwapConvention
.ImmutableFixedInflationSwapConvention.Meta
metaBean()
static ImmutableFixedInflationSwapConvention
of(String name, FixedRateSwapLegConvention fixedLeg, InflationRateSwapLegConvention floatingLeg, DaysAdjustment spotDateOffset)
Obtains a convention based on the specified name and leg conventions.ImmutableFixedInflationSwapConvention.Builder
toBuilder()
Returns a builder that allows this bean to be mutated.String
toString()
SwapTrade
toTrade(TradeInfo tradeInfo, LocalDate startDate, LocalDate endDate, BuySell buySell, double notional, double fixedRate)
Creates a trade based on this convention.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.opengamma.strata.product.swap.type.FixedInflationSwapConvention
createTrade, createTrade, toTrade
-
Methods inherited from interface com.opengamma.strata.product.swap.type.SingleCurrencySwapConvention
calculateSpotDateFromTradeDate
-
-
-
-
Method Detail
-
of
public static ImmutableFixedInflationSwapConvention of(String name, FixedRateSwapLegConvention fixedLeg, InflationRateSwapLegConvention floatingLeg, DaysAdjustment spotDateOffset)
Obtains a convention based on the specified name and leg conventions.The two leg conventions must be in the same currency.
- Parameters:
name
- the unique name of the conventionfixedLeg
- the market convention for the fixed legfloatingLeg
- the market convention for the floating legspotDateOffset
- the offset of the spot value date from the trade date- Returns:
- the convention
-
toTrade
public SwapTrade toTrade(TradeInfo tradeInfo, LocalDate startDate, LocalDate endDate, BuySell buySell, double notional, double fixedRate)
Description copied from interface:FixedInflationSwapConvention
Creates a trade based on this convention.This returns a trade based on the specified dates.
The notional is unsigned, with buy/sell determining the direction of the trade. If buying the swap, the floating rate is received from the counterparty, with the fixed rate being paid. If selling the swap, the floating rate is paid to the counterparty, with the fixed rate being received.
- Specified by:
toTrade
in interfaceFixedInflationSwapConvention
- Specified by:
toTrade
in interfaceSingleCurrencySwapConvention
- Parameters:
tradeInfo
- additional information about the tradestartDate
- the start dateendDate
- the end datebuySell
- the buy/sell flagnotional
- the notional amountfixedRate
- the fixed rate, typically derived from the market- Returns:
- the trade
-
meta
public static ImmutableFixedInflationSwapConvention.Meta meta()
The meta-bean forImmutableFixedInflationSwapConvention
.- Returns:
- the meta-bean, not null
-
builder
public static ImmutableFixedInflationSwapConvention.Builder builder()
Returns a builder used to create an instance of the bean.- Returns:
- the builder, not null
-
metaBean
public ImmutableFixedInflationSwapConvention.Meta metaBean()
- Specified by:
metaBean
in interfaceorg.joda.beans.Bean
-
getName
public String getName()
Gets the convention name, such as 'USD-FIXED-6M-LIBOR-3M'.- Specified by:
getName
in interfaceFixedInflationSwapConvention
- Specified by:
getName
in interfaceNamed
- Specified by:
getName
in interfaceSingleCurrencySwapConvention
- Returns:
- the value of the property, not null
-
getFixedLeg
public FixedRateSwapLegConvention getFixedLeg()
Gets the market convention of the fixed leg.- Specified by:
getFixedLeg
in interfaceFixedInflationSwapConvention
- Returns:
- the value of the property, not null
-
getFloatingLeg
public InflationRateSwapLegConvention getFloatingLeg()
Gets the market convention of the floating leg.- Specified by:
getFloatingLeg
in interfaceFixedInflationSwapConvention
- Returns:
- the value of the property, not null
-
getSpotDateOffset
public DaysAdjustment getSpotDateOffset()
Gets the offset of the spot value date from the trade date.The offset is applied to the trade date to find the start date. A typical value is "plus 2 business days".
- Specified by:
getSpotDateOffset
in interfaceSingleCurrencySwapConvention
- Returns:
- the value of the property, not null
-
toBuilder
public ImmutableFixedInflationSwapConvention.Builder toBuilder()
Returns a builder that allows this bean to be mutated.- Returns:
- the mutable builder, not null
-
-