Package net.engio.mbassy.common

Class AbstractConcurrentSet<T>

java.lang.Object

net.engio.mbassy.common.AbstractConcurrentSet<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

StrongConcurrentSet, WeakConcurrentSet

public abstract class AbstractConcurrentSet<T>
extends Object
implements Set<T>

This data structure is optimized for non-blocking reads even when write operations occur. Running read iterators will not be affected by add operations since writes always insert at the head of the structure. Remove operations can affect any running iterator such that a removed element that has not yet been reached by the iterator will not appear in that iterator anymore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractConcurrentSet.Entry<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<T,ISetEntry<T>>	entries
protected AbstractConcurrentSet.Entry<T>	head
private static final AtomicLong	id
private final long	ID
protected final ReentrantReadWriteLock	lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConcurrentSet(Map<T,ISetEntry<T>> entries)

Method Summary

Modifier and Type	Method	Description
boolean	add(T element)
boolean	addAll(Collection<? extends T> elements)
void	clear()
boolean	contains(Object element)
boolean	containsAll(Collection<?> c)
protected abstract AbstractConcurrentSet.Entry<T>	createEntry(T value, AbstractConcurrentSet.Entry<T> next)
boolean	equals(Object obj)
int	hashCode()
private boolean	insert(T element)	Inserts a new element at the head of the set.
boolean	isEmpty()
boolean	remove(Object element)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

iterator, spliterator

Field Details

id

private static final AtomicLong id

ID

private final long ID

lock

protected final ReentrantReadWriteLock lock

entries

private final Map<T,ISetEntry<T>> entries

head

protected AbstractConcurrentSet.Entry<T> head

Constructor Details

AbstractConcurrentSet

protected AbstractConcurrentSet(Map<T,ISetEntry<T>> entries)

Method Details

createEntry

protected abstract AbstractConcurrentSet.Entry<T> createEntry(T value,
 AbstractConcurrentSet.Entry<T> next)

add

public boolean add(T element)

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

contains

public boolean contains(Object element)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

insert

private boolean insert(T element)

Inserts a new element at the head of the set. Note: This method is expected to be synchronized by the calling code

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>

addAll

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

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

remove

public boolean remove(Object element)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

toArray

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

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

retainAll

public boolean retainAll(Collection<?> c)

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>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object