cse1030

Class Gold

java.lang.Object

cse1030.Gold

public class Gold
extends Object

A class that represents quantities (weight) of mined gold. The class defines a total reserve of gold that is available to be mined. Once the reserve is exhausted only gold objects having zero weight can be created.

Author:

CSE1030

Field Summary

Fields

Modifier and Type	Field and Description
static int	TOTAL_RESERVES The total weight of gold available to be mined.

Constructor Summary

Constructors

Constructor and Description
Gold(int weight) Creates an amount of gold mined from the reserves.

Method Summary

Methods

Modifier and Type	Method and Description
int	getWeight() The weight of the gold object.
static void	main(String[] args)
static int	remaining() The weight of gold remaining in the reserves.
String	toString() Returns a string representation of the gold object.

Methods inherited from class java.lang.Object

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

Field Detail

TOTAL_RESERVES

public static final int TOTAL_RESERVES

The total weight of gold available to be mined.

See Also:

Constant Field Values

Constructor Detail

Gold

public Gold(int weight)

Creates an amount of gold mined from the reserves. If the amount requested exceeds the amount remaining in the reserves than an amount is created equal to the amount remaining in the reserves.

Parameters:

weight - The weight of gold to mine.

Precondition

weight >= 0

Method Detail

getWeight

public int getWeight()

The weight of the gold object.

Returns:

The weight of the gold object.

remaining

public static int remaining()

The weight of gold remaining in the reserves.

Returns:

The weight of gold remaining in the reserves.

toString

public String toString()

Returns a string representation of the gold object. The returned string is "Weight = " followed by the weight of the gold object.

Overrides:

toString in class Object

Returns:

A string representation of the gold object.

main

public static void main(String[] args)