com.devexperts.util

Class SynchronizedIndexedSet<K,V>

java.lang.Object

com.devexperts.util.AbstractConcurrentSet<V>

com.devexperts.util.IndexedSet<K,V>

com.devexperts.util.SynchronizedIndexedSet<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<V>, Collection<V>, Set<V>

public class SynchronizedIndexedSet<K,V>
extends IndexedSet<K,V>

A synchronized thread-safe version of IndexedSet class. It provides following benefits over standard IndexedSet:

• concurrent asynchronous read access
• synchronized thread-safe write access
• all iterators are concurrent

Note that SynchronizedIndexedSet can be wrapped by IndexedMap to create what can be considered a SynchronizedIndexedMap.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	SynchronizedIndexedSet() Creates new empty set with default indexer IndexerFunction.DEFAULT.
	SynchronizedIndexedSet(Collection<V> c) Creates a new set containing the elements in the specified collection.
	SynchronizedIndexedSet(Indexer<K,? super V> indexer) Deprecated. Use create(indexer)
	SynchronizedIndexedSet(Indexer<K,? super V> indexer, Collection<? extends V> c) Deprecated. Use create(indexer).withElements(c)
	SynchronizedIndexedSet(Indexer<K,? super V> indexer, int initialCapacity) Deprecated. Use create(indexer).withCapacity(initialCapacity)
protected	SynchronizedIndexedSet(IndexerFunction<K,? super V> indexer) Creates new empty set with specified indexer.
protected	SynchronizedIndexedSet(IndexerFunction<K,? super V> indexer, Collection<? extends V> c) Creates a new set with specified indexer containing the elements in the specified collection.
protected	SynchronizedIndexedSet(IndexerFunction<K,? super V> indexer, int initialCapacity) Creates new empty set with specified indexer and specified initial capacity.
	SynchronizedIndexedSet(int initialCapacity) Creates new empty set with default indexer IndexerFunction.DEFAULT and specified initial capacity.

Method Summary

Modifier and Type	Method and Description
boolean	addAll(Collection<? extends V> c) Adds all of the elements in the specified collection into this set and returns true if this operation has increased the size of this set.
void	clear() Removes all elements from this set.
SynchronizedIndexedSet<K,V>	clone() Returns a shallow copy of this set - the values themselves are not cloned.
static <V> Collector<V,?,? extends SynchronizedIndexedSet<V,V>>	collector() Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with default indexer.
static <V> Collector<V,?,? extends SynchronizedIndexedSet<Integer,V>>	collector(IndexerFunction.IntKey<? super V> indexer) Deprecated. Use collectorInt(indexer)
static <V> Collector<V,?,? extends SynchronizedIndexedSet<Long,V>>	collector(IndexerFunction.LongKey<? super V> indexer) Deprecated. Use collectorLong(indexer)
static <K,V> Collector<V,?,? extends SynchronizedIndexedSet<K,V>>	collector(IndexerFunction<K,? super V> indexer) Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified indexer.
static <V> Collector<V,?,? extends SynchronizedIndexedSet<V,V>>	collectorIdentity() Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with default identity indexer.
static <K,V> Collector<V,?,? extends SynchronizedIndexedSet<K,V>>	collectorIdentity(IndexerFunction.IdentityKey<K,? super V> indexer) Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified identity indexer.
static <V> Collector<V,?,? extends SynchronizedIndexedSet<Integer,V>>	collectorInt(IndexerFunction.IntKey<? super V> indexer) Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified int indexer.
static <V> Collector<V,?,? extends SynchronizedIndexedSet<Long,V>>	collectorLong(IndexerFunction.LongKey<? super V> indexer) Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified long indexer.
static <V> SynchronizedIndexedSet<V,V>	create() Creates new empty set with default indexer IndexerFunction.DEFAULT.
static <V> SynchronizedIndexedSet<Integer,V>	create(IndexerFunction.IntKey<? super V> indexer) Deprecated. Use createInt(indexer)
static <V> SynchronizedIndexedSet<Integer,V>	create(IndexerFunction.IntKey<? super V> indexer, Collection<? extends V> c) Deprecated. Use createInt(indexer).withElements(c)
static <V> SynchronizedIndexedSet<Integer,V>	create(IndexerFunction.IntKey<? super V> indexer, int initialCapacity) Deprecated. Use createInt(indexer).withCapacity(initialCapacity)
static <V> SynchronizedIndexedSet<Long,V>	create(IndexerFunction.LongKey<? super V> indexer) Deprecated. Use createLong(indexer)
static <V> SynchronizedIndexedSet<Long,V>	create(IndexerFunction.LongKey<? super V> indexer, int initialCapacity) Deprecated. Use createLong(indexer).withCapacity(initialCapacity)
static <K,V> SynchronizedIndexedSet<K,V>	create(IndexerFunction<K,? super V> indexer) Creates new empty set with specified indexer.
static <K,V> SynchronizedIndexedSet<K,V>	create(IndexerFunction<K,? super V> indexer, Collection<? extends V> c) Deprecated. Use create(indexer).withElements(c)
static <K,V> SynchronizedIndexedSet<K,V>	create(IndexerFunction<K,? super V> indexer, int initialCapacity) Deprecated. Use create(indexer).withCapacity(initialCapacity)
static <V> SynchronizedIndexedSet<V,V>	createIdentity() Creates new empty set with default identity indexer.
static <K,V> SynchronizedIndexedSet<K,V>	createIdentity(IndexerFunction.IdentityKey<K,? super V> indexer) Creates new empty set with specified identity indexer.
static <V> SynchronizedIndexedSet<Integer,V>	createInt(IndexerFunction.IntKey<? super V> indexer) Creates new empty set with specified int indexer.
static <V> SynchronizedIndexedSet<Long,V>	createLong(IndexerFunction.LongKey<? super V> indexer) Creates new empty set with specified long indexer.
void	ensureCapacity(int capacity) Increases the capacity of this set instance, if necessary, to ensure that it can hold at least the number of elements specified by the capacity argument.
IndexedSetStats	getStats() Returns static structure statistics of this set.
static <V> SynchronizedIndexedSet<V,V>	of(V... objs) Creates a new set with default indexer containing specified elements.
V	put(V value) Puts specified element into this set and returns previous element that matches specified one.
V	putIfAbsentAndGet(V value) Puts specified element into this set if it is absent and returns current element in the set that matches specified one.
boolean	removeAll(Collection<?> c) Removes all of the elements in the specified collection from this set and returns true if this operation has decreased the size of this set.
boolean	removeIf(Predicate<? super V> filter)
V	removeKey(K key) Removes the element from this set which matches specified key if it is present and returns removed element or null if none were found.
V	removeKey(long key) Removes the element from this set which matches specified key if it is present and returns removed element or null if none were found.
V	removeValue(V value) Removes the element from this set which matches specified value if it is present and returns removed element or null if none were found.
boolean	retainAll(Collection<?> c) Retains only the elements in this set that are contained in the specified collection.
void	trimToSize() Trims the capacity of this set instance to be the set's current size.
SynchronizedIndexedSet<K,V>	withCapacity(int capacity) Increases the capacity of this set instance, if necessary, to ensure that it can hold at least the number of elements specified by the capacity argument.
SynchronizedIndexedSet<K,V>	withElements(Collection<? extends V> c) Adds all of the elements in the specified collection into this set.

