test2

Class Coin

java.lang.Object

test2.Coin

All Implemented Interfaces:

Comparable<Coin>

public class Coin
extends Object
implements Comparable<Coin>

A class that represents Canadian coins.

Field Summary

Fields

Modifier and Type	Field and Description
static Coin	DIME A coin representing a Canadian dime.
static Coin	LOONIE A coin representing a Canadian $1 coin.
static Coin	NICKEL A coin representing a Canadian nickel.
static Coin	PENNY A coin representing a Canadian penny.
static Coin	QUARTER A coin representing a Canadian quarter.
static Coin	TOONIE A coin representing a Canadian $2 coin.

Constructor Summary

Constructors

Constructor and Description
Coin(Coin c) Initializes this coin to have the same value as the specified coin.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Coin other) Compares this coin to the specified coin.
boolean	equals(Object obj) Compares this coin to another coin returning true if and only if the specified object is a Coin with the same value as this coin.
int	getValue() Returns the value of this coin in Canadian cents.
int	hashCode() Returns a hash code for this coin.
String	toString() Returns a string describing this coin.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

PENNY

public static final Coin PENNY

A coin representing a Canadian penny.

NICKEL

public static final Coin NICKEL

A coin representing a Canadian nickel.

DIME

public static final Coin DIME

A coin representing a Canadian dime.

QUARTER

public static final Coin QUARTER

A coin representing a Canadian quarter.

LOONIE

public static final Coin LOONIE

A coin representing a Canadian $1 coin.

TOONIE

public static final Coin TOONIE

A coin representing a Canadian $2 coin.

Constructor Detail

Coin

public Coin(Coin c)

Initializes this coin to have the same value as the specified coin.

Parameters:

c - a coin

Method Detail

getValue

public int getValue()

Returns the value of this coin in Canadian cents.

Returns:

the value of this coin in Canadian cents

hashCode

public int hashCode()

Returns a hash code for this coin.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Compares this coin to another coin returning true if and only if the specified object is a Coin with the same value as this coin.

Overrides:

equals in class Object

Parameters:

obj - the object to compare to this coin

Returns:

true if obj is a coin with the same value as this coin, and false otherwise

toString

public String toString()

Returns a string describing this coin. The returned string is one of "penny", "nickel", "dime", "quarter", "loonie", "twoonie".

Overrides:

toString in class Object

Returns:

a string representation of this coin

compareTo

public int compareTo(Coin other)

Compares this coin to the specified coin. The result is the equal to the difference this.getValue() - other.getValue().

Specified by:

compareTo in interface Comparable<Coin>

Parameters:

other - a coin to compare

Returns:

a positive value if the value of this coin is greater than the value of the other coin, a positive value if the value of this coin is greater than the value of the other coin, or zero if the coins have equal value.