net.wimpi.pim.contact.db.serializable
Class ContactGroupCollectionImpl

java.lang.Object
  |
  +--net.wimpi.pim.contact.db.serializable.ContactGroupCollectionImpl

All Implemented Interfaces:

ContactGroupCollection, java.io.Serializable

public class ContactGroupCollectionImpl

extends java.lang.Object

implements ContactGroupCollection, java.io.Serializable

Class representing a serializable ContactGroupCollection. implementation.

Version:

0.1 (22/07/2003)

Author:

Dieter Wimberger

See Also:

Serialized Form

Field Summary

protected java.util.Map	m_Groups
protected int	m_ModCount
protected java.util.Map	m_NameIndex

Constructor Summary

ContactGroupCollectionImpl()

Method Summary

boolean	add(ContactGroup group) Adds a given contact group to this ContactGroupCollection.
boolean	contains(ContactGroup group) Tests if this ContactGroupCollection contains a given contact group.
boolean	contains(java.lang.String UID) Tests if this ContactGroupCollection contains a given contact group.
boolean	containsByName(java.lang.String name) Tests if this ContactGroupCollection contains a contact group with the given name.
ContactGroup	get(java.lang.String UID) Returns the ContactGroup instance for a given unique identifier.
ContactGroup	getByName(java.lang.String name) Returns the ContactGroup instance with a given name.
java.util.Iterator	iterator() Returns an iterator over all groups in this ContactGroupCollection.
java.util.Iterator	iterator(ContactGroupFilter filter) Returns an iterator over all contact groups in this ContactGroupCollection, that pass the given filter.
void	remove(ContactGroup group) Removes a given contact group from this ContactGroupCollection.
ContactGroup	remove(java.lang.String UID) Removes a given contact group from this ContactGroupCollection.
int	size() Returns the number of groups in this ContactGroupCollection.
ContactGroup[]	toArray() Returns all contact groups in this ContactGroupCollection.
ContactGroup[]	toArray(ContactGroupFilter filter) Returns all contact groups in this ContactGroupCollection, that pass the given filter.

Methods inherited from class java.lang.Object

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

Field Detail

m_Groups

protected java.util.Map m_Groups

m_NameIndex

protected java.util.Map m_NameIndex

m_ModCount

protected transient int m_ModCount

Constructor Detail

ContactGroupCollectionImpl

public ContactGroupCollectionImpl()

Method Detail

contains

public boolean contains(java.lang.String UID)

Description copied from interface: ContactGroupCollection

Tests if this ContactGroupCollection contains a given contact group.

Specified by:

contains in interface ContactGroupCollection

Parameters:

UID - the unique identifier of the group as String.

Returns:

true if contains group, false otherwise.

contains

public boolean contains(ContactGroup group)

Description copied from interface: ContactGroupCollection

Tests if this ContactGroupCollection contains a given contact group.

Specified by:

contains in interface ContactGroupCollection

Parameters:

group - the group as ContactGroup.

Returns:

true if contains group, false otherwise.

containsByName

public boolean containsByName(java.lang.String name)

Description copied from interface: ContactGroupCollection

Tests if this ContactGroupCollection contains a contact group with the given name.

Specified by:

containsByName in interface ContactGroupCollection

Parameters:

name - the unique name of the group as String.

Returns:

true if contains group, false otherwise.

get

public ContactGroup get(java.lang.String UID)

Description copied from interface: ContactGroupCollection

Returns the ContactGroup instance for a given unique identifier.

Specified by:

get in interface ContactGroupCollection

Parameters:

UID - the unique identifier of a group as String.

Returns:

the group as ContactGroup.

getByName

public ContactGroup getByName(java.lang.String name)

Description copied from interface: ContactGroupCollection

Returns the ContactGroup instance with a given name.

Specified by:

getByName in interface ContactGroupCollection

Parameters:

name - the name of the group as String.

Returns:

the group as ContactGroup.

toArray

public ContactGroup[] toArray()

Description copied from interface: ContactGroupCollection

Returns all contact groups in this ContactGroupCollection.

Specified by:

toArray in interface ContactGroupCollection

Returns:

the list of groups as ContactGroup[].

toArray

public ContactGroup[] toArray(ContactGroupFilter filter)

Description copied from interface: ContactGroupCollection

Returns all contact groups in this ContactGroupCollection, that pass the given filter.

Specified by:

toArray in interface ContactGroupCollection

Parameters:

filter - the filter as ContactGroupFilter.

Returns:

the list of contacts as ContactGroup[].

add

public boolean add(ContactGroup group)

Description copied from interface: ContactGroupCollection

Adds a given contact group to this ContactGroupCollection. Contact groups should have unique names, thus, when adding a group with an existing name, this method should not add the group and return false.

Specified by:

add in interface ContactGroupCollection

Parameters:

group - the contact group as ContactGroup.

Returns:

true if successful, false otherwise.

remove

public ContactGroup remove(java.lang.String UID)

Description copied from interface: ContactGroupCollection

Removes a given contact group from this ContactGroupCollection.

Specified by:

remove in interface ContactGroupCollection

Parameters:

UID - the unique identifier of a group as String.

Returns:

the ContactGroup instance removed, or null otherwise.

remove

public void remove(ContactGroup group)

Description copied from interface: ContactGroupCollection

Removes a given contact group from this ContactGroupCollection.

Specified by:

remove in interface ContactGroupCollection

Parameters:

group - the contact group as ContactGroup.

iterator

public java.util.Iterator iterator()

Description copied from interface: ContactGroupCollection

Returns an iterator over all groups in this ContactGroupCollection.

Specified by:

iterator in interface ContactGroupCollection

Returns:

an ,tt>Iterator instance.

iterator

public java.util.Iterator iterator(ContactGroupFilter filter)

Description copied from interface: ContactGroupCollection

Returns an iterator over all contact groups in this ContactGroupCollection, that pass the given filter.

Specified by:

iterator in interface ContactGroupCollection

Parameters:

filter - the filter as ContactGroupFilter.

Returns:

an Iterator instance.

size

public int size()

Description copied from interface: ContactGroupCollection

Returns the number of groups in this ContactGroupCollection.

Specified by:

size in interface ContactGroupCollection

Returns:

the number of groups as int.