org.jfin.date.accrual

Class NotionalPeriod

java.lang.Object

org.jfin.date.Period

org.jfin.date.accrual.NotionalPeriod

All Implemented Interfaces:

java.lang.Comparable

public class NotionalPeriod
extends Period

Used to model a Notional Period; a period of time during which the notional amount of a trade is unchanged.

Constructor Summary

Constructors

Constructor and Description
NotionalPeriod() Default constructor
NotionalPeriod(java.util.Calendar startCalendar, java.util.Calendar endCalendar, double amount, Iso4217Currency currency) Constructor
NotionalPeriod(java.util.Calendar startCalendar, java.util.Calendar endCalendar, Notional notional) Constructor
NotionalPeriod(double amount, Iso4217Currency currency) Constructor
NotionalPeriod(Notional notional) Constructor
NotionalPeriod(NotionalPeriod toCopy) Copy constructor

Method Summary

Modifier and Type	Method and Description
NotionalPeriod	clone()
double	getAmount() Gets the amount of the notional
Iso4217Currency	getCurrency() Gets the currency of the notional
Notional	getNotional() Gets the object representing the Notional
void	setAmount(double amount) Sets the amount of the notional
void	setCurrency(Iso4217Currency currency) Sets the currency of the notional
void	setNotional(Notional notional) Sets the object representing the Notional

Methods inherited from class org.jfin.date.Period

compareTo, getEndCalendar, getReferenceEndCalendar, getReferenceStartCalendar, getStartCalendar, setEndCalendar, setReferenceEndCalendar, setReferenceStartCalendar, setStartCalendar, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NotionalPeriod

public NotionalPeriod()

Default constructor

NotionalPeriod

public NotionalPeriod(NotionalPeriod toCopy)

Copy constructor

Parameters:

toCopy - The notional period to copy

NotionalPeriod

public NotionalPeriod(Notional notional)

Constructor

Parameters:

notional - The notional to use

NotionalPeriod

public NotionalPeriod(double amount,
                      Iso4217Currency currency)

Constructor

Parameters:

amount - The amount to use

currency - The currency to use

NotionalPeriod

public NotionalPeriod(java.util.Calendar startCalendar,
                      java.util.Calendar endCalendar,
                      Notional notional)

Constructor

Parameters:

startCalendar - The start date as a calendar

endCalendar - The end date as a calendar

notional - The notional

NotionalPeriod

public NotionalPeriod(java.util.Calendar startCalendar,
                      java.util.Calendar endCalendar,
                      double amount,
                      Iso4217Currency currency)

Constructor

Parameters:

startCalendar - The start date as a calendar

endCalendar - The end date as a calendar

amount - The amount

currency - The currency

Method Detail

clone

public NotionalPeriod clone()

Overrides:

clone in class Period

getNotional

public Notional getNotional()

Gets the object representing the Notional

Returns:

The notional

setNotional

public void setNotional(Notional notional)

Sets the object representing the Notional

Parameters:

notional - The notional

getAmount

public double getAmount()

Gets the amount of the notional

Returns:

The amount

setAmount

public void setAmount(double amount)

Sets the amount of the notional

Parameters:

amount - The amount

getCurrency

public Iso4217Currency getCurrency()

Gets the currency of the notional

Returns:

The currency

setCurrency

public void setCurrency(Iso4217Currency currency)

Sets the currency of the notional

Parameters:

currency - The currency