org.jquantlib.cashflow

Class Dividend

java.lang.Object

org.jquantlib.cashflow.Event

org.jquantlib.cashflow.CashFlow

org.jquantlib.cashflow.Dividend

All Implemented Interfaces:

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

Direct Known Subclasses:

FixedDividend, FractionalDividend

public abstract class Dividend
extends CashFlow

Predetermined cash flow

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

Constructor Summary

Constructors

Constructor and Description
Dividend(Date date)

Method Summary

Modifier and Type	Method and Description
void	accept(PolymorphicVisitor pv) This method is intended to extend the semantics of method Visitable.accept(Visitor)
abstract double	amount(double underlying)
Date	date() Keeps the date at which the event occurs
static java.util.List<? extends Dividend>	DividendVector(java.util.List<Date> dividendDates, java.util.List<java.lang.Double> dividends)

Methods inherited from class org.jquantlib.cashflow.CashFlow

amount, 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

Dividend

public Dividend(Date date)

Method Detail

date

public Date date()

Description copied from class: Event

Keeps the date at which the event occurs

Specified by:

date in class Event

amount

public abstract double amount(double underlying)

DividendVector

public static java.util.List<? extends Dividend> DividendVector(java.util.List<Date> dividendDates,
                                                                java.util.List<java.lang.Double> dividends)

accept

public void accept(PolymorphicVisitor pv)

Description copied from interface: PolymorphicVisitable

This method is intended to extend the semantics of method Visitable.accept(Visitor)

In a conventional Visitor design pattern, the accept method is called when access to visit a data structure is requested. A Visitor object is passed as argument in case permission is granted to that Visitor to access the data structure. Obviously, Visitors and Visitables work in pairs and the class which provides the data structure to be visited also implements Visitable in order to properly grant access when the expected Visitor is received.

In the case of a PolymorphicVisitable, a PolymorphicVisitor is passed instead of a Visitor. A PolymorphicVisitor is in fact, a composition of Visitors and not only a single Visitor. A PolymorphicVisitor is responsible for returning the correct Visitor responsible for processing a certain data structure.

The initial design of pairs made of <Visitor,Visitable> is extended to a concept of a matrix made of multiple Visitors against multiple Visitables. Every class which implements PolymorphicVisitable passes different data structures when querying PolymorphicVisitors.

Specified by:

accept in interface PolymorphicVisitable

Overrides:

accept in class CashFlow

See Also:

PolymorphicVisitor#getVisitor(Class)