Methods inherited from class com.devexperts.util.IndexedSet

add, concurrentIterator, contains, containsKey, containsKey, containsKey, containsValue, create, entryIterator, getByKey, getByKey, getByKey, getByValue, getIndexer, getIndexerFunction, iterator, keyIterator, remove, removeKey, size, toArray, toArray

Methods inherited from class com.devexperts.util.AbstractConcurrentSet

containsAll, equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SynchronizedIndexedSet

public SynchronizedIndexedSet()

Creates new empty set with default indexer IndexerFunction.DEFAULT.

SynchronizedIndexedSet

public SynchronizedIndexedSet(int initialCapacity)

Creates new empty set with default indexer IndexerFunction.DEFAULT and specified initial capacity.

SynchronizedIndexedSet

protected SynchronizedIndexedSet(IndexerFunction<K,? super V> indexer)

Creates new empty set with specified indexer.

SynchronizedIndexedSet

@Deprecated
public SynchronizedIndexedSet(Indexer<K,? super V> indexer)

Deprecated. Use create(indexer)

Creates new empty set with specified indexer.

SynchronizedIndexedSet

protected SynchronizedIndexedSet(IndexerFunction<K,? super V> indexer,
                                 int initialCapacity)

Creates new empty set with specified indexer and specified initial capacity.

SynchronizedIndexedSet

@Deprecated
public SynchronizedIndexedSet(Indexer<K,? super V> indexer,
                                          int initialCapacity)

Deprecated. Use create(indexer).withCapacity(initialCapacity)

Creates new empty set with specified indexer and specified initial capacity.

SynchronizedIndexedSet

public SynchronizedIndexedSet(Collection<V> c)

Creates a new set containing the elements in the specified collection. If specified collection is an IndexedSet, then new indexed set uses same indexer, otherwise it uses default indexer IndexerFunction.DEFAULT.

SynchronizedIndexedSet

protected SynchronizedIndexedSet(IndexerFunction<K,? super V> indexer,
                                 Collection<? extends V> c)

Creates a new set with specified indexer containing the elements in the specified collection.

SynchronizedIndexedSet

