Class KnownAmountBondPaymentPeriod

  • All Implemented Interfaces:
    BondPaymentPeriod, java.io.Serializable, Bean, ImmutableBean

    public final class KnownAmountBondPaymentPeriod
    extends java.lang.Object
    implements BondPaymentPeriod, ImmutableBean, java.io.Serializable
    A period within a swap that results in a known amount.

    A swap leg consists of one or more periods that result in a payment. The standard class, RatePaymentPeriod, represents a payment period calculated from a fixed or floating rate. By contrast, this class represents a period where the amount of the payment is known and fixed.

    See Also:
    Serialized Form
    • Method Detail

      • getPaymentDate

        public java.time.LocalDate getPaymentDate()
        Description copied from interface: BondPaymentPeriod
        Gets the date that the payment is made.

        Each payment period has a single payment date. This date has been adjusted to be a valid business day.

        Specified by:
        getPaymentDate in interface BondPaymentPeriod
        Returns:
        the payment date of the period
      • getCurrency

        public Currency getCurrency()
        Description copied from interface: BondPaymentPeriod
        Gets the currency of the payment resulting from the period.

        This is the currency of the generated payment. A period has a single currency.

        Specified by:
        getCurrency in interface BondPaymentPeriod
        Returns:
        the currency of the period
      • adjustPaymentDate

        public KnownAmountBondPaymentPeriod adjustPaymentDate​(java.time.temporal.TemporalAdjuster adjuster)
        Description copied from interface: BondPaymentPeriod
        Adjusts the payment date using the rules of the specified adjuster.

        The adjuster is typically an instance of BusinessDayAdjustment. Implementations must return a new instance unless they are immutable and no change occurs.

        Specified by:
        adjustPaymentDate in interface BondPaymentPeriod
        Parameters:
        adjuster - the adjuster to apply to the payment date
        Returns:
        the adjusted payment event
      • collectIndices

        public void collectIndices​(com.google.common.collect.ImmutableSet.Builder<Index> builder)
        Description copied from interface: BondPaymentPeriod
        Collects all the indices referred to by this period.

        A period will typically refer to at least one index, such as 'GBP-LIBOR-3M'. Each index that is referred to must be added to the specified builder.

        Specified by:
        collectIndices in interface BondPaymentPeriod
        Parameters:
        builder - the builder to use
      • getPayment

        public Payment getPayment()
        Gets the payment.

        This includes the payment date and amount. If the schedule adjusts for business days, then the date is the adjusted date.

        Returns:
        the value of the property, not null
      • getStartDate

        public java.time.LocalDate getStartDate()
        Gets 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.

        Specified by:
        getStartDate in interface BondPaymentPeriod
        Returns:
        the value of the property, not null
      • getEndDate

        public java.time.LocalDate getEndDate()
        Gets 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.

        Specified by:
        getEndDate in interface BondPaymentPeriod
        Returns:
        the value of the property, not null
      • getUnadjustedStartDate

        public java.time.LocalDate getUnadjustedStartDate()
        Gets 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.

        Returns:
        the value of the property, not null
      • getUnadjustedEndDate

        public java.time.LocalDate getUnadjustedEndDate()
        Gets 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.

        Returns:
        the value of the property, not null
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object