com.gemstone.gemfire.internal.concurrent

Class ConcurrentTHashSet<T>

java.lang.Object

com.gemstone.gemfire.internal.concurrent.THashParameters

com.gemstone.gemfire.internal.concurrent.ConcurrentTHashSet<T>

Type Parameters:

T - the type of elements maintained by this set

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

public class ConcurrentTHashSet<T>
extends com.gemstone.gemfire.internal.concurrent.THashParameters
implements java.util.Set<T>

A concurrent version of Trove's THashSet.

Since:

gfxd 1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConcurrentTHashSet.Itr

Nested classes/interfaces inherited from class com.gemstone.gemfire.internal.concurrent.THashParameters

com.gemstone.gemfire.internal.concurrent.THashParameters.ObjectHashing

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONCURRENCY
protected int	numSegments
protected com.gemstone.gemfire.internal.concurrent.ConcurrentTHashSegment<T>[]	segments

Fields inherited from class com.gemstone.gemfire.internal.concurrent.THashParameters

DEFAULT_HASHING, hashingStrategy, loadFactor, stats

Constructor Summary

Constructors

Constructor and Description
ConcurrentTHashSet()
ConcurrentTHashSet(int concurrency)
ConcurrentTHashSet(int concurrency, int initialCapacity)
ConcurrentTHashSet(int concurrency, int initialCapacity, float loadFactor, com.gemstone.gnu.trove.TObjectHashingStrategy strategy, com.gemstone.gnu.trove.HashingStats stats)
ConcurrentTHashSet(com.gemstone.gnu.trove.TObjectHashingStrategy strategy)
ConcurrentTHashSet(com.gemstone.gnu.trove.TObjectHashingStrategy strategy, com.gemstone.gnu.trove.HashingStats stats)

Method Summary

Modifier and Type	Method and Description
boolean	add(T e)
boolean	addAll(java.util.Collection<? extends T> c)
java.lang.Object	addKey(T e) Like add(Object) but returns the current key if already present in set (instead of false) else null (instead of true).
boolean	bulkRemoveAll(java.util.Collection<?> c) Like removeAll(Collection) but optimized for large size of collection to minimize lock acquire/release and duration of locking.
long	capacity()
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
<K,C,P> T	create(K key, com.gemstone.gemfire.internal.concurrent.MapCallback<K,T,C,P> valueCreator, C context, P createParams) Like add(T) but creates the value only if none present rather than requiring a passed in pre-created object that may ultimately be thrown away.
<E> E[]	drainTo(E[] a) copy the contents in array and clear the map as atomic operation
long	estimateMemoryOverhead(SingleObjectSizer sizer)
boolean	forEach(com.gemstone.gnu.trove.TObjectProcedure proc) Apply the given procedure for each element of the set.
T	get(java.lang.Object o) Get the value in the set lookup up against given object, or null if not present.
T	getUnsafe(java.lang.Object o) Like get(Object) but skips acquiring any locks.No product code should use this except for monitoring or other such purposes which should not wait for locks and is not affected much by inaccurate results.
boolean	isEmpty()
ConcurrentTHashSet.Itr	iterator()
void	lockAllSegmentsForRead()
long	longSize()
java.lang.Object	put(T e) Like addKey(Object) but replaces the current key if present.
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
T	removeKey(java.lang.Object o) Like remove(Object) but returns the current key if present in set and removed (instead of true) else null (instead of false).
boolean	replace(java.lang.Object o, T e) Replace an old value with new value.
boolean	retainAll(java.util.Collection<?> c)
int	size()
java.lang.Object[]	toArray()
<E> E[]	toArray(E[] a)
<E,C> E[]	toArray(E[] a, com.gemstone.gemfire.internal.concurrent.MapCallback<?,T,C,?> callback, C context)
<E> void	toCollectionUnsafe(java.util.Collection<E> result) This variant of toArray is an unsafe one that takes no segment locks and can return somewhat arbitrary results.
com.gemstone.gnu.trove.THashSet	toSet() This is a variant of toArray to send back the result as a set.
java.lang.String	toString()
void	unlockAllSegmentsAfterRead()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT_CONCURRENCY

public static final int DEFAULT_CONCURRENCY

See Also:

Constant Field Values

segments

protected final com.gemstone.gemfire.internal.concurrent.ConcurrentTHashSegment<T>[] segments

numSegments

protected final int numSegments

Constructor Detail

ConcurrentTHashSet

public ConcurrentTHashSet()

ConcurrentTHashSet

public ConcurrentTHashSet(com.gemstone.gnu.trove.TObjectHashingStrategy strategy)

ConcurrentTHashSet

public ConcurrentTHashSet(int concurrency)

ConcurrentTHashSet

public ConcurrentTHashSet(int concurrency,
                          int initialCapacity)

