org.jquantlib.cashflow

Class CashFlow

java.lang.Object

org.jquantlib.cashflow.Event

org.jquantlib.cashflow.CashFlow

All Implemented Interfaces:

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

Direct Known Subclasses:

Coupon, Dividend, SimpleCashFlow

public abstract class CashFlow
extends Event
implements java.lang.Comparable<CashFlow>

Constructor Summary

Constructors

Constructor and Description
CashFlow()

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()
int	compareTo(CashFlow c2)

Methods inherited from class org.jquantlib.cashflow.Event

addObserver, countObservers, date, 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

CashFlow

public CashFlow()

Method Detail

amount

public abstract double amount()

Returns:

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

compareTo

public int compareTo(CashFlow c2)

Specified by:

compareTo in interface java.lang.Comparable<CashFlow>

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 Event

See Also:

PolymorphicVisitor#getVisitor(Class)