com.cedarspring.tvm
Class Payment

java.lang.Object
  |
  +--com.cedarspring.tvm.Payment
All Implemented Interfaces:
java.io.Serializable

final class Payment
extends java.lang.Object
implements java.io.Serializable

Payment
Payments are a series of equal, evenly-spaced cash flows. They must represent all outflows (negative amount) or all inflows (positive amount) and occur at the beginning or end of each period.

This class will:

Version:
1.2.2 15-May-2003
Author:
Cedar Spring Software, Inc.

Field Summary
private  IFTables ift
           
private  boolean payAtEnd
           
(package private) static long serialVersionUID
           
private  java.math.BigDecimal value
           
 
Constructor Summary
(package private) Payment()
          Construct a default Present Value Object with this objects as the
 
Method Summary
(package private)  void computeValue(java.math.BigDecimal ip, java.math.BigDecimal n, java.math.BigDecimal fv, java.math.BigDecimal pv, Options o)
          Compute the present value and set the presentValue property.
(package private)  java.math.BigDecimal getValue()
          Recall the payment value
(package private)  boolean isPayAtEnd()
          Recall Begin-End mode
(package private)  void setPayAtEnd(boolean newPayAtEnd)
          Annuity Payments must be made each period at: true: payments occur at the end of each period.
(package private)  void setValue(java.math.BigDecimal newValue, Options o)
          Store a new payment value and notify listeners
 java.lang.String toString()
          Return payment as a string
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

value

private java.math.BigDecimal value

payAtEnd

private boolean payAtEnd

ift

private IFTables ift

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Payment

Payment()
Construct a default Present Value Object with this objects as the

Method Detail

setValue

void setValue(java.math.BigDecimal newValue,
              Options o)
        throws TVMException
Store a new payment value and notify listeners

Parameters:
newValue - Annuity Payment
TVMException

getValue

java.math.BigDecimal getValue()
Recall the payment value


computeValue

void computeValue(java.math.BigDecimal ip,
                  java.math.BigDecimal n,
                  java.math.BigDecimal fv,
                  java.math.BigDecimal pv,
                  Options o)
            throws TVMException
Compute the present value and set the presentValue property.

Parameters:
ip - interest Per Period
n - numberOfPeriods
fv - futureValue
o - Options Object
TVMException

setPayAtEnd

void setPayAtEnd(boolean newPayAtEnd)
Annuity Payments must be made each period at:


isPayAtEnd

boolean isPayAtEnd()
Recall Begin-End mode


toString

public java.lang.String toString()
Return payment as a string

Overrides:
toString in class java.lang.Object