ConcurrentTHashSet

public ConcurrentTHashSet(com.gemstone.gnu.trove.TObjectHashingStrategy strategy,
                          com.gemstone.gnu.trove.HashingStats stats)

ConcurrentTHashSet

public ConcurrentTHashSet(int concurrency,
                          int initialCapacity,
                          float loadFactor,
                          com.gemstone.gnu.trove.TObjectHashingStrategy strategy,
                          com.gemstone.gnu.trove.HashingStats stats)

Method Detail

longSize

public final long longSize()

size

public final int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.Set<T>

capacity

public final long capacity()

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.Set<T>

contains

public final boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Set<T>

get

public final T get(java.lang.Object o)

Get the value in the set lookup up against given object, or null if not present. This is different from contains(Object) in that depending on TObjectHashingStrategy the lookup object may not be identical to the object in set.

getUnsafe

public final T getUnsafe(java.lang.Object o)

Like get(Object) but skips acquiring any locks.No product code should use this except for monitoring or other such purposes which should not wait for locks and is not affected much by inaccurate results.

add

public final boolean add(T e)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

addKey

public final java.lang.Object addKey(T e)

Like add(Object) but returns the current key if already present in set (instead of false) else null (instead of true).

put

public final java.lang.Object put(T e)

Like addKey(Object) but replaces the current key if present.

create

public final <K,C,P> T create(K key,
                              com.gemstone.gemfire.internal.concurrent.MapCallback<K,T,C,P> valueCreator,
                              C context,
                              P createParams)

Like add(T) but creates the value only if none present rather than requiring a passed in pre-created object that may ultimately be thrown away.

Parameters:

key - key which is to be looked up in the set

valueCreator - factory object to create the value to be inserted into the set, if required

context - the context in which this method has been invoked and passed to valueCreator MapCallback.newValue(K, C, P, com.gemstone.gemfire.internal.concurrent.MapResult) method to create the new instance

createParams - parameters to be passed to the valueCreator MapCallback.newValue(K, C, P, com.gemstone.gemfire.internal.concurrent.MapResult) method to create the new instance

Returns:

the previous value present in the set for the specified key, or the new value obtained by invoking MapCallback.newValue(K, C, P, com.gemstone.gemfire.internal.concurrent.MapResult) if there was no mapping for the key, or null if MapCallback.newValue(K, C, P, com.gemstone.gemfire.internal.concurrent.MapResult) invoked ConcurrentTHashSegment.setNewValueCreated(boolean) to false from within its body

Throws:

java.lang.NullPointerException - if the specified key or value is null

remove

public final boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Set<T>

removeKey

public final T removeKey(java.lang.Object o)

Like remove(Object) but returns the current key if present in set and removed (instead of true) else null (instead of false).

replace

public final boolean replace(java.lang.Object o,
                             T e)

Replace an old value with new value.

Parameters:

o - the old value to be replaced

e - the new value to be inserted

Returns:

true if replace was successful, and false if old value was not found

containsAll

public final boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.Set<T>

addAll

public final boolean addAll(java.util.Collection<? extends T> c)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.Set<T>

retainAll

public final boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.Set<T>

removeAll

public final boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.Set<T>

bulkRemoveAll

public final boolean bulkRemoveAll(java.util.Collection<?> c)

Like removeAll(Collection) but optimized for large size of collection to minimize lock acquire/release and duration of locking. Usually you will want to use this when size of collection is greater than the concurreny level of the map.

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

iterator

public final ConcurrentTHashSet.Itr iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Set<T>

lockAllSegmentsForRead

public void lockAllSegmentsForRead()

unlockAllSegmentsAfterRead

public void unlockAllSegmentsAfterRead()

forEach

public final boolean forEach(com.gemstone.gnu.trove.TObjectProcedure proc)

Apply the given procedure for each element of the set. Do not invoke any operation on this set directly from inside the body of procedure itself else it will result in a deadlock.

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

toArray

public <E,C> E[] toArray(E[] a,
                         com.gemstone.gemfire.internal.concurrent.MapCallback<?,T,C,?> callback,
                         C context)

toArray

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

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

drainTo

public <E> E[] drainTo(E[] a)

copy the contents in array and clear the map as atomic operation

toSet

public com.gemstone.gnu.trove.THashSet toSet()

This is a variant of toArray to send back the result as a set.

toCollectionUnsafe

public <E> void toCollectionUnsafe(java.util.Collection<E> result)

This variant of toArray is an unsafe one that takes no segment locks and can return somewhat arbitrary results. No product code should use this except for monitoring or other such purposes which should not wait for locks and is not affected much by inaccurate results.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

estimateMemoryOverhead

public long estimateMemoryOverhead(SingleObjectSizer sizer)