org.apache.commons.collections.bag.SynchronizedSortedBag Maven / Gradle / Ivy
Show all versions of commons-collections Show documentation
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* .
*/
package org.apache.commons.collections.bag;
import java.util.Comparator;
import org.apache.commons.collections.Bag;
import org.apache.commons.collections.SortedBag;
/**
* 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.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2004/01/14 21:43:08 $
*
* @author Stephen Colebourne
*/
public class SynchronizedSortedBag
extends SynchronizedBag implements SortedBag {
/**
* Factory method to create a synchronized sorted bag.
*
* @param bag the bag to decorate, must not be null
* @throws IllegalArgumentException if bag is null
*/
public static SortedBag decorate(SortedBag bag) {
return new SynchronizedSortedBag(bag);
}
//-----------------------------------------------------------------------
/**
* Constructor that wraps (not copies).
*
* @param bag the bag to decorate, must not be null
* @throws IllegalArgumentException if bag is null
*/
protected SynchronizedSortedBag(SortedBag bag) {
super(bag);
}
/**
* Constructor that wraps (not copies).
*
* @param bag the bag to decorate, must not be null
* @param lock the lock to use, must not be null
* @throws IllegalArgumentException if bag is null
*/
protected SynchronizedSortedBag(Bag bag, Object lock) {
super(bag, lock);
}
protected SortedBag getSortedBag() {
return (SortedBag) collection;
}
//-----------------------------------------------------------------------
public synchronized Object first() {
synchronized (lock) {
return getSortedBag().first();
}
}
public synchronized Object last() {
synchronized (lock) {
return getSortedBag().last();
}
}
public synchronized Comparator comparator() {
synchronized (lock) {
return getSortedBag().comparator();
}
}
}