org.apache.commons.collections.set
Class SynchronizedSortedSet<E>

java.lang.Object
  extended by org.apache.commons.collections.collection.SynchronizedCollection<E>
      extended by org.apache.commons.collections.set.SynchronizedSortedSet<E>
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, Set<E>, SortedSet<E>

public class SynchronizedSortedSet<E>
extends SynchronizedCollection<E>
implements SortedSet<E>

Decorates another SortedSet to synchronize its behaviour for a multi-threaded environment.

Methods are synchronized, then forwarded to the decorated set.

This class is Serializable from Commons Collections 3.1.

Since:
Commons Collections 3.0
Version:
$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:36:24 $
Author:
Matt Hall, John Watkinson, Stephen Colebourne
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.commons.collections.collection.SynchronizedCollection
collection, lock
 
Constructor Summary
protected SynchronizedSortedSet(SortedSet<E> set)
          Constructor that wraps (not copies).
protected SynchronizedSortedSet(SortedSet<E> set, Object lock)
          Constructor that wraps (not copies).
 
Method Summary
 Comparator<? super E> comparator()
           
static
<E> SortedSet<E>
decorate(SortedSet<E> set)
          Factory method to create a synchronized set.
 E first()
           
protected  SortedSet<E> getSortedSet()
          Gets the decorated set.
 SortedSet<E> headSet(E toElement)
           
 E last()
           
 SortedSet<E> subSet(E fromElement, E toElement)
           
 SortedSet<E> tailSet(E fromElement)
           
 
Methods inherited from class org.apache.commons.collections.collection.SynchronizedCollection
add, addAll, clear, contains, containsAll, decorate, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 

Constructor Detail

SynchronizedSortedSet

protected SynchronizedSortedSet(SortedSet<E> set)
Constructor that wraps (not copies).

Parameters:
set - the set to decorate, must not be null
Throws:
IllegalArgumentException - if set is null

SynchronizedSortedSet

protected SynchronizedSortedSet(SortedSet<E> set,
                                Object lock)
Constructor that wraps (not copies).

Parameters:
set - the set to decorate, must not be null
lock - the lock object to use, must not be null
Throws:
IllegalArgumentException - if set is null
Method Detail

decorate

public static <E> SortedSet<E> decorate(SortedSet<E> set)
Factory method to create a synchronized set.

Parameters:
set - the set to decorate, must not be null
Throws:
IllegalArgumentException - if set is null

getSortedSet

protected SortedSet<E> getSortedSet()
Gets the decorated set.

Returns:
the decorated set

subSet

public SortedSet<E> subSet(E fromElement,
                           E toElement)
Specified by:
subSet in interface SortedSet<E>

headSet

public SortedSet<E> headSet(E toElement)
Specified by:
headSet in interface SortedSet<E>

tailSet

public SortedSet<E> tailSet(E fromElement)
Specified by:
tailSet in interface SortedSet<E>

first

public E first()
Specified by:
first in interface SortedSet<E>

last

public E last()
Specified by:
last in interface SortedSet<E>

comparator

public Comparator<? super E> comparator()
Specified by:
comparator in interface SortedSet<E>


Copyright © 2005-2005 Apache Software Foundation, Matt Hall, John Watkinson. All Rights Reserved.