cse1030.labtest1

Class Money

java.lang.Object

cse1030.labtest1.Money

public class Money
extends Object

A class that represents an amount of Canadian money in dollars and cents. The class also keeps track of the total amount of dollars and cents in circulation. When money is created, the total amount of money in circulation is increased by the value of the created money. When an amount of money is modified, the total amount of money in circulation is updated with the change in the value of the money.

The Money class keeps track of two values:

1. the number of dollars in circulation
2. the number of cents in circulation

Each Money object keeps track of two values:

1. the number of dollars in this money object
2. the number of cents in this money object

Author:

CSE1030

Constructor Summary

Constructors

Constructor and Description
Money() Construct a money object having 0 dollars and 0 cents.
Money(int dollars, int cents) Construct a money object given the amount of dollars and amount of cents.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCents() Get the amount of cents represented by this object (ignoring the number of dollars).
static int	getCentsInCirculation() Get the total amount of cents in circulation.
int	getDollars() Get the amount of dollars represented by this object.
static int	getDollarsInCirculation() Get the total amount of dollars in circulation.
boolean	setCents(int cents) Set the amount of cents.
boolean	setDollars(int dollars) Set the amount of dollars.
String	toString() Creates a string representation of a money object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Money

public Money()

Construct a money object having 0 dollars and 0 cents.

Money

public Money(int dollars,
     int cents)

Construct a money object given the amount of dollars and amount of cents. Updates the total of amount of money in circulation.

Throws:

IllegalArgumentException - if dollars < 0 or cents < 0.

Parameters:

dollars - The amount of dollars.

cents - The amount of cents.

Method Detail

setDollars

public boolean setDollars(int dollars)

Set the amount of dollars. If dollars < 0 then the state of the object is unchanged from its current value and false is returned. If dollars >= 0 then the state of the object is updated, the total amount of money in circulation is updated, and true is returned.

The total amount of money in circulation is updated with the change in the value of dollars for this money object. For example, suppose the number of dollars for a money object m is 10; then m.setDollars(15) will increase the total amount of money in circulation by 5 dollars.

Parameters:

dollars - The amount of dollars.

Returns:

true if dollars >= 0; false otherwise.

setCents

public boolean setCents(int cents)

Set the amount of cents. If cents < 0 then the state of the object is unchanged from its current value and false is returned. If cents >= 0 then the state of the object is updated, the total amount of money in circulation is updated, and true is returned.

The total amount of money in circulation is updated with the change in the value of cents for this money object. For example, suppose the number of cents for a money object m is 50; then m.setCents(30) will decrease the total amount of money in circulation by 20 cents.

Parameters:

cents - The amount of cents.

Returns:

true if cents >= 0; false otherwise.

getDollars

public int getDollars()

Get the amount of dollars represented by this object. (ignoring the number of cents). For example, for a money object representing 10 dollars and 55 cents this method would return 10.

Returns:

The number of dollars.

getCents

public int getCents()

Get the amount of cents represented by this object (ignoring the number of dollars). For example, for a money object representing 10 dollars and 55 cents this method would return 55.

Returns:

The number of cents.

getDollarsInCirculation

public static int getDollarsInCirculation()

Get the total amount of dollars in circulation.

Returns:

The number of dollars in circulation.

getCentsInCirculation

public static int getCentsInCirculation()

Get the total amount of cents in circulation.

Returns:

The number of cents in circulation.

toString

public String toString()

Creates a string representation of a money object. The string is the number of dollars followed by " dollars and " followed by the number of cents followed by " cents".

Overrides:

toString in class Object

Returns:

The string representation of the object.