test2

Class Item

java.lang.Object

test2.Item

All Implemented Interfaces:

Comparable<Item>

public class Item
extends Object
implements Comparable<Item>

A class that represents an item in a bill of sale. Every item has a description and a price. The price of an item is guaranteed to be greater than or equal to zero.

Field Summary

Fields

Modifier and Type	Field and Description
private String	desc
private int	price

Constructor Summary

Constructors

Constructor and Description
Item(Item other) Initialize an item by copying another item.
Item(String description, int price) Initialize an item by setting its description and price.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Item other) Compares two items numerically by their price.
boolean	equals(Object obj) Compares two items for equality.
String	getDescription() Get the item description.
int	getPrice() Get the item price.
int	hashCode() Returns the hash code for this item.
void	setDescription(String desc) Set the item description to the specified description.
void	setPrice(int price) Set the item price to the specified price.
String	toString() Returns a string representation of this item.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

desc

private String desc

price

private int price

Constructor Detail

Item

public Item(String description,
            int price)

Initialize an item by setting its description and price.

Parameters:

description - the item description

price - the item price

Throws:

IllegalArgumentException - if the item price is less than zero

Item

public Item(Item other)

Initialize an item by copying another item.

Parameters:

other - the item to copy

Method Detail

getDescription

public String getDescription()

Get the item description.

Returns:

the item description

setDescription

public void setDescription(String desc)

Set the item description to the specified description.

Parameters:

desc - the item description to set

getPrice

public int getPrice()

Get the item price.

Returns:

the item price

setPrice

public final void setPrice(int price)

Set the item price to the specified price.

Parameters:

price - the item price to set

Throws:

IllegalArgumentException - if the argument is less than zero

hashCode

public int hashCode()

Returns the hash code for this item.

Overrides:

hashCode in class Object

Returns:

the hash code for this item

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Compares two items for equality. The result is true if and only if the argument is not null and is an Item object that has the same description and price as this item.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this item against

Returns:

true if the given object represents an Item equivalent to this item, false otherwise

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Returns a string representation of this item. The returned string is the item's description followed by a space, then a dollar sign, then the item's price.

Overrides:

toString in class Object

Returns:

a string representation of this item

See Also:

Object.toString()

compareTo

public int compareTo(Item other)

Compares two items numerically by their price. If the items have the same price then the the items are compared lexicographically using their descriptions.

The value 0 is returned if both items have the same price.

A negative value is returned if this item has a price less than the other item, or if both items have the same price and this item has a description that is lexicographically less than the other item description.

A positive value is returned if this item has a price greater than the other item, or if both items have the same price and this item has a description that is lexicographically greater than the other item description.

Specified by:

compareTo in interface Comparable<Item>

Parameters:

other - the item to be compared

Returns:

see description above