@Deprecated
public SynchronizedIndexedSet(Indexer<K,? super V> indexer,
                                          Collection<? extends V> c)

Deprecated. Use create(indexer).withElements(c)

Creates a new set with specified indexer containing the elements in the specified collection.

Method Detail

create

public static <V> SynchronizedIndexedSet<V,V> create()

Creates new empty set with default indexer IndexerFunction.DEFAULT.

createIdentity

public static <V> SynchronizedIndexedSet<V,V> createIdentity()

Creates new empty set with default identity indexer.

create

public static <K,V> SynchronizedIndexedSet<K,V> create(IndexerFunction<K,? super V> indexer)

Creates new empty set with specified indexer.

createIdentity

public static <K,V> SynchronizedIndexedSet<K,V> createIdentity(IndexerFunction.IdentityKey<K,? super V> indexer)

Creates new empty set with specified identity indexer.

createInt

public static <V> SynchronizedIndexedSet<Integer,V> createInt(IndexerFunction.IntKey<? super V> indexer)

Creates new empty set with specified int indexer.

createLong

public static <V> SynchronizedIndexedSet<Long,V> createLong(IndexerFunction.LongKey<? super V> indexer)

Creates new empty set with specified long indexer.

create

@Deprecated
public static <V> SynchronizedIndexedSet<Integer,V> create(IndexerFunction.IntKey<? super V> indexer)

Deprecated. Use createInt(indexer)

Creates new empty set with specified indexer.

create

@Deprecated
public static <V> SynchronizedIndexedSet<Long,V> create(IndexerFunction.LongKey<? super V> indexer)

Deprecated. Use createLong(indexer)

Creates new empty set with specified indexer.

create

@Deprecated
public static <K,V> SynchronizedIndexedSet<K,V> create(IndexerFunction<K,? super V> indexer,
                                                                   int initialCapacity)

Deprecated. Use create(indexer).withCapacity(initialCapacity)

Creates new empty set with specified indexer and specified initial capacity.

create

@Deprecated
public static <V> SynchronizedIndexedSet<Integer,V> create(IndexerFunction.IntKey<? super V> indexer,
                                                                       int initialCapacity)

Deprecated. Use createInt(indexer).withCapacity(initialCapacity)

Creates new empty set with specified indexer and specified initial capacity.

create

@Deprecated
public static <V> SynchronizedIndexedSet<Long,V> create(IndexerFunction.LongKey<? super V> indexer,
                                                                    int initialCapacity)

Deprecated. Use createLong(indexer).withCapacity(initialCapacity)

Creates new empty set with specified indexer and specified initial capacity.

create

@Deprecated
public static <K,V> SynchronizedIndexedSet<K,V> create(IndexerFunction<K,? super V> indexer,
                                                                   Collection<? extends V> c)

Deprecated. Use create(indexer).withElements(c)

Creates a new set with specified indexer containing the elements in the specified collection.

create

@Deprecated
public static <V> SynchronizedIndexedSet<Integer,V> create(IndexerFunction.IntKey<? super V> indexer,
                                                                       Collection<? extends V> c)

Deprecated. Use createInt(indexer).withElements(c)

Creates a new set with specified indexer containing the elements in the specified collection.

of

@SafeVarargs
public static <V> SynchronizedIndexedSet<V,V> of(V... objs)

Creates a new set with default indexer containing specified elements.

collector

public static <V> Collector<V,?,? extends SynchronizedIndexedSet<V,V>> collector()

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with default indexer. This is an concurrent and unordered Collector.

collectorIdentity

public static <V> Collector<V,?,? extends SynchronizedIndexedSet<V,V>> collectorIdentity()

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with default identity indexer. This is an concurrent and unordered Collector.

collector

public static <K,V> Collector<V,?,? extends SynchronizedIndexedSet<K,V>> collector(IndexerFunction<K,? super V> indexer)

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified indexer. This is an concurrent and unordered Collector.

collectorIdentity

public static <K,V> Collector<V,?,? extends SynchronizedIndexedSet<K,V>> collectorIdentity(IndexerFunction.IdentityKey<K,? super V> indexer)

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified identity indexer. This is an concurrent and unordered Collector.

collectorInt

public static <V> Collector<V,?,? extends SynchronizedIndexedSet<Integer,V>> collectorInt(IndexerFunction.IntKey<? super V> indexer)

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified int indexer. This is an concurrent and unordered Collector.

collectorLong

public static <V> Collector<V,?,? extends SynchronizedIndexedSet<Long,V>> collectorLong(IndexerFunction.LongKey<? super V> indexer)

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified long indexer. This is an concurrent and unordered Collector.

collector

@Deprecated
public static <V> Collector<V,?,? extends SynchronizedIndexedSet<Integer,V>> collector(IndexerFunction.IntKey<? super V> indexer)

