org.jquantlib.cashflow

Class FractionalDividend

java.lang.Object

org.jquantlib.cashflow.Event

org.jquantlib.cashflow.CashFlow

org.jquantlib.cashflow.Dividend

org.jquantlib.cashflow.FractionalDividend

All Implemented Interfaces:

java.lang.Comparable<CashFlow>, Observable, PolymorphicVisitable

public class FractionalDividend
extends Dividend

Predetermined cash flow

This cash flow pays a predetermined amount at a given date.

Constructor Summary

Constructors

Constructor and Description
FractionalDividend(double rate, Date date)
FractionalDividend(double rate, double nominal, Date date)

Method Summary

Modifier and Type	Method and Description
double	amount()
double	amount(double underlying)

Methods inherited from class org.jquantlib.cashflow.Dividend

accept, date, DividendVector

Methods inherited from class org.jquantlib.cashflow.CashFlow

compareTo

Methods inherited from class org.jquantlib.cashflow.Event

addObserver, countObservers, deleteObserver, deleteObservers, getObservers, hasOccurred, hasOccurred, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

FractionalDividend

public FractionalDividend(double rate,
                          Date date)

FractionalDividend

public FractionalDividend(double rate,
                          double nominal,
                          Date date)

Method Detail

amount

public double amount(double underlying)

Specified by:

amount in class Dividend

amount

public double amount()

Specified by:

amount in class CashFlow

Returns:

amount of the cash flow. The amount is not discounted, i.e., it is the actual amount paid at the cash flow date.