net.finmath.time

Class Period

java.lang.Object

net.finmath.time.Period

All Implemented Interfaces:

Comparable<Period>

public class Period
extends Object
implements Comparable<Period>

A period, i.e. a time interval suitable for securities with regular payment schedules. For example, the accrual period is usually given by the interval periodStart, periodEnd, where as fixing date and payment date can be adjusted versions of periodStart and periodsEnd, e.g. via fixing offsets and payment offsets. Period implement the Comparable interface by simply using getPeriodEnd().compareTo(), i.e., the ordering is determined by periodEnd only. For a list of subsequent (sorted) periods it is often assumed that periodStart agrees with the periodEnd of the preceeding period, resulting in a time-discretization.

Author:

Christian Fries

Constructor Summary

Constructors

Constructor and Description
Period(java.time.LocalDate fixing, java.time.LocalDate payment, java.time.LocalDate periodStart, java.time.LocalDate periodEnd)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Period o)
boolean	equals(Object obj)
java.time.LocalDate	getFixing()
java.time.LocalDate	getPayment()
java.time.LocalDate	getPeriodEnd()
java.time.LocalDate	getPeriodStart()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Period

public Period(java.time.LocalDate fixing,
              java.time.LocalDate payment,
              java.time.LocalDate periodStart,
              java.time.LocalDate periodEnd)

Method Detail

getFixing

public java.time.LocalDate getFixing()

getPayment

public java.time.LocalDate getPayment()

getPeriodStart

public java.time.LocalDate getPeriodStart()

getPeriodEnd

public java.time.LocalDate getPeriodEnd()

compareTo

public int compareTo(Period o)

Specified by:

compareTo in interface Comparable<Period>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object