Package com.opengamma.strata.product.bond

Class FixedCouponBond.Builder

  • All Implemented Interfaces:
    org.joda.beans.BeanBuilder<FixedCouponBond>
    Enclosing class:
    FixedCouponBond
    public static final class FixedCouponBond.Builder
extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<FixedCouponBond>
    The bean-builder for FixedCouponBond.

    • Method Detail

      • get

        public Object get​(String propertyName)
        Specified by:
        get in interface org.joda.beans.BeanBuilder<FixedCouponBond>
        Overrides:
        get in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<FixedCouponBond>

      • securityId

        public FixedCouponBond.Builder securityId​(SecurityId securityId)
        Sets the security identifier.

        This identifier uniquely identifies the security within the system.

        Parameters:
        securityId - the new value, not null
        Returns:
        this, for chaining, not null

      • currency

        public FixedCouponBond.Builder currency​(Currency currency)
        Sets the currency that the bond is traded in.
        Parameters:
        currency - the new value, not null
        Returns:
        this, for chaining, not null

      • notional

        public FixedCouponBond.Builder notional​(double notional)
        Sets the notional amount, must be positive.

        The notional expressed here must be positive. The currency of the notional is specified by currency.

        Parameters:
        notional - the new value
        Returns:
        this, for chaining, not null

      • accrualSchedule

        public FixedCouponBond.Builder accrualSchedule​(PeriodicSchedule accrualSchedule)
        Sets the accrual schedule.

        This is used to define the accrual periods. These are used directly or indirectly to determine other dates in the product.

        Parameters:
        accrualSchedule - the new value, not null
        Returns:
        this, for chaining, not null

      • fixedRate

        public FixedCouponBond.Builder fixedRate​(double fixedRate)
        Sets the fixed coupon rate.

        The periodic payments are based on this fixed coupon rate.

        Parameters:
        fixedRate - the new value
        Returns:
        this, for chaining, not null

      • dayCount

        public FixedCouponBond.Builder dayCount​(DayCount dayCount)
        Sets the day count convention applicable.

        The conversion from dates to a numerical value is made based on this day count. For the fixed bond, the day count convention is used to compute accrued interest.

        Note that the year fraction of a coupon payment is computed based on the unadjusted dates in the schedule.

        Parameters:
        dayCount - the new value, not null
        Returns:
        this, for chaining, not null

      • yieldConvention

        public FixedCouponBond.Builder yieldConvention​(FixedCouponBondYieldConvention yieldConvention)
        Sets yield convention.

        The convention defines how to convert from yield to price and inversely.

        Parameters:
        yieldConvention - the new value, not null
        Returns:
        this, for chaining, not null

      • legalEntityId

        public FixedCouponBond.Builder legalEntityId​(LegalEntityId legalEntityId)
        Sets the legal entity identifier.

        This identifier is used for the legal entity that issues the bond.

        Parameters:
        legalEntityId - the new value, not null
        Returns:
        this, for chaining, not null

      • settlementDateOffset

        public FixedCouponBond.Builder settlementDateOffset​(DaysAdjustment settlementDateOffset)
        Sets the number of days between valuation date and settlement date.

        This is used to compute clean price. The clean price is the relative price to be paid at the standard settlement date in exchange for the bond.

        It is usually one business day for US treasuries and UK Gilts and three days for Euroland government bonds.

        Parameters:
        settlementDateOffset - the new value, not null
        Returns:
        this, for chaining, not null

      • exCouponPeriod

        public FixedCouponBond.Builder exCouponPeriod​(DaysAdjustment exCouponPeriod)
        Sets ex-coupon period.

        Some bonds trade ex-coupons 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. The difference between the two is the ex-coupon period (measured in days).

        Because the detachment date is not after the coupon date, the number of days stored in this field should be zero or negative.

        Parameters:
        exCouponPeriod - the new value, not null
        Returns:
        this, for chaining, not null

      • toString

        public String toString()
        Overrides:
        toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<FixedCouponBond>