au.edu.swin.synergy.plugin.addressbook
Class BAddressBook

java.lang.Object
  |
  +--au.edu.swin.synergy.plugin.addressbook.BAddressBook

public class BAddressBook

extends Object

implements Serializable

BAddressBook represents an entire address book full of BAddress objects.

Author:

Matthew Evans

See Also:

Serialized Form

Constructor Summary

BAddressBook()
Initialises the 'addresses' vector.

Method Summary

boolean	addEntry(BAddress newAddress) Adds a new BAddress object to the 'addresses' vector.
boolean	editEntry(BAddress addressToModify, BAddress modifiedAddress) Modifies the BAddress object at entryPos.
Vector	getAddresses() This method returns the vector containing the BAddress objects for this BAddressBook object.
boolean	removeEntry(BAddress address) Removes the BAddress object at entryPos from the 'addreses' vector.
boolean	save(String fileName) Save's this BAddressBook object to file.

Methods inherited from class java.lang.Object

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

Constructor Detail

BAddressBook

public BAddressBook()

Initialises the 'addresses' vector.

Method Detail

addEntry

public boolean addEntry(BAddress newAddress)

Adds a new BAddress object to the 'addresses' vector.

removeEntry

public boolean removeEntry(BAddress address)

Removes the BAddress object at entryPos from the 'addreses' vector.

Parameters:

entryPos - The position of the BAddress object to remove in the 'addresses' vector.

Returns:

true if the entry was successfully removed from the address book; false otherwise.

editEntry

public boolean editEntry(BAddress addressToModify,
                         BAddress modifiedAddress)

Modifies the BAddress object at entryPos.

Parameters:

entryPos - The position of BAddress object to be modified in the addresses vector.

modifiedAddress - The new BAddress object, contianing the modified details for the object at entryPos.

Returns:

true if the address was modified successfully; false otherwise.

getAddresses

public Vector getAddresses()

This method returns the vector containing the BAddress objects for this BAddressBook object.

Returns:

a vector of BAddress objects.

save

public boolean save(String fileName)

Save's this BAddressBook object to file.

Returns:

true if saved successfully; false otherwise.