util/concurrent/CopyOnWriteArraySet.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain. Use, modify, and
 * redistribute this code in any way without acknowledgement.
 */

package java.util.concurrent;
import java.util.*;

/**
 * A {@link java.util.Set} that uses {@link
 * java.util.concurrent.CopyOnWriteArrayList} for all of its
 * operations.  Thus, it shares the same basic properties:
 * <ul>
 *  <li>It is best suited for applications in which set sizes generally
 *       stay small, read-only operations
 *       vastly outnumber mutative operations, and you need
 *       to prevent interference among threads during traversal.
 *  <li>Mutative operations(add, set, remove, etc) are expensive
 *      since they usually entail copying the entire underlying array.
 *  <li>Iterators do not support the mutative remove operation
 *  <li>Traversal via iterators is very fast and cannot ever encounter
 *      interference from other threads. Iterators rely on
 *      unchanging snapshots of the array at the time the iterators were
 *     constructed.
 * </ul>
 * <p>
 * <b>Sample Usage.</b> Probably the main application
 * of copy-on-write sets are classes that maintain
 * sets of Handler objects
 * that must be multicasted to upon an update command. This
 * is a classic case where you do not want to be holding a
 * lock while sending a message, and where traversals normally
 * vastly overwhelm additions.
 * <pre>
 * class Handler { void handle(); ... }
 *
 * class X {
 *    private final CopyOnWriteArraySet<Handler> handlers = new CopyOnWriteArraySet<Handler>();
 *    public void addHandler(Handler h) { handlers.add(h); }
 *
 *    private long internalState;
 *    private synchronized void changeState() { internalState = ...; }
 *
 *    public void update() {
 *       changeState();
 *       Iterator it = handlers.iterator();
 *       while (it.hasNext())
 *          it.next().handle();
 *    }
 * }
 * </pre>
 * @see CopyOnWriteArrayList
 * @since 1.5
 * @author Doug Lea
 * @param <E> the type of elements held in this collection
 */
