Class ValueStep.Builder

    • Method Detail

      • set

        public ValueStep.Builder set​(java.lang.String propertyName,
                                     java.lang.Object newValue)
      • periodIndex

        public ValueStep.Builder periodIndex​(java.lang.Integer periodIndex)
        Sets the index of the schedule period boundary at which the change occurs.

        This property is used to define the date that the step occurs in relative terms. The date is identified by specifying the zero-based index of the schedule period boundary. The change will occur at the start of the specified period. Thus an index of zero is the start of the first period or initial stub. The index must be one or greater, as a change is not permitted at the start of the first period.

        For example, consider a 5 year swap from 2012-02-01 to 2017-02-01 with 6 month frequency. A zero-based index of '2' would refer to start of the 3rd period, which would be 2013-02-01.

        Parameters:
        periodIndex - the new value
        Returns:
        this, for chaining, not null
      • date

        public ValueStep.Builder date​(java.time.LocalDate date)
        Sets the date of the schedule period boundary at which the change occurs.

        This property is used to define the date that the step occurs in absolute terms. This must be one of the unadjusted dates in the schedule period schedule. This is an unadjusted date and calculation period business day adjustments will apply.

        For example, consider a 5 year swap from 2012-02-01 to 2017-02-01 with 6 month frequency. The date '2013-02-01' is an unadjusted schedule period boundary, and so may be specified here.

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

        public ValueStep.Builder value​(ValueAdjustment value)
        Sets the value representing the change that occurs.

        The adjustment can be an absolute value, or various kinds of relative values.

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