Package com.opengamma.strata.product.capfloor

Class IborCapletFloorletPeriod.Builder

    • Method Detail

      • currency

        public IborCapletFloorletPeriod.Builder currency​(Currency currency)
        Sets the primary currency of the payment period.

        The amounts of the notional are usually expressed in terms of this currency, however they can be converted from amounts in a different currency.

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

      • notional

        public IborCapletFloorletPeriod.Builder notional​(double notional)
        Sets the notional amount, positive if receiving, negative if paying.

        The notional amount applicable during the period. The currency of the notional is specified by currency.

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

      • startDate

        public IborCapletFloorletPeriod.Builder startDate​(LocalDate startDate)
        Sets the start date of the payment period.

        This is the first date in the period. If the schedule adjusts for business days, then this is the adjusted date.

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

      • endDate

        public IborCapletFloorletPeriod.Builder endDate​(LocalDate endDate)
        Sets the end date of the payment period.

        This is the last date in the period. If the schedule adjusts for business days, then this is the adjusted date.

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

      • unadjustedStartDate

        public IborCapletFloorletPeriod.Builder unadjustedStartDate​(LocalDate unadjustedStartDate)
        Sets the unadjusted start date.

        The start date before any business day adjustment is applied.

        When building, this will default to the start date if not specified.

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

      • unadjustedEndDate

        public IborCapletFloorletPeriod.Builder unadjustedEndDate​(LocalDate unadjustedEndDate)
        Sets the unadjusted end date.

        The end date before any business day adjustment is applied.

        When building, this will default to the end date if not specified.

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

      • yearFraction

        public IborCapletFloorletPeriod.Builder yearFraction​(double yearFraction)
        Sets the year fraction that the accrual period represents.

        The value is usually calculated using a DayCount which may be different to that of the index. Typically the value will be close to 1 for one year and close to 0.5 for six months. The fraction may be greater than 1, but not less than 0.

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

      • paymentDate

        public IborCapletFloorletPeriod.Builder paymentDate​(LocalDate paymentDate)
        Sets the date that payment occurs.

        If the schedule adjusts for business days, then this is the adjusted date.

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

      • caplet

        public IborCapletFloorletPeriod.Builder caplet​(Double caplet)
        Sets the optional caplet strike.

        This defines the strike value of a caplet.

        If the period is not a caplet, this field will be absent.

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

      • floorlet

        public IborCapletFloorletPeriod.Builder floorlet​(Double floorlet)
        Sets the optional floorlet strike.

        This defines the strike value of a floorlet.

        If the period is not a floorlet, this field will be absent.

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

      • iborRate

        public IborCapletFloorletPeriod.Builder iborRate​(IborRateComputation iborRate)
        Sets the rate to be observed.

        The value of the period is based on this Ibor rate. For example, it might be a well known market index such as 'GBP-LIBOR-3M'.

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