ca.roumani.i2c

Class MPro

java.lang.Object

ca.roumani.i2c.MPro

public class MPro
extends java.lang.Object

This class encapsulates a mortgage. An instance of this class is characterized by a principle amount, an amortization period measured in years, and an annual interest rate expressed as a percent. The state of any instance has a positive principle, an amortization period in [AMORT_MIN,AMORT_MAX], and an interest rate percent in [0, INTEREST_MAX].

Version:

0.1

Author:

H. Roumani, prof@roumani.ca

Field Summary

Fields

Modifier and Type	Field and Description
static int	AMORT_MAX The maximum amortization period allowed.
static int	AMORT_MIN The minimum amortization period allowed.
static double	EPSILON A small number that sets the resolution in this class such that any real number less than it in absolute value is deemed to be zero.
static int	INTEREST_MAX The maximum interest rate percent allowed.

Constructor Summary

Constructors

Constructor and Description
MPro() Construct an instance having zero principle, AMORT_MIN amortization, and zero interest.
MPro(java.lang.String p, java.lang.String i) Construct an instance having the given principle and interest and a default amortization as set in AMORT_MAX
MPro(java.lang.String p, java.lang.String a, java.lang.String i) Construct an instance having the given principle, amortization, and interest.

Method Summary

Modifier and Type	Method and Description
java.lang.String	computePayment(java.lang.String format) Compute the monthly payment.
boolean	equals(MPro other) Determine if this instance is equal to the given instance.
java.lang.String	getAmortization() The amortization accessor.
java.lang.String	getInterest() The interest accessor.
java.lang.String	getPrinciple() The principle accessor.
java.lang.String	outstandingAfter(int years, java.lang.String format) Compute the balance that is still outstanding after the given number of years.
void	setAmortization(java.lang.String a) The amortization mutator.
void	setInterest(java.lang.String i) The interest mutator.
void	setPrinciple(java.lang.String p) The principle mutator.
java.lang.String	toString() Return a textual representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

AMORT_MIN

public static final int AMORT_MIN

The minimum amortization period allowed.

See Also:

Constant Field Values

AMORT_MAX

public static final int AMORT_MAX

The maximum amortization period allowed.

See Also:

Constant Field Values

INTEREST_MAX

public static final int INTEREST_MAX

The maximum interest rate percent allowed.

See Also:

Constant Field Values

EPSILON

public static final double EPSILON

A small number that sets the resolution in this class such that any real number less than it in absolute value is deemed to be zero.

See Also:

Constant Field Values

Constructor Detail

MPro

public MPro(java.lang.String p,
            java.lang.String a,
            java.lang.String i)

Construct an instance having the given principle, amortization, and interest.

Parameters:

p - the principle amount

a - the amortization period

i - the rate

Throws:

java.lang.RuntimeException - if the parameters are not numeric, if p is not positive, a is not in [AMORT_MIN,AMORT_MAX], or i is not in [0, INTEREST_MAX].

MPro

public MPro(java.lang.String p,
            java.lang.String i)

Construct an instance having the given principle and interest and a default amortization as set in AMORT_MAX

Parameters:

p - the principle amount

i - the rate

Throws:

java.lang.RuntimeException - if the parameters are not numeric or if p is not positive or i is not in [0, INTEREST_MAX].

MPro

public MPro()

Construct an instance having zero principle, AMORT_MIN amortization, and zero interest.

Method Detail

getPrinciple

public java.lang.String getPrinciple()

The principle accessor.

Returns:

the principle amount.

getAmortization

public java.lang.String getAmortization()

The amortization accessor.

Returns:

the amortization period.

getInterest

public java.lang.String getInterest()

The interest accessor.

Returns:

the interest rate percent.

setPrinciple

public void setPrinciple(java.lang.String p)

The principle mutator.

Parameters:

p - the principle amount

Throws:

java.lang.RuntimeException - if p is not numeric or not positive.

setAmortization

public void setAmortization(java.lang.String a)

The amortization mutator.

Parameters:

a - the amortization period.

Throws:

java.lang.RuntimeException - if a is not numeric or not in [AMORT_MIN,AMORT_MAX].

setInterest

public void setInterest(java.lang.String i)

The interest mutator.

Parameters:

i - the rate

Throws:

java.lang.RuntimeException - if i is not numeric or not in [0, INTEREST_MAX].

computePayment

public java.lang.String computePayment(java.lang.String format)

Compute the monthly payment.

Parameters:

format - the format specifier.

Returns:

the computed monthly payment formatted as per the given specifier.

outstandingAfter

public java.lang.String outstandingAfter(int years,
                                         java.lang.String format)

Compute the balance that is still outstanding after the given number of years.

Parameters:

years - the number of years since the mortgage started.

format - the format specifier.

Returns:

the computed balance formatted as per the given specifier.

toString

public java.lang.String toString()

Return a textual representation of this instance.

Overrides:

toString in class java.lang.Object

Returns:

the string "MPro instance with principle=..., amortization=..., interest=...";

equals

public boolean equals(MPro other)

Determine if this instance is equal to the given instance. Two instances are deemed equal if they have the same amortization period and their principles and interest rates differ in magnitude by less than EPSILON.

Parameters:

other - the given instance

Returns:

true if the state of this instance is the equal to the given one and return false otherwise.