/**
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.product.bond;
import static com.google.common.base.MoreObjects.firstNonNull;
import java.io.Serializable;
import java.time.LocalDate;
import java.time.temporal.TemporalAdjuster;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import org.joda.beans.Bean;
import org.joda.beans.BeanDefinition;
import org.joda.beans.ImmutableBean;
import org.joda.beans.ImmutableConstructor;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaProperty;
import org.joda.beans.Property;
import org.joda.beans.PropertyDefinition;
import org.joda.beans.impl.direct.DirectFieldsBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaBean;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.google.common.collect.ImmutableSet;
import com.opengamma.strata.basics.currency.Currency;
import com.opengamma.strata.basics.index.Index;
import com.opengamma.strata.collect.ArgChecker;
import com.opengamma.strata.product.rate.InflationEndInterpolatedRateComputation;
import com.opengamma.strata.product.rate.InflationEndMonthRateComputation;
import com.opengamma.strata.product.rate.RateComputation;
/**
* A coupon or nominal payment of capital indexed bonds.
* <p>
* A single payment period within a capital indexed bond, {@link ResolvedCapitalIndexedBond}.
* Since All the cash flows of the capital indexed bond are adjusted for inflation,
* both of the periodic payments and nominal payment are represented by this class.
*/
@BeanDefinition
public final class CapitalIndexedBondPaymentPeriod
implements BondPaymentPeriod, ImmutableBean, Serializable {
/**
* The primary currency of the payment period.
* <p>
* The amounts of the notional are usually expressed in terms of this currency,
* however they can be converted from amounts in a different currency.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final Currency currency;
/**
* The notional amount, must be non-zero.
* <p>
* The notional amount applicable during the period.
* The currency of the notional is specified by {@code currency}.
*/
@PropertyDefinition
private final double notional;
/**
* The rate of real coupon.
* <p>
* The real coupon is the rate before taking the inflation into account.
* For example, a real coupon of c for semi-annual payments is c/2.
*/
@PropertyDefinition
private final double realCoupon;
/**
* The start date of the payment period.
* <p>
* This is the first date in the period.
* If the schedule adjusts for business days, then this is the adjusted date.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final LocalDate startDate;
/**
* The end date of the payment period.
* <p>
* This is the last date in the period.
* If the schedule adjusts for business days, then this is the adjusted date.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final LocalDate endDate;
/**
* The unadjusted start date.
* <p>
* The start date before any business day adjustment is applied.
* <p>
* When building, this will default to the start date if not specified.
*/
@PropertyDefinition(validate = "notNull")
private final LocalDate unadjustedStartDate;
/**
* The unadjusted end date.
* <p>
* The end date before any business day adjustment is applied.
* <p>
* When building, this will default to the end date if not specified.
*/
@PropertyDefinition(validate = "notNull")
private final LocalDate unadjustedEndDate;
/**
* The detachment date.
* <p>
* Some bonds trade ex-coupon before the coupon payment.
* The coupon is paid not to the owner of the bond on the payment date but to the
* owner of the bond on the detachment date.
* <p>
* When building, this will default to the end date if not specified.
*/
@PropertyDefinition(validate = "notNull")
private final LocalDate detachmentDate;
/**
* The rate to be computed.
* <p>
* The value of the period is based on this rate.
* This must be an inflation rate observation, specifically {@link InflationEndInterpolatedRateComputation}
* or {@link InflationEndMonthRateComputation}.
*/
@PropertyDefinition(validate = "notNull")
private final RateComputation rateComputation;
//-------------------------------------------------------------------------
@ImmutableConstructor
private CapitalIndexedBondPaymentPeriod(
Currency currency,
double notional,
double realCoupon,
LocalDate startDate,
LocalDate endDate,
LocalDate unadjustedStartDate,
LocalDate unadjustedEndDate,
LocalDate detachmentDate,
RateComputation rateComputation) {
this.currency = ArgChecker.notNull(currency, "currency");
this.notional = ArgChecker.notZero(notional, 0d, "notional");
this.realCoupon = ArgChecker.notNegative(realCoupon, "realCoupon");
this.startDate = ArgChecker.notNull(startDate, "startDate");
this.endDate = ArgChecker.notNull(endDate, "endDate");
this.unadjustedStartDate = firstNonNull(unadjustedStartDate, startDate);
this.unadjustedEndDate = firstNonNull(unadjustedEndDate, endDate);
this.detachmentDate = firstNonNull(detachmentDate, endDate);
this.rateComputation = ArgChecker.notNull(rateComputation, "rateComputation");
ArgChecker.inOrderNotEqual(startDate, endDate, "startDate", "endDate");
ArgChecker.inOrderNotEqual(
this.unadjustedStartDate, this.unadjustedEndDate, "unadjustedStartDate", "unadjustedEndDate");
ArgChecker.inOrderOrEqual(this.detachmentDate, this.endDate, "detachmentDate", "endDate");
ArgChecker.isTrue(rateComputation instanceof InflationEndInterpolatedRateComputation ||
rateComputation instanceof InflationEndMonthRateComputation,
"rateComputation must be inflation rate observation");
}
//-------------------------------------------------------------------------
/**
* Creates a payment period with unit real coupon and 0 ex-coupon days from this instance.
* <p>
* The main use of this method is to create a nominal payment from the final periodic payment.
*
* @param startDate the start date
* @param unadjustedStartDate the unadjusted start date
* @return the payment period
*/
CapitalIndexedBondPaymentPeriod withUnitCoupon(LocalDate startDate, LocalDate unadjustedStartDate) {
return new CapitalIndexedBondPaymentPeriod(
currency,
notional,
1d,
startDate,
endDate,
unadjustedStartDate,
unadjustedEndDate,
endDate,
rateComputation);
}
//-------------------------------------------------------------------------
@Override
public void collectIndices(ImmutableSet.Builder<Index> builder) {
rateComputation.collectIndices(builder);
}
@Override
public CapitalIndexedBondPaymentPeriod adjustPaymentDate(TemporalAdjuster adjuster) {
return this;
}
@Override
public LocalDate getPaymentDate() {
return getEndDate();
}
/**
* Checks if there is an ex-coupon period.
*
* @return true if has an ex-coupon period
*/
public boolean hasExCouponPeriod() {
return !detachmentDate.equals(endDate);
}
/**
* Checks if this period contains the specified date, based on unadjusted dates.
* <p>
* The unadjusted start and end dates are used in the comparison.
* The unadjusted start date is included, the unadjusted end date is excluded.
*
* @param date the date to check
* @return true if this period contains the date
*/
boolean contains(LocalDate date) {
return !date.isBefore(unadjustedStartDate) && date.isBefore(unadjustedEndDate);
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code CapitalIndexedBondPaymentPeriod}.
* @return the meta-bean, not null
*/
public static CapitalIndexedBondPaymentPeriod.Meta meta() {
return CapitalIndexedBondPaymentPeriod.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(CapitalIndexedBondPaymentPeriod.Meta.INSTANCE);
}
/**
* The serialization version id.
*/
private static final long serialVersionUID = 1L;
/**
* Returns a builder used to create an instance of the bean.
* @return the builder, not null
*/
public static CapitalIndexedBondPaymentPeriod.Builder builder() {
return new CapitalIndexedBondPaymentPeriod.Builder();
}
@Override
public CapitalIndexedBondPaymentPeriod.Meta metaBean() {
return CapitalIndexedBondPaymentPeriod.Meta.INSTANCE;
}
@Override
public <R> Property<R> property(String propertyName) {
return metaBean().<R>metaProperty(propertyName).createProperty(this);
}
@Override
public Set<String> propertyNames() {
return metaBean().metaPropertyMap().keySet();
}
//-----------------------------------------------------------------------
/**
* Gets the primary currency of the payment period.
* <p>
* The amounts of the notional are usually expressed in terms of this currency,
* however they can be converted from amounts in a different currency.
* @return the value of the property, not null
*/
@Override
public Currency getCurrency() {
return currency;
}
//-----------------------------------------------------------------------
/**
* Gets the notional amount, must be non-zero.
* <p>
* The notional amount applicable during the period.
* The currency of the notional is specified by {@code currency}.
* @return the value of the property
*/
public double getNotional() {
return notional;
}
//-----------------------------------------------------------------------
/**
* Gets the rate of real coupon.
* <p>
* The real coupon is the rate before taking the inflation into account.
* For example, a real coupon of c for semi-annual payments is c/2.
* @return the value of the property
*/
public double getRealCoupon() {
return realCoupon;
}
//-----------------------------------------------------------------------
/**
* Gets the start date of the payment period.
* <p>
* This is the first date in the period.
* If the schedule adjusts for business days, then this is the adjusted date.
* @return the value of the property, not null
*/
@Override
public LocalDate getStartDate() {
return startDate;
}
//-----------------------------------------------------------------------
/**
* Gets the end date of the payment period.
* <p>
* This is the last date in the period.
* If the schedule adjusts for business days, then this is the adjusted date.
* @return the value of the property, not null
*/
@Override
public LocalDate getEndDate() {
return endDate;
}
//-----------------------------------------------------------------------
/**
* Gets the unadjusted start date.
* <p>
* The start date before any business day adjustment is applied.
* <p>
* When building, this will default to the start date if not specified.
* @return the value of the property, not null
*/
public LocalDate getUnadjustedStartDate() {
return unadjustedStartDate;
}
//-----------------------------------------------------------------------
/**
* Gets the unadjusted end date.
* <p>
* The end date before any business day adjustment is applied.
* <p>
* When building, this will default to the end date if not specified.
* @return the value of the property, not null
*/
public LocalDate getUnadjustedEndDate() {
return unadjustedEndDate;
}
//-----------------------------------------------------------------------
/**
* Gets the detachment date.
* <p>
* Some bonds trade ex-coupon before the coupon payment.
* The coupon is paid not to the owner of the bond on the payment date but to the
* owner of the bond on the detachment date.
* <p>
* When building, this will default to the end date if not specified.
* @return the value of the property, not null
*/
public LocalDate getDetachmentDate() {
return detachmentDate;
}
//-----------------------------------------------------------------------
/**
* Gets the rate to be computed.
* <p>
* The value of the period is based on this rate.
* This must be an inflation rate observation, specifically {@link InflationEndInterpolatedRateComputation}
* or {@link InflationEndMonthRateComputation}.
* @return the value of the property, not null
*/
public RateComputation getRateComputation() {
return rateComputation;
}
//-----------------------------------------------------------------------
/**
* Returns a builder that allows this bean to be mutated.
* @return the mutable builder, not null
*/
public Builder toBuilder() {
return new Builder(this);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
CapitalIndexedBondPaymentPeriod other = (CapitalIndexedBondPaymentPeriod) obj;
return JodaBeanUtils.equal(currency, other.currency) &&
JodaBeanUtils.equal(notional, other.notional) &&
JodaBeanUtils.equal(realCoupon, other.realCoupon) &&
JodaBeanUtils.equal(startDate, other.startDate) &&
JodaBeanUtils.equal(endDate, other.endDate) &&
JodaBeanUtils.equal(unadjustedStartDate, other.unadjustedStartDate) &&
JodaBeanUtils.equal(unadjustedEndDate, other.unadjustedEndDate) &&
JodaBeanUtils.equal(detachmentDate, other.detachmentDate) &&
JodaBeanUtils.equal(rateComputation, other.rateComputation);
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(currency);
hash = hash * 31 + JodaBeanUtils.hashCode(notional);
hash = hash * 31 + JodaBeanUtils.hashCode(realCoupon);
hash = hash * 31 + JodaBeanUtils.hashCode(startDate);
hash = hash * 31 + JodaBeanUtils.hashCode(endDate);
hash = hash * 31 + JodaBeanUtils.hashCode(unadjustedStartDate);
hash = hash * 31 + JodaBeanUtils.hashCode(unadjustedEndDate);
hash = hash * 31 + JodaBeanUtils.hashCode(detachmentDate);
hash = hash * 31 + JodaBeanUtils.hashCode(rateComputation);
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(320);
buf.append("CapitalIndexedBondPaymentPeriod{");
buf.append("currency").append('=').append(currency).append(',').append(' ');
buf.append("notional").append('=').append(notional).append(',').append(' ');
buf.append("realCoupon").append('=').append(realCoupon).append(',').append(' ');
buf.append("startDate").append('=').append(startDate).append(',').append(' ');
buf.append("endDate").append('=').append(endDate).append(',').append(' ');
buf.append("unadjustedStartDate").append('=').append(unadjustedStartDate).append(',').append(' ');
buf.append("unadjustedEndDate").append('=').append(unadjustedEndDate).append(',').append(' ');
buf.append("detachmentDate").append('=').append(detachmentDate).append(',').append(' ');
buf.append("rateComputation").append('=').append(JodaBeanUtils.toString(rateComputation));
buf.append('}');
return buf.toString();
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code CapitalIndexedBondPaymentPeriod}.
*/
public static final class Meta extends DirectMetaBean {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code currency} property.
*/
private final MetaProperty<Currency> currency = DirectMetaProperty.ofImmutable(
this, "currency", CapitalIndexedBondPaymentPeriod.class, Currency.class);
/**
* The meta-property for the {@code notional} property.
*/
private final MetaProperty<Double> notional = DirectMetaProperty.ofImmutable(
this, "notional", CapitalIndexedBondPaymentPeriod.class, Double.TYPE);
/**
* The meta-property for the {@code realCoupon} property.
*/
private final MetaProperty<Double> realCoupon = DirectMetaProperty.ofImmutable(
this, "realCoupon", CapitalIndexedBondPaymentPeriod.class, Double.TYPE);
/**
* The meta-property for the {@code startDate} property.
*/
private final MetaProperty<LocalDate> startDate = DirectMetaProperty.ofImmutable(
this, "startDate", CapitalIndexedBondPaymentPeriod.class, LocalDate.class);
/**
* The meta-property for the {@code endDate} property.
*/
private final MetaProperty<LocalDate> endDate = DirectMetaProperty.ofImmutable(
this, "endDate", CapitalIndexedBondPaymentPeriod.class, LocalDate.class);
/**
* The meta-property for the {@code unadjustedStartDate} property.
*/
private final MetaProperty<LocalDate> unadjustedStartDate = DirectMetaProperty.ofImmutable(
this, "unadjustedStartDate", CapitalIndexedBondPaymentPeriod.class, LocalDate.class);
/**
* The meta-property for the {@code unadjustedEndDate} property.
*/
private final MetaProperty<LocalDate> unadjustedEndDate = DirectMetaProperty.ofImmutable(
this, "unadjustedEndDate", CapitalIndexedBondPaymentPeriod.class, LocalDate.class);
/**
* The meta-property for the {@code detachmentDate} property.
*/
private final MetaProperty<LocalDate> detachmentDate = DirectMetaProperty.ofImmutable(
this, "detachmentDate", CapitalIndexedBondPaymentPeriod.class, LocalDate.class);
/**
* The meta-property for the {@code rateComputation} property.
*/
private final MetaProperty<RateComputation> rateComputation = DirectMetaProperty.ofImmutable(
this, "rateComputation", CapitalIndexedBondPaymentPeriod.class, RateComputation.class);
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"currency",
"notional",
"realCoupon",
"startDate",
"endDate",
"unadjustedStartDate",
"unadjustedEndDate",
"detachmentDate",
"rateComputation");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty<?> metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case 575402001: // currency
return currency;
case 1585636160: // notional
return notional;
case 1842278244: // realCoupon
return realCoupon;
case -2129778896: // startDate
return startDate;
case -1607727319: // endDate
return endDate;
case 1457691881: // unadjustedStartDate
return unadjustedStartDate;
case 31758114: // unadjustedEndDate
return unadjustedEndDate;
case -878940481: // detachmentDate
return detachmentDate;
case 625350855: // rateComputation
return rateComputation;
}
return super.metaPropertyGet(propertyName);
}
@Override
public CapitalIndexedBondPaymentPeriod.Builder builder() {
return new CapitalIndexedBondPaymentPeriod.Builder();
}
@Override
public Class<? extends CapitalIndexedBondPaymentPeriod> beanType() {
return CapitalIndexedBondPaymentPeriod.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code currency} property.
* @return the meta-property, not null
*/
public MetaProperty<Currency> currency() {
return currency;
}
/**
* The meta-property for the {@code notional} property.
* @return the meta-property, not null
*/
public MetaProperty<Double> notional() {
return notional;
}
/**
* The meta-property for the {@code realCoupon} property.
* @return the meta-property, not null
*/
public MetaProperty<Double> realCoupon() {
return realCoupon;
}
/**
* The meta-property for the {@code startDate} property.
* @return the meta-property, not null
*/
public MetaProperty<LocalDate> startDate() {
return startDate;
}
/**
* The meta-property for the {@code endDate} property.
* @return the meta-property, not null
*/
public MetaProperty<LocalDate> endDate() {
return endDate;
}
/**
* The meta-property for the {@code unadjustedStartDate} property.
* @return the meta-property, not null
*/
public MetaProperty<LocalDate> unadjustedStartDate() {
return unadjustedStartDate;
}
/**
* The meta-property for the {@code unadjustedEndDate} property.
* @return the meta-property, not null
*/
public MetaProperty<LocalDate> unadjustedEndDate() {
return unadjustedEndDate;
}
/**
* The meta-property for the {@code detachmentDate} property.
* @return the meta-property, not null
*/
public MetaProperty<LocalDate> detachmentDate() {
return detachmentDate;
}
/**
* The meta-property for the {@code rateComputation} property.
* @return the meta-property, not null
*/
public MetaProperty<RateComputation> rateComputation() {
return rateComputation;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case 575402001: // currency
return ((CapitalIndexedBondPaymentPeriod) bean).getCurrency();
case 1585636160: // notional
return ((CapitalIndexedBondPaymentPeriod) bean).getNotional();
case 1842278244: // realCoupon
return ((CapitalIndexedBondPaymentPeriod) bean).getRealCoupon();
case -2129778896: // startDate
return ((CapitalIndexedBondPaymentPeriod) bean).getStartDate();
case -1607727319: // endDate
return ((CapitalIndexedBondPaymentPeriod) bean).getEndDate();
case 1457691881: // unadjustedStartDate
return ((CapitalIndexedBondPaymentPeriod) bean).getUnadjustedStartDate();
case 31758114: // unadjustedEndDate
return ((CapitalIndexedBondPaymentPeriod) bean).getUnadjustedEndDate();
case -878940481: // detachmentDate
return ((CapitalIndexedBondPaymentPeriod) bean).getDetachmentDate();
case 625350855: // rateComputation
return ((CapitalIndexedBondPaymentPeriod) bean).getRateComputation();
}
return super.propertyGet(bean, propertyName, quiet);
}
@Override
protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) {
metaProperty(propertyName);
if (quiet) {
return;
}
throw new UnsupportedOperationException("Property cannot be written: " + propertyName);
}
}
//-----------------------------------------------------------------------
/**
* The bean-builder for {@code CapitalIndexedBondPaymentPeriod}.
*/
public static final class Builder extends DirectFieldsBeanBuilder<CapitalIndexedBondPaymentPeriod> {
private Currency currency;
private double notional;
private double realCoupon;
private LocalDate startDate;
private LocalDate endDate;
private LocalDate unadjustedStartDate;
private LocalDate unadjustedEndDate;
private LocalDate detachmentDate;
private RateComputation rateComputation;
/**
* Restricted constructor.
*/
private Builder() {
}
/**
* Restricted copy constructor.
* @param beanToCopy the bean to copy from, not null
*/
private Builder(CapitalIndexedBondPaymentPeriod beanToCopy) {
this.currency = beanToCopy.getCurrency();
this.notional = beanToCopy.getNotional();
this.realCoupon = beanToCopy.getRealCoupon();
this.startDate = beanToCopy.getStartDate();
this.endDate = beanToCopy.getEndDate();
this.unadjustedStartDate = beanToCopy.getUnadjustedStartDate();
this.unadjustedEndDate = beanToCopy.getUnadjustedEndDate();
this.detachmentDate = beanToCopy.getDetachmentDate();
this.rateComputation = beanToCopy.getRateComputation();
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case 575402001: // currency
return currency;
case 1585636160: // notional
return notional;
case 1842278244: // realCoupon
return realCoupon;
case -2129778896: // startDate
return startDate;
case -1607727319: // endDate
return endDate;
case 1457691881: // unadjustedStartDate
return unadjustedStartDate;
case 31758114: // unadjustedEndDate
return unadjustedEndDate;
case -878940481: // detachmentDate
return detachmentDate;
case 625350855: // rateComputation
return rateComputation;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case 575402001: // currency
this.currency = (Currency) newValue;
break;
case 1585636160: // notional
this.notional = (Double) newValue;
break;
case 1842278244: // realCoupon
this.realCoupon = (Double) newValue;
break;
case -2129778896: // startDate
this.startDate = (LocalDate) newValue;
break;
case -1607727319: // endDate
this.endDate = (LocalDate) newValue;
break;
case 1457691881: // unadjustedStartDate
this.unadjustedStartDate = (LocalDate) newValue;
break;
case 31758114: // unadjustedEndDate
this.unadjustedEndDate = (LocalDate) newValue;
break;
case -878940481: // detachmentDate
this.detachmentDate = (LocalDate) newValue;
break;
case 625350855: // rateComputation
this.rateComputation = (RateComputation) newValue;
break;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
return this;
}
@Override
public Builder set(MetaProperty<?> property, Object value) {
super.set(property, value);
return this;
}
@Override
public Builder setString(String propertyName, String value) {
setString(meta().metaProperty(propertyName), value);
return this;
}
@Override
public Builder setString(MetaProperty<?> property, String value) {
super.setString(property, value);
return this;
}
@Override
public Builder setAll(Map<String, ? extends Object> propertyValueMap) {
super.setAll(propertyValueMap);
return this;
}
@Override
public CapitalIndexedBondPaymentPeriod build() {
return new CapitalIndexedBondPaymentPeriod(
currency,
notional,
realCoupon,
startDate,
endDate,
unadjustedStartDate,
unadjustedEndDate,
detachmentDate,
rateComputation);
}
//-----------------------------------------------------------------------
/**
* Sets the primary currency of the payment period.
* <p>
* The amounts of the notional are usually expressed in terms of this currency,
* however they can be converted from amounts in a different currency.
* @param currency the new value, not null
* @return this, for chaining, not null
*/
public Builder currency(Currency currency) {
JodaBeanUtils.notNull(currency, "currency");
this.currency = currency;
return this;
}
/**
* Sets the notional amount, must be non-zero.
* <p>
* The notional amount applicable during the period.
* The currency of the notional is specified by {@code currency}.
* @param notional the new value
* @return this, for chaining, not null
*/
public Builder notional(double notional) {
this.notional = notional;
return this;
}
/**
* Sets the rate of real coupon.
* <p>
* The real coupon is the rate before taking the inflation into account.
* For example, a real coupon of c for semi-annual payments is c/2.
* @param realCoupon the new value
* @return this, for chaining, not null
*/
public Builder realCoupon(double realCoupon) {
this.realCoupon = realCoupon;
return this;
}
/**
* Sets the start date of the payment period.
* <p>
* This is the first date in the period.
* If the schedule adjusts for business days, then this is the adjusted date.
* @param startDate the new value, not null
* @return this, for chaining, not null
*/
public Builder startDate(LocalDate startDate) {
JodaBeanUtils.notNull(startDate, "startDate");
this.startDate = startDate;
return this;
}
/**
* Sets the end date of the payment period.
* <p>
* This is the last date in the period.
* If the schedule adjusts for business days, then this is the adjusted date.
* @param endDate the new value, not null
* @return this, for chaining, not null
*/
public Builder endDate(LocalDate endDate) {
JodaBeanUtils.notNull(endDate, "endDate");
this.endDate = endDate;
return this;
}
/**
* Sets the unadjusted start date.
* <p>
* The start date before any business day adjustment is applied.
* <p>
* When building, this will default to the start date if not specified.
* @param unadjustedStartDate the new value, not null
* @return this, for chaining, not null
*/
public Builder unadjustedStartDate(LocalDate unadjustedStartDate) {
JodaBeanUtils.notNull(unadjustedStartDate, "unadjustedStartDate");
this.unadjustedStartDate = unadjustedStartDate;
return this;
}
/**
* Sets the unadjusted end date.
* <p>
* The end date before any business day adjustment is applied.
* <p>
* When building, this will default to the end date if not specified.
* @param unadjustedEndDate the new value, not null
* @return this, for chaining, not null
*/
public Builder unadjustedEndDate(LocalDate unadjustedEndDate) {
JodaBeanUtils.notNull(unadjustedEndDate, "unadjustedEndDate");
this.unadjustedEndDate = unadjustedEndDate;
return this;
}
/**
* Sets the detachment date.
* <p>
* Some bonds trade ex-coupon before the coupon payment.
* The coupon is paid not to the owner of the bond on the payment date but to the
* owner of the bond on the detachment date.
* <p>
* When building, this will default to the end date if not specified.
* @param detachmentDate the new value, not null
* @return this, for chaining, not null
*/
public Builder detachmentDate(LocalDate detachmentDate) {
JodaBeanUtils.notNull(detachmentDate, "detachmentDate");
this.detachmentDate = detachmentDate;
return this;
}
/**
* Sets the rate to be computed.
* <p>
* The value of the period is based on this rate.
* This must be an inflation rate observation, specifically {@link InflationEndInterpolatedRateComputation}
* or {@link InflationEndMonthRateComputation}.
* @param rateComputation the new value, not null
* @return this, for chaining, not null
*/
public Builder rateComputation(RateComputation rateComputation) {
JodaBeanUtils.notNull(rateComputation, "rateComputation");
this.rateComputation = rateComputation;
return this;
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(320);
buf.append("CapitalIndexedBondPaymentPeriod.Builder{");
buf.append("currency").append('=').append(JodaBeanUtils.toString(currency)).append(',').append(' ');
buf.append("notional").append('=').append(JodaBeanUtils.toString(notional)).append(',').append(' ');
buf.append("realCoupon").append('=').append(JodaBeanUtils.toString(realCoupon)).append(',').append(' ');
buf.append("startDate").append('=').append(JodaBeanUtils.toString(startDate)).append(',').append(' ');
buf.append("endDate").append('=').append(JodaBeanUtils.toString(endDate)).append(',').append(' ');
buf.append("unadjustedStartDate").append('=').append(JodaBeanUtils.toString(unadjustedStartDate)).append(',').append(' ');
buf.append("unadjustedEndDate").append('=').append(JodaBeanUtils.toString(unadjustedEndDate)).append(',').append(' ');
buf.append("detachmentDate").append('=').append(JodaBeanUtils.toString(detachmentDate)).append(',').append(' ');
buf.append("rateComputation").append('=').append(JodaBeanUtils.toString(rateComputation));
buf.append('}');
return buf.toString();
}
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}