test3

Class ContactSet

java.lang.Object

test3.ContactSet

public class ContactSet
extends Object

A class that represents a collection of contacts. Every contact set has a non-empty name. A contact set guarantees that every contact is unique (i.e., no two contacts are equal). Two or more contacts with the same name are allowed as long as their phone numbers are different.

Constructor Summary

Constructors

Constructor and Description
ContactSet() Initializes this contact set to have a name.
ContactSet(ContactSet other) Initialize this contact set by copying the name and contacts from another contact set.
ContactSet(String setName) Initialize this contact set so that it has the given name and zero contacts.

Method Summary

Modifier and Type	Method and Description
void	add(Contact c) Add a new contact to this contact set.
Contact	getByName(String name) Returns a new copy of the contact having the given name.
List<Contact>	getContacts() Returns a list containing new copies of all of the contacts in this contact list.
String	getName() Return the name of this contact set.
void	setName(String name) Set the name of this contact set.
void	update(Contact c, String name, PhoneNumber number) Update the information for an existing contact in this contact set.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactSet

public ContactSet()

Initializes this contact set to have a name. Do not duplicate the code in this constructor; it is here for testing purposes in case your constructors are not implemented correctly.

ContactSet

public ContactSet(String setName)

Initialize this contact set so that it has the given name and zero contacts.

Parameters:

setName - the non-null name of this contact set

ContactSet

public ContactSet(ContactSet other)

Initialize this contact set by copying the name and contacts from another contact set. The contacts held by this contact set are new copies of the contacts held by the other contact set.

Parameters:

other - a non-null contact set to copy

Method Detail

getName

public String getName()

Return the name of this contact set.

Returns:

the name of this contact set

setName

public void setName(String name)

Set the name of this contact set.

Parameters:

name - a non-null name for this contact set

getContacts

public List<Contact> getContacts()

Returns a list containing new copies of all of the contacts in this contact list. The returned list is sorted by the names of the contacts.

Returns:

a sorted list containing new copies of all of the contacts in this contact list

getByName

public Contact getByName(String name)

Returns a new copy of the contact having the given name. If there are multiple contacts with the given name then any one of those contacts may be returned. null is returned if no contact with the given name is in this contact set.

Parameters:

name - the non-null name of the contact

Returns:

a new copy of the contact having the given name, or null if such a contact does not exist

update

public void update(Contact c,
                   String name,
                   PhoneNumber number)

Update the information for an existing contact in this contact set. If the specified contact is not in this contact set then a ContactDoesNotExistException is thrown and this set remains unchanged. If a contact with the same name and phone number as the updated contact information is already in this contact set then a DuplicateContactException is thrown and this set remains unchanged.

NOTE TO STUDENTS: To correctly update the set, you must remove the contact from the set and add the updated contact back to the set.

Parameters:

c - the non-null contact to update

name - the non-null updated contact name

number - the non-null updated contact number

Throws:

ContactDoesNotExistException - if the contact c is not in this contact set

DuplicateContactException - if a contact having the same name and number as the updated contact information is already in this contact set

add

public void add(Contact c)

Add a new contact to this contact set.

Parameters:

c - the non-null contact to add

Throws:

DuplicateContactException - if c is already in this contact set