oracle.javatools.util

Class ListenableTreeSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<E>

oracle.javatools.util.ListenableTreeSet<E>

Type Parameters:

E - the type of item in the set

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.NavigableSet<E>, java.util.Set<E>, java.util.SortedSet<E>, ListenableCollection<E>

public class ListenableTreeSet<E>
extends java.util.TreeSet<E>
implements ListenableCollection<E>

A TreeSet that notifies listeners when items are added or removed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListenableTreeSet(java.util.Collection<? extends E> c)
ListenableTreeSet(java.util.Comparator<? super E> comparator)
ListenableTreeSet(java.util.SortedSet<E> s)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e) Adds the specified element to this set if it is not already present.
boolean	addAll(java.util.Collection<? extends E> c) Adds all of the elements in the specified collection to this set.
void	addListener(CollectionListener<E> listener) Add a listener to be notified when the set changes.
void	clear() Removes all of the elements from this set.
protected java.util.List<CollectionListener<E>>	createListenerList() Create a list to hold the registered listeners.
protected void	fireChange(CollectionEvent.Type type, E element, int index)
boolean	remove(java.lang.Object o) Removes the specified element from this set if it is present.
boolean	removeAll(java.util.Collection<?> c) Removes from this set all of its elements that are contained in the specified collection (optional operation).
void	removeListener(CollectionListener<E> listener) Remove a listener to stop listening when the set changes.
boolean	retainAll(java.util.Collection<?> c)

Methods inherited from class java.util.TreeSet

ceiling, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, size, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, size, toArray, toArray

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, toArray, toArray

Constructor Detail

ListenableTreeSet

public ListenableTreeSet(java.util.SortedSet<E> s)

ListenableTreeSet

public ListenableTreeSet(java.util.Comparator<? super E> comparator)

ListenableTreeSet

public ListenableTreeSet(java.util.Collection<? extends E> c)

Method Detail

addListener

public void addListener(CollectionListener<E> listener)

Add a listener to be notified when the set changes.

Specified by:

addListener in interface ListenableCollection<E>

Parameters:

listener -

removeListener

public void removeListener(CollectionListener<E> listener)

Remove a listener to stop listening when the set changes.

Specified by:

removeListener in interface ListenableCollection<E>

Parameters:

listener -

fireChange

protected void fireChange(CollectionEvent.Type type,
              E element,
              int index)

createListenerList

protected java.util.List<CollectionListener<E>> createListenerList()

Create a list to hold the registered listeners. Subclasses may wish to use an alternative to CopyOnWriteArrayList.

Returns:

the list that holds the listeners.

add

public boolean add(E e)

Adds the specified element to this set if it is not already present. More formally, adds the specified element e to this set if the set contains no element e2 such that (e==null ? e2==null : e.equals(e2)). If this set already contains the element, the call leaves the set unchanged and returns false.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

Overrides:

add in class java.util.TreeSet<E>

Parameters:

e - element to be added to this set

Returns:

true if this set did not already contain the specified element

Throws:

java.lang.ClassCastException - if the specified object cannot be compared with the elements currently in this set

java.lang.NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Adds all of the elements in the specified collection to this set.

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

Overrides:

addAll in class java.util.TreeSet<E>

Parameters:

c - collection containing elements to be added to this set

Returns:

true if this set changed as a result of the call

Throws:

java.lang.ClassCastException - if the elements provided cannot be compared with the elements currently in the set

java.lang.NullPointerException - if the specified collection is null or if any element is null and this set uses natural ordering, or its comparator does not permit null elements

clear

public void clear()

Removes all of the elements from this set. The set will be empty after this call returns.

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

Overrides:

clear in class java.util.TreeSet<E>

remove

public boolean remove(java.lang.Object o)

Removes the specified element from this set if it is present. More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

Overrides:

remove in class java.util.TreeSet<E>

Parameters:

o - object to be removed from this set, if present

Returns:

true if this set contained the specified element

Throws:

java.lang.ClassCastException - if the specified object cannot be compared with the elements currently in this set

java.lang.NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements

removeAll

public boolean removeAll(java.util.Collection<?> c)

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

Overrides:

removeAll in class java.util.AbstractSet<E>

Parameters:

c - collection containing elements to be removed from this set

Returns:

true if this set changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the removeAll operation is not supported by this set

java.lang.ClassCastException - if the class of an element of this set is incompatible with the specified collection (optional)

java.lang.NullPointerException - if this set contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null

See Also:

remove(Object), TreeSet.contains(Object)

retainAll

public boolean retainAll(java.util.Collection<?> c)

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's not so contained, it's removed from this collection with the iterator's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements not present in the specified collection.

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

Overrides:

retainAll in class java.util.AbstractCollection<E>

Throws:

java.lang.UnsupportedOperationException

java.lang.ClassCastException

java.lang.NullPointerException

See Also:

remove(Object), TreeSet.contains(Object)