org.apache.pivot.collections.concurrent
Class SynchronizedSet<E>

java.lang.Object
  org.apache.pivot.collections.concurrent.SynchronizedSet<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Group<E>, Set<E>

public class SynchronizedSet<E>
extends Object
implements Set<E>

Synchronized implementation of the Set interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Set

Set.SetListenerList<E>

Constructor Summary

SynchronizedSet(Set<E> set)

Method Summary

boolean	add(E element) Adds an element to the group.
void	clear() Removes all elements from the collection.
boolean	contains(E element) Tests the existence of an element in the group.
Comparator<E>	getComparator() Returns the collection's sort order.
int	getCount() Returns the number of elements in the set.
ListenerList<SetListener<E>>	getSetListeners() Returns the set listener collection.
boolean	isEmpty() Tests the emptiness of the collection.
Iterator<E>	iterator() NOTE Callers must manually synchronize on the SynchronizedSet instance to ensure thread safety during iteration.
boolean	remove(E element) Removes an element from the group.
void	setComparator(Comparator<E> comparator) Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizedSet

public SynchronizedSet(Set<E> set)

Method Detail

add

public boolean add(E element)

Description copied from interface: Group

Adds an element to the group.

Specified by:

add in interface Group<E>

Specified by:

add in interface Set<E>

Parameters:

element - The element to add to the group.

Returns:

true if the element was added to the group; false, otherwise.

See Also:

SetListener.elementAdded(Set, Object)

remove

public boolean remove(E element)

Description copied from interface: Group

Removes an element from the group.

Specified by:

remove in interface Group<E>

Specified by:

remove in interface Set<E>

Parameters:

element - The element to remove from the set.

Returns:

true if the element was removed from the group; false, otherwise.

See Also:

SetListener.elementRemoved(Set, Object)

contains

public boolean contains(E element)

Description copied from interface: Group

Tests the existence of an element in the group.

Specified by:

contains in interface Group<E>

Parameters:

element - The element whose presence in the group is to be tested.

Returns:

true if the element exists in the group; false, otherwise.

isEmpty

public boolean isEmpty()

Description copied from interface: Collection

Tests the emptiness of the collection.

Specified by:

isEmpty in interface Collection<E>

Returns:

true if the collection contains no elements; false, otherwise.

clear

public void clear()

Description copied from interface: Collection

Removes all elements from the collection.

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

See Also:

SetListener.setCleared(Set)

getCount

public int getCount()

Description copied from interface: Set

Returns the number of elements in the set.

Specified by:

getCount in interface Set<E>

getComparator

public Comparator<E> getComparator()

Description copied from interface: Collection

Returns the collection's sort order.

Specified by:

getComparator in interface Collection<E>

Returns:

The comparator used to order elements in the collection, or null if the sort order is undefined.

See Also:

Collection.setComparator(Comparator)

setComparator

public void setComparator(Comparator<E> comparator)

Description copied from interface: Collection

Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

Calling this method more than once with the same comparator will re-sort the collection.

Specified by:

setComparator in interface Collection<E>

Specified by:

setComparator in interface Set<E>

Parameters:

comparator - The comparator used to order elements in the collection, or null if the collection is unsorted.

See Also:

SetListener.setCleared(Set)

iterator

public Iterator<E> iterator()

NOTE Callers must manually synchronize on the SynchronizedSet instance to ensure thread safety during iteration.

Specified by:

iterator in interface Iterable<E>

getSetListeners

public ListenerList<SetListener<E>> getSetListeners()

Description copied from interface: Set

Returns the set listener collection.

Specified by:

getSetListeners in interface Set<E>