KnownAmountSwapPaymentPeriod (OpenGamma Strata Product)

java.lang.Object
- com.opengamma.strata.product.swap.KnownAmountSwapPaymentPeriod

All Implemented Interfaces:

SwapPaymentPeriod, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean
```
public final class KnownAmountSwapPaymentPeriod
extends Object
implements SwapPaymentPeriod, org.joda.beans.ImmutableBean, 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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`KnownAmountSwapPaymentPeriod.Builder` The bean-builder for `KnownAmountSwapPaymentPeriod`.
`static class`	`KnownAmountSwapPaymentPeriod.Meta` The meta-bean for `KnownAmountSwapPaymentPeriod`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KnownAmountSwapPaymentPeriod`	`adjustPaymentDate(TemporalAdjuster adjuster)` Adjusts the payment date using the rules of the specified adjuster.
`static KnownAmountSwapPaymentPeriod.Builder`	`builder()` Returns a builder used to create an instance of the bean.
`void`	`collectIndices(ImmutableSet.Builder<Index> builder)` Collects all the indices referred to by this period.
`boolean`	`equals(Object obj)`
`Currency`	`getCurrency()` Gets the currency of the payment resulting from the period.
`LocalDate`	`getEndDate()` Gets the end date of the payment period.
`Payment`	`getPayment()` Gets the payment.
`LocalDate`	`getPaymentDate()` Gets the date that the payment is made.
`LocalDate`	`getStartDate()` Gets the start date of the payment period.
`LocalDate`	`getUnadjustedEndDate()` Gets the unadjusted end date.
`LocalDate`	`getUnadjustedStartDate()` Gets the unadjusted start date.
`int`	`hashCode()`
`static KnownAmountSwapPaymentPeriod.Meta`	`meta()` The meta-bean for `KnownAmountSwapPaymentPeriod`.
`KnownAmountSwapPaymentPeriod.Meta`	`metaBean()`
`static KnownAmountSwapPaymentPeriod`	`of(Payment payment, SchedulePeriod period)` Obtains an instance based on a payment and schedule period.
`KnownAmountSwapPaymentPeriod.Builder`	`toBuilder()` Returns a builder that allows this bean to be mutated.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.joda.beans.Bean
property, propertyNames

- Method Detail
  - of
```
public static KnownAmountSwapPaymentPeriod of(Payment payment,
                                              SchedulePeriod period)
```
    Obtains an instance based on a payment and schedule period.
    
    Parameters:
    
    payment - the payment
    
    period - the schedule period
    
    Returns:
    
    the period
  - getPaymentDate
```
public LocalDate getPaymentDate()
```
    Description copied from interface: SwapPaymentPeriod
    
    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 SwapPaymentPeriod
    
    Returns:
    
    the payment date of the period
  - getCurrency
```
public Currency getCurrency()
```
    Description copied from interface: SwapPaymentPeriod
    
    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 SwapPaymentPeriod
    
    Returns:
    
    the currency of the period
  - adjustPaymentDate
```
public KnownAmountSwapPaymentPeriod adjustPaymentDate(TemporalAdjuster adjuster)
```
    Description copied from interface: SwapPaymentPeriod
    
    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 SwapPaymentPeriod
    
    Parameters:
    
    adjuster - the adjuster to apply to the payment date
    
    Returns:
    
    the adjusted payment event
  - collectIndices
```
public void collectIndices(ImmutableSet.Builder<Index> builder)
```
    Description copied from interface: SwapPaymentPeriod
    
    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 SwapPaymentPeriod
    
    Parameters:
    
    builder - the builder to use
  - meta
```
public static KnownAmountSwapPaymentPeriod.Meta meta()
```
    The meta-bean for KnownAmountSwapPaymentPeriod.
    
    Returns:
    
    the meta-bean, not null
  - builder
```
public static KnownAmountSwapPaymentPeriod.Builder builder()
```
    Returns a builder used to create an instance of the bean.
    
    Returns:
    
    the builder, not null
  - metaBean
```
public KnownAmountSwapPaymentPeriod.Meta metaBean()
```
    Specified by:
    
    metaBean in interface org.joda.beans.Bean
  - 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 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 SwapPaymentPeriod
    
    Returns:
    
    the value of the property, not null
  - getEndDate
```
public 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 SwapPaymentPeriod
    
    Returns:
    
    the value of the property, not null
  - getUnadjustedStartDate
```
public 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 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
  - toBuilder
```
public KnownAmountSwapPaymentPeriod.Builder toBuilder()
```
    Returns a builder that allows this bean to be mutated.
    
    Returns:
    
    the mutable builder, not null
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class KnownAmountSwapPaymentPeriod

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.joda.beans.Bean

Method Detail

of

getPaymentDate

getCurrency

adjustPaymentDate

collectIndices

meta

builder

metaBean

getPayment

getStartDate

getEndDate

getUnadjustedStartDate

getUnadjustedEndDate

toBuilder

equals

hashCode

toString