org.apache.commons.collections.bag
Class SynchronizedSortedBag<E>

java.lang.Object
  extended by org.apache.commons.collections.collection.SynchronizedCollection<E>
      extended by org.apache.commons.collections.bag.SynchronizedBag<E>
          extended by org.apache.commons.collections.bag.SynchronizedSortedBag<E>
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, Bag<E>, SortedBag<E>

public class SynchronizedSortedBag<E>
extends SynchronizedBag<E>
implements SortedBag<E>

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

Methods are synchronized, then forwarded to the decorated bag. Iterators must be separately synchronized around the loop.

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:33:30 $
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 SynchronizedSortedBag(Bag<E> bag, Object lock)
          Constructor that wraps (not copies).
protected SynchronizedSortedBag(SortedBag<E> bag)
          Constructor that wraps (not copies).
 
Method Summary
 Comparator<? super E> comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
static
<E> SortedBag<E>
decorate(SortedBag<E> bag)
          Factory method to create a synchronized sorted bag.
 E first()
          Returns the first (lowest) member.
protected  SortedBag<E> getSortedBag()
          Gets the bag being decorated.
 E last()
          Returns the last (highest) member.
 
Methods inherited from class org.apache.commons.collections.bag.SynchronizedBag
add, decorate, getBag, getCount, remove, uniqueSet
 
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 org.apache.commons.collections.Bag
add, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSet
 
Methods inherited from interface java.util.Collection
addAll, clear, contains, equals, hashCode, isEmpty, toArray, toArray
 

Constructor Detail

SynchronizedSortedBag

protected SynchronizedSortedBag(SortedBag<E> bag)
Constructor that wraps (not copies).

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

SynchronizedSortedBag

protected SynchronizedSortedBag(Bag<E> bag,
                                Object lock)
Constructor that wraps (not copies).

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

decorate

public static <E> SortedBag<E> decorate(SortedBag<E> bag)
Factory method to create a synchronized sorted bag.

Parameters:
bag - the bag to decorate, must not be null
Returns:
a new synchronized SortedBag
Throws:
IllegalArgumentException - if bag is null

getSortedBag

protected SortedBag<E> getSortedBag()
Gets the bag being decorated.

Returns:
the decorated bag

first

public E first()
Description copied from interface: SortedBag
Returns the first (lowest) member.

Specified by:
first in interface SortedBag<E>
Returns:
the first element in the sorted bag

last

public E last()
Description copied from interface: SortedBag
Returns the last (highest) member.

Specified by:
last in interface SortedBag<E>
Returns:
the last element in the sorted bag

comparator

public Comparator<? super E> comparator()
Description copied from interface: SortedBag
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Specified by:
comparator in interface SortedBag<E>
Returns:
the comparator in use, or null if natural ordering


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