com.opengamma.strata.product.swaption

Class SwaptionExerciseDate

java.lang.Object

com.opengamma.strata.product.swaption.SwaptionExerciseDate

All Implemented Interfaces:

Serializable, Comparable<SwaptionExerciseDate>, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class SwaptionExerciseDate
extends Object
implements Comparable<SwaptionExerciseDate>, org.joda.beans.ImmutableBean, Serializable

One possible date for swaption exercise, resolved for pricing.

This is the resolved form of SwaptionExercise and is an input to the pricers.

This class is bound to data that changes over time, such as holiday calendars. If the data changes, such as the addition of a new holiday, the resolved form will not be updated. Care must be taken when placing the resolved form in a cache or persistence layer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwaptionExerciseDate.Builder The bean-builder for SwaptionExerciseDate.

Method Summary

Modifier and Type	Method and Description
static SwaptionExerciseDate.Builder	builder() Returns a builder used to create an instance of the bean.
int	compareTo(SwaptionExerciseDate other)
boolean	equals(Object obj)
LocalDate	getExerciseDate() Gets the adjusted exercise date.
LocalDate	getSwapStartDate() Gets the adjusted swap start date.
LocalDate	getUnadjustedExerciseDate() Gets the unadjusted exercise date.
int	hashCode()
static org.joda.beans.TypedMetaBean<SwaptionExerciseDate>	meta() The meta-bean for SwaptionExerciseDate.
org.joda.beans.TypedMetaBean<SwaptionExerciseDate>	metaBean()
static SwaptionExerciseDate	of(LocalDate exerciseDate, LocalDate unadjustedExerciseDate, LocalDate swapStartDate) Obtains an instance.
SwaptionExerciseDate.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

compareTo

public int compareTo(SwaptionExerciseDate other)

Specified by:

compareTo in interface Comparable<SwaptionExerciseDate>

meta

public static org.joda.beans.TypedMetaBean<SwaptionExerciseDate> meta()

The meta-bean for SwaptionExerciseDate.

Returns:

the meta-bean, not null

of

public static SwaptionExerciseDate of(LocalDate exerciseDate,
                                      LocalDate unadjustedExerciseDate,
                                      LocalDate swapStartDate)

Obtains an instance.

Parameters:

exerciseDate - the value of the property, not null

unadjustedExerciseDate - the value of the property, not null

swapStartDate - the value of the property, not null

Returns:

the instance

builder

public static SwaptionExerciseDate.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public org.joda.beans.TypedMetaBean<SwaptionExerciseDate> metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getExerciseDate

public LocalDate getExerciseDate()

Gets the adjusted exercise date.

This date has been adjusted to be a business day.

Returns:

the value of the property, not null

getUnadjustedExerciseDate

public LocalDate getUnadjustedExerciseDate()

Gets the unadjusted exercise date.

This date may be a non-business day.

Returns:

the value of the property, not null

getSwapStartDate

public LocalDate getSwapStartDate()

Gets the adjusted swap start date.

This date has been adjusted to be a business day.

Returns:

the value of the property, not null

toBuilder

public SwaptionExerciseDate.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