test2

Class OwnedPiggyBank

java.lang.Object

test2.OwnedPiggyBank

public class OwnedPiggyBank
extends Object

A class representing a piggy bank that has an owner. A piggy bank owns a collection (or possibly collections) of coins, but does not own the coins themselves.

Only the owner of the piggy bank is able to remove coins from the piggy bank.

Constructor Summary

Constructors

Constructor and Description
OwnedPiggyBank(OwnedPiggyBank other) Initializes this piggy bank by copying another piggy bank.
OwnedPiggyBank(Owner owner) Initializes this piggy bank so that it has the specified owner and no coins.

Method Summary

Modifier and Type	Method and Description
void	add(List<Coin> coins) Adds the specified coins to this piggy bank.
boolean	contains(Coin coin) Returns true if this piggy bank contains the specified coin, and false otherwise.
List<Coin>	deepCopy() Returns a deep copy of the coins in this piggy bank.
Owner	getOwner() Returns the owner of this piggy bank.
int	numberOf(Coin coin) Counts the number of coins equal to the specified coin in this piggy bank.
Coin	remove(Owner user, Coin coin) Allows the owner of this piggy bank to remove a coin equal to the value of the specified coin from this piggy bank.
List<Coin>	removeCoins(Owner user, int value) Allows the owner of this piggy bank to remove the smallest number of coins whose total value in cents is equal to the specified value in cents from this piggy bank.

Methods inherited from class java.lang.Object

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

Constructor Detail

OwnedPiggyBank

public OwnedPiggyBank(Owner owner)

Initializes this piggy bank so that it has the specified owner and no coins.

Parameters:

owner - the owner of this piggy bank

OwnedPiggyBank

public OwnedPiggyBank(OwnedPiggyBank other)

Initializes this piggy bank by copying another piggy bank. This piggy bank will have the same owner and the same number and type of coins as the other piggy bank.

Parameters:

other - the piggy bank to copy

Method Detail

getOwner

public Owner getOwner()

Returns the owner of this piggy bank.

Returns:

the owner of this piggy bank

add

public void add(List<Coin> coins)

Adds the specified coins to this piggy bank.

Parameters:

coins - a list of coins to add to this piggy bank

contains

public boolean contains(Coin coin)

Returns true if this piggy bank contains the specified coin, and false otherwise.

Parameters:

coin - a coin

Returns:

true if this piggy bank contains the specified coin, and false otherwise

remove

public Coin remove(Owner user,
                   Coin coin)

Allows the owner of this piggy bank to remove a coin equal to the value of the specified coin from this piggy bank.

If the specified user is not equal to the owner of this piggy bank, then the coin is not removed from this piggy bank, and null is returned.

Parameters:

user - the person trying to remove the coin

coin - a coin

Returns:

a coin equal to the value of the specified coin from this piggy bank, or null if user is not the owner of this piggy bank

Precondition:

the piggy bank contains a coin equal to the specified coin

removeCoins

public List<Coin> removeCoins(Owner user,
                              int value)

Allows the owner of this piggy bank to remove the smallest number of coins whose total value in cents is equal to the specified value in cents from this piggy bank.

Returns the empty list if the specified user is not equal to the owner of this piggy bank.

Parameters:

user - the person trying to remove coins from this piggy bank

value - a value in cents

Returns:

the smallest number of coins whose total value in cents is equal to the specified value in cents from this piggy bank

Precondition:

the piggy bank contains a group of coins whose total value is equal to specified value

deepCopy

public List<Coin> deepCopy()

Returns a deep copy of the coins in this piggy bank. The returned list has its coins in sorted order (from smallest value to largest value; i.e., pennies first, followed by nickels, dimes, quarters, loonies, and toonies).

Returns:

a deep copy of the coins in this piggy bank

numberOf

public int numberOf(Coin coin)

Counts the number of coins equal to the specified coin in this piggy bank.

NOTE TO STUDENTS: You should create a private static helper method that recursively counts the number of coins in a specified list, array, or map depending on how you chose to implement the piggy bank. This method should then call the recursive method to get the required count.

Parameters:

coin - a coin

Returns:

the number of coins equal to the specified coin in this piggy bank