Package org.eclipse.collections.impl.collection.mutable

Class SynchronizedMutableCollection<T>

java.lang.Object

org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable<T>

org.eclipse.collections.impl.collection.mutable.AbstractSynchronizedMutableCollection<T>

org.eclipse.collections.impl.collection.mutable.SynchronizedMutableCollection<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>

public class SynchronizedMutableCollection<T>
extends AbstractSynchronizedMutableCollection<T>
implements java.io.Serializable

A synchronized view of a MutableCollection. It is imperative that the user manually synchronize on the collection when iterating over it using the standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).

See Also:

MutableCollection.asSynchronized(), Serialized Form

Method Summary

Modifier and Type	Method	Description
MutableCollection<T>	asSynchronized()	Returns a synchronized wrapper backed by this collection.
MutableCollection<T>	asUnmodifiable()	Returns an unmodifiable view of this collection.
MutableCollection<T>	newEmpty()	Creates a new empty mutable version of the same collection type.
static <E,C extends java.util.Collection<E>> SynchronizedMutableCollection<E>	of(C collection)	This method will take a MutableCollection and wrap it directly in a SynchronizedMutableCollection.
static <E,C extends java.util.Collection<E>> SynchronizedMutableCollection<E>	of(C collection, java.lang.Object lock)	This method will take a MutableCollection and wrap it directly in a SynchronizedMutableCollection.
ImmutableCollection<T>	toImmutable()	Converts this MutableCollection to an ImmutableCollection.
MutableCollection<T>	with(T element)	This method allows mutable and fixed size collections the ability to add elements to their existing elements.
MutableCollection<T>	withAll(java.lang.Iterable<? extends T> elements)	This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
MutableCollection<T>	without(T element)	This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
MutableCollection<T>	withoutAll(java.lang.Iterable<? extends T> elements)	This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.

Methods inherited from class org.eclipse.collections.impl.collection.mutable.AbstractSynchronizedMutableCollection

add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, countBy, countByWith, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectIntoWith, partition, partitionWith, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectInstancesOf, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, tap, zip, zipWithIndex

Methods inherited from class org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, equals, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, hashCode, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeIf, size, spliterator, stream, toArray, toArray

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach, forEach, forEachWith, forEachWithIndex

Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection

flatCollectWith

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.RichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectWith, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Method Detail

of

public static <E,C extends java.util.Collection<E>> SynchronizedMutableCollection<E> of(C collection)

This method will take a MutableCollection and wrap it directly in a SynchronizedMutableCollection. It will take any other non-GS-collection and first adapt it will a CollectionAdapter, and then return a SynchronizedMutableCollection that wraps the adapter.

of

public static <E,C extends java.util.Collection<E>> SynchronizedMutableCollection<E> of(C collection,
                                                                                        java.lang.Object lock)

This method will take a MutableCollection and wrap it directly in a SynchronizedMutableCollection. It will take any other non-GS-collection and first adapt it will a CollectionAdapter, and then return a SynchronizedMutableCollection that wraps the adapter. Additionally, a developer specifies which lock to use with the collection.

with

public MutableCollection<T> with(T element)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.with("1");
 list = list.with("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.

Specified by:

with in interface MutableCollection<T>

See Also:

Collection.add(Object)

without

public MutableCollection<T> without(T element)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.without("1");
 list = list.without("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.

Specified by:

without in interface MutableCollection<T>

See Also:

Collection.remove(Object)

withAll

public MutableCollection<T> withAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.

Specified by:

withAll in interface MutableCollection<T>

See Also:

Collection.addAll(Collection)

withoutAll

public MutableCollection<T> withoutAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: MutableCollection

This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.

Specified by:

withoutAll in interface MutableCollection<T>

See Also:

Collection.removeAll(Collection)

asUnmodifiable

public MutableCollection<T> asUnmodifiable()

Description copied from interface: MutableCollection

Returns an unmodifiable view of this collection. This is the equivalent of using Collections.unmodifiableCollection(this) with a return type that supports the full iteration protocols available on MutableCollection. Methods which would mutate the underlying collection will throw UnsupportedOperationExceptions.

Specified by:

asUnmodifiable in interface MutableCollection<T>

Returns:

an unmodifiable view of this collection.

See Also:

Collections.unmodifiableCollection(Collection)

asSynchronized

public MutableCollection<T> asSynchronized()

Description copied from interface: MutableCollection

Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.

  MutableCollection synchedCollection = collection.asSynchronized();
     ...
  synchedCollection.forEach(each -> ... );
  synchedCollection.select(each -> ... );
  synchedCollection.collect(each -> ... );
 

If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

Specified by:

asSynchronized in interface MutableCollection<T>

Returns:

a synchronized view of this collection.

See Also:

Collections.synchronizedCollection(Collection)

toImmutable

public ImmutableCollection<T> toImmutable()

Description copied from interface: MutableCollection

Converts this MutableCollection to an ImmutableCollection.

Specified by:

toImmutable in interface MutableCollection<T>

newEmpty

public MutableCollection<T> newEmpty()

Description copied from interface: MutableCollection

Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.

Specified by:

newEmpty in interface MutableCollection<T>