Package com.cedarsoftware.util

Class ConcurrentSet<T>

java.lang.Object

com.cedarsoftware.util.ConcurrentSet<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>

public class ConcurrentSet<T>
extends Object
implements Set<T>

ConcurrentSet provides a Set that is thread-safe and usable in highly concurrent environments. It supports adding and handling null elements by using a sentinel (NULL_ITEM).

Author:

John DeRegnaucourt
Copyright Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

License

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor	Description
ConcurrentSet()	Create a new empty ConcurrentSet.
ConcurrentSet(Collection<T> col)	Create a new ConcurrentSet instance with data from the passed-in Collection.
ConcurrentSet(Set<T> set)	Create a new ConcurrentSet instance by wrapping an existing Set.

Method Summary

Modifier and Type	Method	Description
boolean	add(T e)
boolean	addAll(Collection<? extends T> col)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> col)
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty()
Iterator<T>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> col)
boolean	retainAll(Collection<?> col)
int	size()
Object[]	toArray()
<T1> T1[]	toArray(T1[] a)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Constructor Details

ConcurrentSet

public ConcurrentSet()

Create a new empty ConcurrentSet.

ConcurrentSet

public ConcurrentSet(Collection<T> col)

Create a new ConcurrentSet instance with data from the passed-in Collection. This data is populated into the internal set with nulls replaced by NULL_ITEM.

Parameters:

col - Collection to supply initial elements.

ConcurrentSet

public ConcurrentSet(Set<T> set)

Create a new ConcurrentSet instance by wrapping an existing Set. Nulls in the existing set are replaced by NULL_ITEM.

Parameters:

set - Existing Set to wrap.

Method Details

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Set<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

toArray

public <T1> T1[] toArray(T1[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

containsAll

public boolean containsAll(Collection<?> col)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

addAll

public boolean addAll(Collection<? extends T> col)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

removeAll

public boolean removeAll(Collection<?> col)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

retainAll

public boolean retainAll(Collection<?> col)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface Set<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>