Deprecated. Use collectorInt(indexer)

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified indexer. This is an concurrent and unordered Collector.

collector

@Deprecated
public static <V> Collector<V,?,? extends SynchronizedIndexedSet<Long,V>> collector(IndexerFunction.LongKey<? super V> indexer)

Deprecated. Use collectorLong(indexer)

Returns a Collector that accumulates the input elements into a new SynchronizedIndexedSet with specified indexer. This is an concurrent and unordered Collector.

clone

public SynchronizedIndexedSet<K,V> clone()

Returns a shallow copy of this set - the values themselves are not cloned.

Overrides:

clone in class IndexedSet<K,V>

withCapacity

public SynchronizedIndexedSet<K,V> withCapacity(int capacity)

Increases the capacity of this set instance, if necessary, to ensure that it can hold at least the number of elements specified by the capacity argument.

Returns this set instance for convenience.

Overrides:

withCapacity in class IndexedSet<K,V>

withElements

public SynchronizedIndexedSet<K,V> withElements(Collection<? extends V> c)

Adds all of the elements in the specified collection into this set.

Returns this set instance for convenience.

Overrides:

withElements in class IndexedSet<K,V>

ensureCapacity

public void ensureCapacity(int capacity)

Increases the capacity of this set instance, if necessary, to ensure that it can hold at least the number of elements specified by the capacity argument.

Overrides:

ensureCapacity in class IndexedSet<K,V>

trimToSize

public void trimToSize()

Trims the capacity of this set instance to be the set's current size. An application can use this operation to minimize the storage of this set instance.

Overrides:

trimToSize in class IndexedSet<K,V>

clear

public void clear()

Removes all elements from this set.

Specified by:

clear in interface Collection<V>

Specified by:

clear in interface Set<V>

Overrides:

clear in class IndexedSet<K,V>

getStats

public IndexedSetStats getStats()

Returns static structure statistics of this set.

Overrides:

getStats in class IndexedSet<K,V>

put

public V put(V value)

Puts specified element into this set and returns previous element that matches specified one.

Overrides:

put in class IndexedSet<K,V>

putIfAbsentAndGet

public V putIfAbsentAndGet(V value)

Puts specified element into this set if it is absent and returns current element in the set that matches specified one. This is equivalent to

   if (set.containsValue(value)) {
     return set.getByValue(value);
   } else {
     set.put(value);
     return value;
   }
 

except that the action is performed atomically if it is properly synchronized.

Note, that unlike ConcurrentMap.putIfAbsent(K, V), this method returns specified value (not null) if the value was absent.

Overrides:

putIfAbsentAndGet in class IndexedSet<K,V>

removeValue

public V removeValue(V value)

Removes the element from this set which matches specified value if it is present and returns removed element or null if none were found.

Overrides:

removeValue in class IndexedSet<K,V>

removeKey

public V removeKey(K key)

Removes the element from this set which matches specified key if it is present and returns removed element or null if none were found.

Overrides:

removeKey in class IndexedSet<K,V>

removeKey

public V removeKey(long key)

Removes the element from this set which matches specified key if it is present and returns removed element or null if none were found.

Overrides:

removeKey in class IndexedSet<K,V>

removeIf

public boolean removeIf(Predicate<? super V> filter)

addAll

public boolean addAll(Collection<? extends V> c)

Description copied from class: AbstractConcurrentSet

Adds all of the elements in the specified collection into this set and returns true if this operation has increased the size of this set.

This implementation iterates all elements of specified collection and adds them one-by-one using add(element) method.

Specified by:

addAll in interface Collection<V>

Specified by:

addAll in interface Set<V>

Overrides:

addAll in class AbstractConcurrentSet<V>

removeAll

public boolean removeAll(Collection<?> c)

Description copied from class: IndexedSet

Removes all of the elements in the specified collection from this set and returns true if this operation has decreased the size of this set.

Elements compared using the set's IndexerFunction.

Specified by:

removeAll in interface Collection<V>

Specified by:

removeAll in interface Set<V>

Overrides:

removeAll in class IndexedSet<K,V>

Parameters:

c - collection containing elements to be removed from this set

Returns:

true if this set changed as a result of the call

retainAll

public boolean retainAll(Collection<?> c)

Description copied from class: IndexedSet

Retains only the elements in this set that are contained in the specified collection.

Elements compared using the set's IndexerFunction.

NOTE: if provided collection is not an IndexedSet with the same IndexerFunction this implementation will create a temporary IndexedSet with provided elements.

Specified by:

retainAll in interface Collection<V>

Specified by:

retainAll in interface Set<V>

Overrides:

retainAll in class IndexedSet<K,V>

Parameters:

c - collection containing elements to be retained in this set

Returns:

true if this set changed as a result of the call