public class CopyOnWriteArraySet<E> extends AbstractSet<E>
        implements Cloneable, java.io.Serializable {
    private static final long serialVersionUID = 5457747651344034263L;

    private final CopyOnWriteArrayList<E> al;

    /**
     * Constructs an empty set.
     */
    public CopyOnWriteArraySet() {
        al = new CopyOnWriteArrayList<E>();
    }

    /**
     * Constructs a set containing all of the elements of the specified
     * Collection.
     * @param c the collection
     */
    public <T extends E> CopyOnWriteArraySet(Collection<T> c) {
        al = new CopyOnWriteArrayList<E>();
        al.addAllAbsent(c);
    }


    public int      size()                    { return al.size(); }
    public boolean  isEmpty()                 { return al.isEmpty(); }
    public boolean  contains(Object o)        { return al.contains(o); }
    public Object[] toArray()                 { return al.toArray(); }
    public <T> T[]  toArray(T[] a)            { return al.toArray(a); }
    public void     clear()                   {        al.clear(); }
    public Iterator<E>  iterator()            { return al.iterator(); }
    public boolean  remove(Object o)          { return al.remove(o); }
    public boolean  add(E o)                  { return al.addIfAbsent(o); }
    public boolean  containsAll(Collection<?> c)      { return al.containsAll(c); }
    public boolean  addAll(Collection<? extends E> c) { return al.addAllAbsent(c) > 0; }
    public boolean  removeAll(Collection<?> c)        { return al.removeAll(c); }
    public boolean  retainAll(Collection<?> c)        { return al.retainAll(c); }

}
Revision:	1.11
Committed:	Sun Oct 19 13:38:34 2003 UTC (20 years, 7 months ago) by dl
Branch:	MAIN
CVS Tags:	JSR166_NOV3_FREEZE, JSR166_DEC9_PRE_ES_SUBMIT, JSR166_DEC9_POST_ES_SUBMIT
Changes since 1.10:	+1 -1 lines
Log Message:	Changed doc strings for generic params
#	User	Rev	Content
1	dl	1.2	/*
2			* Written by Doug Lea with assistance from members of JCP JSR-166
3			* Expert Group and released to the public domain. Use, modify, and
4			* redistribute this code in any way without acknowledgement.
5			*/
6
7	tim	1.1	package java.util.concurrent;
8			import java.util.*;
9
10			/**
11	dl	1.3	* A {@link java.util.Set} that uses {@link
12			* java.util.concurrent.CopyOnWriteArrayList} for all of its
13			* operations. Thus, it shares the same basic properties:
14	tim	1.1	* <ul>
15	dholmes	1.7	* <li>It is best suited for applications in which set sizes generally
16	tim	1.1	* stay small, read-only operations
17			* vastly outnumber mutative operations, and you need
18			* to prevent interference among threads during traversal.
19	dholmes	1.7	* <li>Mutative operations(add, set, remove, etc) are expensive
20	tim	1.1	* since they usually entail copying the entire underlying array.
21	dholmes	1.7	* <li>Iterators do not support the mutative remove operation
22			* <li>Traversal via iterators is very fast and cannot ever encounter
23	tim	1.1	* interference from other threads. Iterators rely on
24			* unchanging snapshots of the array at the time the iterators were
25			* constructed.
26			* </ul>
27			* <p>
28			* <b>Sample Usage.</b> Probably the main application
29			* of copy-on-write sets are classes that maintain
30			* sets of Handler objects
31			* that must be multicasted to upon an update command. This
32	tim	1.5	* is a classic case where you do not want to be holding a
33	tim	1.1	* lock while sending a message, and where traversals normally
34			* vastly overwhelm additions.
35			* <pre>
36	tim	1.6	* class Handler { void handle(); ... }
37	tim	1.1	*
38			* class X {
39	dl	1.10	* private final CopyOnWriteArraySet<Handler> handlers = new CopyOnWriteArraySet<Handler>();
40	tim	1.1	* public void addHandler(Handler h) { handlers.add(h); }
41			*
42			* private long internalState;
43			* private synchronized void changeState() { internalState = ...; }
44			*
45			* public void update() {
46			* changeState();
47			* Iterator it = handlers.iterator();
48			* while (it.hasNext())
49	dl	1.10	* it.next().handle();
50	tim	1.1	* }
51			* }
52	tim	1.6	* </pre>
53	tim	1.1	* @see CopyOnWriteArrayList
54	dl	1.4	* @since 1.5
55			* @author Doug Lea
56	dl	1.11	* @param <E> the type of elements held in this collection
57	dl	1.4	*/
58	tim	1.1	public class CopyOnWriteArraySet<E> extends AbstractSet<E>
59			implements Cloneable, java.io.Serializable {
60	dl	1.8	private static final long serialVersionUID = 5457747651344034263L;
61	tim	1.1
62			private final CopyOnWriteArrayList<E> al;
63
64			/**
65	tim	1.6	* Constructs an empty set.
66	tim	1.1	*/
67			public CopyOnWriteArraySet() {
68			al = new CopyOnWriteArrayList<E>();
69			}
70
71			/**
72			* Constructs a set containing all of the elements of the specified
73			* Collection.
74	dl	1.4	* @param c the collection
75	tim	1.1	*/
76			public <T extends E> CopyOnWriteArraySet(Collection<T> c) {
77			al = new CopyOnWriteArrayList<E>();
78			al.addAllAbsent(c);
79			}
80
81
82			public int size() { return al.size(); }
83			public boolean isEmpty() { return al.isEmpty(); }
84			public boolean contains(Object o) { return al.contains(o); }
85			public Object[] toArray() { return al.toArray(); }
86			public <T> T[] toArray(T[] a) { return al.toArray(a); }
87			public void clear() { al.clear(); }
88			public Iterator<E> iterator() { return al.iterator(); }
89			public boolean remove(Object o) { return al.remove(o); }
90			public boolean add(E o) { return al.addIfAbsent(o); }
91	tim	1.5	public boolean containsAll(Collection<?> c) { return al.containsAll(c); }
92			public boolean addAll(Collection<? extends E> c) { return al.addAllAbsent(c) > 0; }
93			public boolean removeAll(Collection<?> c) { return al.removeAll(c); }
94			public boolean retainAll(Collection<?> c) { return al.retainAll(c); }
95	tim	1.1
96			}