IborCapletFloorletPeriod.Builder (OpenGamma Strata Product)

java.lang.Object
- org.joda.beans.impl.direct.DirectFieldsBeanBuilder<IborCapletFloorletPeriod>
- - com.opengamma.strata.product.capfloor.IborCapletFloorletPeriod.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<IborCapletFloorletPeriod>

Enclosing class:

IborCapletFloorletPeriod
```
public static final class IborCapletFloorletPeriod.Builder
extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<IborCapletFloorletPeriod>
```
The bean-builder for IborCapletFloorletPeriod.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IborCapletFloorletPeriod`	`build()`
`IborCapletFloorletPeriod.Builder`	`caplet(Double caplet)` Sets the optional caplet strike.
`IborCapletFloorletPeriod.Builder`	`currency(Currency currency)` Sets the primary currency of the payment period.
`IborCapletFloorletPeriod.Builder`	`endDate(LocalDate endDate)` Sets the end date of the payment period.
`IborCapletFloorletPeriod.Builder`	`floorlet(Double floorlet)` Sets the optional floorlet strike.
`Object`	`get(String propertyName)`
`IborCapletFloorletPeriod.Builder`	`iborRate(IborRateComputation iborRate)` Sets the rate to be observed.
`IborCapletFloorletPeriod.Builder`	`notional(double notional)` Sets the notional amount, positive if receiving, negative if paying.
`IborCapletFloorletPeriod.Builder`	`paymentDate(LocalDate paymentDate)` Sets the date that payment occurs.
`IborCapletFloorletPeriod.Builder`	`set(org.joda.beans.MetaProperty<?> property, Object value)`
`IborCapletFloorletPeriod.Builder`	`set(String propertyName, Object newValue)`
`IborCapletFloorletPeriod.Builder`	`startDate(LocalDate startDate)` Sets the start date of the payment period.
`String`	`toString()`
`IborCapletFloorletPeriod.Builder`	`unadjustedEndDate(LocalDate unadjustedEndDate)` Sets the unadjusted end date.
`IborCapletFloorletPeriod.Builder`	`unadjustedStartDate(LocalDate unadjustedStartDate)` Sets the unadjusted start date.
`IborCapletFloorletPeriod.Builder`	`yearFraction(double yearFraction)` Sets the year fraction that the accrual period represents.

Methods inherited from class org.joda.beans.impl.direct.DirectFieldsBeanBuilder
get

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

- Method Detail
  - get
```
public Object get(String propertyName)
```
    Specified by:
    
    get in interface org.joda.beans.BeanBuilder<IborCapletFloorletPeriod>
    
    Overrides:
    
    get in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<IborCapletFloorletPeriod>
  - set
```
public IborCapletFloorletPeriod.Builder set(String propertyName,
                                            Object newValue)
```
  - set
```
public IborCapletFloorletPeriod.Builder set(org.joda.beans.MetaProperty<?> property,
                                            Object value)
```
    Specified by:
    
    set in interface org.joda.beans.BeanBuilder<IborCapletFloorletPeriod>
    
    Overrides:
    
    set in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<IborCapletFloorletPeriod>
  - build
```
public IborCapletFloorletPeriod build()
```
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<IborCapletFloorletPeriod>

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

Class IborCapletFloorletPeriod.Builder

Method Summary

Methods inherited from class org.joda.beans.impl.direct.DirectFieldsBeanBuilder

Methods inherited from class java.lang.Object

Method Detail

get

set

set

build

currency

notional

startDate

endDate

unadjustedStartDate

unadjustedEndDate

yearFraction

paymentDate

caplet

floorlet

iborRate

toString