test3

Class Contact

java.lang.Object

test3.Contact

All Implemented Interfaces:

Comparable<Contact>

public class Contact
extends Object
implements Comparable<Contact>

A class that represents a telephone contact. Every contact has a name and a telephone number.

Constructor Summary

Constructors

Constructor and Description
Contact(Contact other) Initialize this contact to have the same name and telephone number as another contact.
Contact(String name, PhoneNumber number) Initialize this contact to have the specified name and telephone number.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Contact other) Compares this contact with another contact for order.
boolean	equals(Object obj) Compares two contacts for equality.
String	getName() Returns the name of this contact.
PhoneNumber	getNumber() Returns the telephone number of this contact.
int	hashCode() Returns a hash code for this contact.
void	setName(String name) Sets the name of this contact.
void	setNumber(PhoneNumber number) Set the phone number for this contact.
String	toString() Returns a string representation of this contact.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Contact

public Contact(String name,
               PhoneNumber number)

Initialize this contact to have the specified name and telephone number.

Parameters:

name - the name of this contact

number - the phone number of this contact

Contact

public Contact(Contact other)

Initialize this contact to have the same name and telephone number as another contact.

Parameters:

other - the contact to copy

Method Detail

getName

public String getName()

Returns the name of this contact.

Returns:

the name the name of this contact

setName

public final void setName(String name)

Sets the name of this contact.

Parameters:

name - the name to set

getNumber

public PhoneNumber getNumber()

Returns the telephone number of this contact.

Returns:

the telephone number of this contact

setNumber

public final void setNumber(PhoneNumber number)

Set the phone number for this contact.

Parameters:

number - the phone number of this contact

hashCode

public int hashCode()

Returns a hash code for this contact. The hash code is computed using the name and phone number of this contact.

Overrides:

hashCode in class Object

Returns:

a hash code for this contact

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Compares two contacts for equality. The result is true if and only if the argument is not null and is a Contact object that has the same name and telephone number as this contact.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this item against

Returns:

true if the given object represents a Contact equivalent to this contact, false otherwise

compareTo

public int compareTo(Contact other)

Compares this contact with another contact for order. Contacts are compared by the name of the contact using the String version of compareTo.

Specified by:

compareTo in interface Comparable<Contact>

Parameters:

other - a contact to compare with

Returns:

the value 0 if the argument contact name is equal to this contact name; a value less than 0 if this contact name is lexicographically less than the argument contact name; and a value greater than 0 if this contact name is lexicographically greater than the argument contact name.

toString

public String toString()

Returns a string representation of this contact. The returned string is the name of the contact followed by a space followed by the telephone number of the contact. The string representation of the telephone number is the area code in parentheses, followed by a space, followed by the first three digits of the phone number, followed by a hyphen, followed by the last four digits of the phone number.

Overrides:

toString in class Object

Returns:

a string representation of the contact

See Also:

Object.toString()