Class MultiReaderUnifiedSet<T>

java.lang.Object

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

org.eclipse.collections.impl.set.mutable.MultiReaderUnifiedSet<T>

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<T>, Collection<T>, RandomAccess, Set<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>, MultiReaderSet<T>, MutableSet<T>, MutableSetIterable<T>, SetIterable<T>, UnsortedSetIterable<T>

public final class MultiReaderUnifiedSet<T>
extends AbstractMultiReaderMutableCollection<T>
implements RandomAccess, Externalizable, MultiReaderSet<T>

MultiReadUnifiedSet provides a thread-safe wrapper around a UnifiedSet, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderUnifiedSet does not implement iterator() as this method requires an external lock to be taken to provide thread-safe iteration. You can use an iterator() if you use the withReadLockAndDelegate() or withWriteLockAndDelegate() methods. Both of these methods take a parameter of type Procedure<MutableSet>, and a wrapped version of the underlying Unified is returned. This wrapper guarantees that no external pointer can ever reference the underlying UnifiedSet outside a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	MultiReaderUnifiedSet.UntouchableIterator<T>
(package private) static final class	MultiReaderUnifiedSet.UntouchableMutableSet<T>

Nested classes/interfaces inherited from class AbstractMultiReaderMutableCollection

AbstractMultiReaderMutableCollection.LockWrapper, AbstractMultiReaderMutableCollection.ReadWriteLockWrapper, AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>

Field Summary

Fields

Modifier and Type	Field	Description
private MutableSet<T>	delegate
private static final long	serialVersionUID

Fields inherited from class AbstractMultiReaderMutableCollection

lock, lockWrapper

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiReaderUnifiedSet()	Deprecated. Empty default constructor used for serialization.
private	MultiReaderUnifiedSet(MutableSet<T> newDelegate)
private	MultiReaderUnifiedSet(MutableSet<T> newDelegate, ReadWriteLock newLock)

Method Summary

Modifier and Type	Method	Description
ParallelUnsortedSetIterable<T>	asParallel(ExecutorService executorService, int batchSize)	Returns a parallel iterable of this SetIterable.
(package private) MultiReaderUnifiedSet.UntouchableMutableSet<T>	asReadUntouchable()
MutableSet<T>	asSynchronized()	Returns a synchronized wrapper backed by this collection.
MutableSet<T>	asUnmodifiable()	Returns an unmodifiable view of this collection.
(package private) MultiReaderUnifiedSet.UntouchableMutableSet<T>	asWriteUntouchable()
<B> LazyIterable<Pair<T,B>>	cartesianProduct(SetIterable<B> set)	Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
RichIterable<RichIterable<T>>	chunk(int size)	Partitions elements in fixed size chunks.
MultiReaderSet<T>	clone()
<V> MutableSet<V>	collect(Function<? super T, ? extends V> function)	Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.
MutableBooleanSet	collectBoolean(BooleanFunction<? super T> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
MutableByteSet	collectByte(ByteFunction<? super T> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
MutableCharSet	collectChar(CharFunction<? super T> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
MutableDoubleSet	collectDouble(DoubleFunction<? super T> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
MutableFloatSet	collectFloat(FloatFunction<? super T> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> MutableSet<V>	collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> function)	Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.
MutableIntSet	collectInt(IntFunction<? super T> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
MutableLongSet	collectLong(LongFunction<? super T> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
MutableShortSet	collectShort(ShortFunction<? super T> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P,V> MutableSet<V>	collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
MutableSet<T>	difference(SetIterable<? extends T> subtrahendSet)	Returns the set of all members of this that are not members of subtrahendSet.
<R extends Set<T>> R	differenceInto(SetIterable<? extends T> subtrahendSet, R targetSet)	Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.
boolean	equals(Object o)	Follows the same general contract as Set.equals(Object).
<V> MutableSet<V>	flatCollect(Function<? super T, ? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
protected MutableSet<T>	getDelegate()
<V> MutableSetMultimap<V,T>	groupBy(Function<? super T, ? extends V> function)	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V> MutableSetMultimap<V,T>	groupByEach(Function<? super T, ? extends Iterable<V>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V> MutableMap<V,T>	groupByUniqueKey(Function<? super T, ? extends V> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode()	Follows the same general contract as Set.hashCode().
MutableSet<T>	intersect(SetIterable<? extends T> set)	Returns the set of all objects that are members of both this and set.
<R extends Set<T>> R	intersectInto(SetIterable<? extends T> set, R targetSet)	Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.
boolean	isProperSubsetOf(SetIterable<? extends T> candidateSuperset)	Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal.
boolean	isSubsetOf(SetIterable<? extends T> candidateSuperset)	Returns true if all the members of this are also members of candidateSuperset.
MultiReaderSet<T>	newEmpty()	Creates a new empty mutable version of the same collection type.
static <T> MultiReaderUnifiedSet<T>	newSet()
static <T> MultiReaderUnifiedSet<T>	newSet(int capacity)
static <T> MultiReaderUnifiedSet<T>	newSet(Iterable<T> iterable)
static <T> MultiReaderUnifiedSet<T>	newSetWith(T... elements)
PartitionMutableSet<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionMutableSet<T>	partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
MutableSet<UnsortedSetIterable<T>>	powerSet()	Returns the set whose members are all possible subsets of this.
void	readExternal(ObjectInput in)
MutableSet<T>	reject(Predicate<? super T> predicate)	Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
<P> MutableSet<T>	rejectWith(Predicate2<? super T, ? super P> predicate, P parameter)	Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
MutableSet<T>	select(Predicate<? super T> predicate)	Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
<S> MutableSet<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> MutableSet<T>	selectWith(Predicate2<? super T, ? super P> predicate, P parameter)	Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
MutableSet<T>	symmetricDifference(SetIterable<? extends T> setB)	Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both).
<R extends Set<T>> R	symmetricDifferenceInto(SetIterable<? extends T> set, R targetSet)	Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
MultiReaderSet<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
ImmutableSet<T>	toImmutable()	Converts this MutableCollection to an ImmutableCollection.
MutableSet<T>	union(SetIterable<? extends T> set)	Returns the set of all objects that are a member of this or set or both.
<R extends Set<T>> R	unionInto(SetIterable<? extends T> set, R targetSet)	Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.
void	withReadLockAndDelegate(Procedure<? super MutableSet<T>> procedure)
void	withWriteLockAndDelegate(Procedure<? super MutableSet<T>> procedure)
void	writeExternal(ObjectOutput out)
<S> MutableSet<Pair<T,S>>	zip(Iterable<S> that)	Deprecated. in 6.0.
MutableSet<Pair<T,Integer>>	zipWithIndex()	Deprecated. in 6.0.

Methods inherited from class AbstractMultiReaderMutableCollection

add, addAll, addAllIterable, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, parallelStream, reduceBy, reduceBy, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableList, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface MultiReaderSet

with, withAll, without, withoutAll

Methods inherited from interface MutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, flatCollectWith, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface MutableSet

flatCollectWith, toImmutableSet

Methods inherited from interface MutableSetIterable

toArray, toArray

Methods inherited from interface RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface Set

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

delegate

private MutableSet<T> delegate

Constructor Details

MultiReaderUnifiedSet

@Deprecated
public MultiReaderUnifiedSet()

Deprecated.

Empty default constructor used for serialization.

MultiReaderUnifiedSet

private MultiReaderUnifiedSet(MutableSet<T> newDelegate)

MultiReaderUnifiedSet

private MultiReaderUnifiedSet(MutableSet<T> newDelegate,
 ReadWriteLock newLock)

Method Details

newSet

public static <T> MultiReaderUnifiedSet<T> newSet()

newSet

public static <T> MultiReaderUnifiedSet<T> newSet(int capacity)

newSet

public static <T> MultiReaderUnifiedSet<T> newSet(Iterable<T> iterable)

newSetWith

public static <T> MultiReaderUnifiedSet<T> newSetWith(T... elements)

getDelegate

protected MutableSet<T> getDelegate()

Specified by:

getDelegate in class AbstractMultiReaderMutableCollection<T>

asReadUntouchable

MultiReaderUnifiedSet.UntouchableMutableSet<T> asReadUntouchable()

asWriteUntouchable

MultiReaderUnifiedSet.UntouchableMutableSet<T> asWriteUntouchable()

withReadLockAndDelegate

public void withReadLockAndDelegate(Procedure<? super MutableSet<T>> procedure)

Specified by:

withReadLockAndDelegate in interface MultiReaderSet<T>

withWriteLockAndDelegate

public void withWriteLockAndDelegate(Procedure<? super MutableSet<T>> procedure)

Specified by:

withWriteLockAndDelegate in interface MultiReaderSet<T>

asSynchronized

public MutableSet<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>

Specified by:

asSynchronized in interface MutableSet<T>

Returns:

a synchronized view of this collection.

See Also:

• Collections.synchronizedCollection(Collection)

toImmutable

public ImmutableSet<T> toImmutable()

Description copied from interface: MutableCollection

Converts this MutableCollection to an ImmutableCollection.

Specified by:

toImmutable in interface MutableCollection<T>

Specified by:

toImmutable in interface MutableSet<T>

Specified by:

toImmutable in interface SetIterable<T>

Specified by:

toImmutable in interface UnsortedSetIterable<T>

asUnmodifiable

public MutableSet<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>

Specified by:

asUnmodifiable in interface MutableSet<T>

Returns:

an unmodifiable view of this collection.

See Also:

• Collections.unmodifiableCollection(Collection)

clone

public MultiReaderSet<T> clone()

Specified by:

clone in interface MultiReaderSet<T>

Specified by:

clone in interface MutableSet<T>

Overrides:

clone in class Object

collect

public <V> MutableSet<V> collect(Function<? super T, ? extends V> function)

Description copied from interface: MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.

MutableCollection<String> names =
    people.collect(person -> person.getFirstName() + " " + person.getLastName());

Specified by:

collect in interface MutableCollection<T>

Specified by:

collect in interface MutableSet<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface UnsortedSetIterable<T>

collectBoolean

public MutableBooleanSet collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: MutableCollection

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

BooleanIterable licenses =
    people.collectBoolean(person -> person.hasDrivingLicense());

Co-variant example for MutableCollection:

MutableBooleanCollection licenses =
    people.collectBoolean(person -> person.hasDrivingLicense());

Specified by:

collectBoolean in interface MutableCollection<T>

Specified by:

collectBoolean in interface MutableSet<T>

Specified by:

collectBoolean in interface RichIterable<T>

Specified by:

collectBoolean in interface UnsortedSetIterable<T>

collectByte

public MutableByteSet collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: MutableCollection

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

ByteIterable bytes =
    people.collectByte(person -> person.getCode());

Co-variant example for MutableCollection:

MutableByteCollection bytes =
    people.collectByte(person -> person.getCode());

Specified by:

collectByte in interface MutableCollection<T>

Specified by:

collectByte in interface MutableSet<T>

Specified by:

collectByte in interface RichIterable<T>

Specified by:

collectByte in interface UnsortedSetIterable<T>

collectChar

public MutableCharSet collectChar(CharFunction<? super T> charFunction)

Description copied from interface: MutableCollection

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

CharIterable chars =
    people.collectChar(person -> person.getMiddleInitial());

Co-variant example for MutableCollection:

MutableCharCollection chars =
    people.collectChar(person -> person.getMiddleInitial());

Specified by:

collectChar in interface MutableCollection<T>

Specified by:

collectChar in interface MutableSet<T>

Specified by:

collectChar in interface RichIterable<T>

Specified by:

collectChar in interface UnsortedSetIterable<T>

collectDouble

public MutableDoubleSet collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: MutableCollection

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

DoubleIterable doubles =
    people.collectDouble(person -> person.getMilesFromNorthPole());

Co-variant example for MutableCollection:

MutableDoubleCollection doubles =
    people.collectDouble(person -> person.getMilesFromNorthPole());

Specified by:

collectDouble in interface MutableCollection<T>

Specified by:

collectDouble in interface MutableSet<T>

Specified by:

collectDouble in interface RichIterable<T>

Specified by:

collectDouble in interface UnsortedSetIterable<T>

collectFloat

public MutableFloatSet collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: MutableCollection

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

FloatIterable floats =
    people.collectFloat(person -> person.getHeightInInches());

Co-variant example for MutableCollection:

MutableFloatCollection floats =
    people.collectFloat(person -> person.getHeightInInches());

Specified by:

collectFloat in interface MutableCollection<T>

Specified by:

collectFloat in interface MutableSet<T>

Specified by:

collectFloat in interface RichIterable<T>

Specified by:

collectFloat in interface UnsortedSetIterable<T>

collectInt

public MutableIntSet collectInt(IntFunction<? super T> intFunction)

Description copied from interface: MutableCollection

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

IntIterable ints =
    people.collectInt(person -> person.getAge());

Co-variant example for MutableCollection:

MutableIntCollection ints =
    people.collectInt(person -> person.getAge());

Specified by:

collectInt in interface MutableCollection<T>

Specified by:

collectInt in interface MutableSet<T>

Specified by:

collectInt in interface RichIterable<T>

Specified by:

collectInt in interface UnsortedSetIterable<T>

collectLong

public MutableLongSet collectLong(LongFunction<? super T> longFunction)

Description copied from interface: MutableCollection

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

LongIterable longs =
    people.collectLong(person -> person.getGuid());

Co-variant example for MutableCollection:

MutableLongCollection longs =
    people.collectLong(person -> person.getGuid());

Specified by:

collectLong in interface MutableCollection<T>

Specified by:

collectLong in interface MutableSet<T>

Specified by:

collectLong in interface RichIterable<T>

Specified by:

collectLong in interface UnsortedSetIterable<T>

collectShort

public MutableShortSet collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: MutableCollection

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

ShortIterable shorts =
    people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

Co-variant example for MutableCollection:

MutableShortCollection shorts =
    people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

Specified by:

collectShort in interface MutableCollection<T>

Specified by:

collectShort in interface MutableSet<T>

Specified by:

collectShort in interface RichIterable<T>

Specified by:

collectShort in interface UnsortedSetIterable<T>

flatCollect

public <V> MutableSet<V> flatCollect(Function<? super T, ? extends Iterable<V>> function)

Description copied from interface: MutableCollection

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

Function<Person, List<Address>> addressFunction = Person::getAddresses;
RichIterable<Person> people = ...;

Using collect returns a collection of collections of addresses.

RichIterable<List<Address>> addresses = people.collect(addressFunction);

Using flatCollect returns a single flattened list of addresses.

RichIterable<Address> addresses = people.flatCollect(addressFunction);

Co-variant example for MutableCollection:

Function<Person, List<Address>> addressFunction = Person::getAddresses;
MutableCollection<Person> people = ...;
MutableCollection<List<Address>> addresses = people.collect(addressFunction);
MutableCollection<Address> addresses = people.flatCollect(addressFunction);

Specified by:

flatCollect in interface MutableCollection<T>

Specified by:

flatCollect in interface MutableSet<T>

Specified by:

flatCollect in interface RichIterable<T>

Specified by:

flatCollect in interface UnsortedSetIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectIf

public <V> MutableSet<V> collectIf(Predicate<? super T> predicate,
 Function<? super T, ? extends V> function)

Description copied from interface: MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.

MutableCollection<String> collected =
    Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())

Specified by:

collectIf in interface MutableCollection<T>

Specified by:

collectIf in interface MutableSet<T>

Specified by:

collectIf in interface RichIterable<T>

Specified by:

collectIf in interface UnsortedSetIterable<T>

collectWith

public <P,V> MutableSet<V> collectWith(Function2<? super T, ? super P, ? extends V> function,
 P parameter)

Description copied from interface: MutableCollection

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

RichIterable<Integer> integers =
    Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));

Co-variant example for MutableCollection:

MutableCollection<Integer> integers =
    Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));

Specified by:

collectWith in interface MutableCollection<T>

Specified by:

collectWith in interface MutableSet<T>

Specified by:

collectWith in interface RichIterable<T>

Specified by:

collectWith in interface UnsortedSetIterable<T>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

• RichIterable.collect(Function)

newEmpty

public MultiReaderSet<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 MultiReaderSet<T>

Specified by:

newEmpty in interface MutableCollection<T>

Specified by:

newEmpty in interface MutableSet<T>

reject

public MutableSet<T> reject(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate.

MutableCollection<Person> notSmiths =
    people.reject(person -> person.person.getLastName().equals("Smith"));

Using the Predicates factory:

MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));

Specified by:

reject in interface MutableCollection<T>

Specified by:

reject in interface MutableSet<T>

Specified by:

reject in interface MutableSetIterable<T>

Specified by:

reject in interface RichIterable<T>

Specified by:

reject in interface SetIterable<T>

Specified by:

reject in interface UnsortedSetIterable<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

public <P> MutableSet<T> rejectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.

e.g.
MutableCollection<Integer> selected =
    integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));

Specified by:

rejectWith in interface MutableCollection<T>

Specified by:

rejectWith in interface MutableSet<T>

Specified by:

rejectWith in interface MutableSetIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Specified by:

rejectWith in interface SetIterable<T>

Specified by:

rejectWith in interface UnsortedSetIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

tap

public MultiReaderSet<T> tap(Procedure<? super T> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Specified by:

tap in interface MultiReaderSet<T>

Specified by:

tap in interface MutableCollection<T>

Specified by:

tap in interface MutableSet<T>

Specified by:

tap in interface MutableSetIterable<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface SetIterable<T>

Specified by:

tap in interface UnsortedSetIterable<T>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

select

public MutableSet<T> select(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate.

MutableCollection<Integer> livesInLondon =
    people.select(person -> person.getAddress().getCity().equals("London"));

Specified by:

select in interface MutableCollection<T>

Specified by:

select in interface MutableSet<T>

Specified by:

select in interface MutableSetIterable<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface SetIterable<T>

Specified by:

select in interface UnsortedSetIterable<T>

selectWith

public <P> MutableSet<T> selectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.

MutableCollection<Integer> fives =
    integers.selectWith(Predicates2.equal(), Integer.valueOf(5));

Specified by:

selectWith in interface MutableCollection<T>

Specified by:

selectWith in interface MutableSet<T>

Specified by:

selectWith in interface MutableSetIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Specified by:

selectWith in interface SetIterable<T>

Specified by:

selectWith in interface UnsortedSetIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

partition

public PartitionMutableSet<T> partition(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

PartitionIterable<Person> newYorkersAndNonNewYorkers =
    people.partition(person -> person.getAddress().getState().getName().equals("New York"));

Co-variant example for MutableCollection:

PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
    people.partition(person -> person.getAddress().getState().getName().equals("New York"));

Specified by:

partition in interface MutableCollection<T>

Specified by:

partition in interface MutableSet<T>

Specified by:

partition in interface MutableSetIterable<T>

Specified by:

partition in interface RichIterable<T>

Specified by:

partition in interface SetIterable<T>

partitionWith

public <P> PartitionMutableSet<T> partitionWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

PartitionIterable<Person> newYorkersAndNonNewYorkers =
    people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");

Co-variant example for MutableCollection:

PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
    people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");

Specified by:

partitionWith in interface MutableCollection<T>

Specified by:

partitionWith in interface MutableSet<T>

Specified by:

partitionWith in interface MutableSetIterable<T>

Specified by:

partitionWith in interface RichIterable<T>

Specified by:

partitionWith in interface SetIterable<T>

selectInstancesOf

public <S> MutableSet<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: MutableCollection

Returns all elements of the source collection that are instances of the Class clazz.

RichIterable<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Co-variant example for MutableCollection:

MutableCollection<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Specified by:

selectInstancesOf in interface MutableCollection<T>

Specified by:

selectInstancesOf in interface MutableSet<T>

Specified by:

selectInstancesOf in interface MutableSetIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface SetIterable<T>

Specified by:

selectInstancesOf in interface UnsortedSetIterable<T>

equals

public boolean equals(Object o)

Description copied from interface: SetIterable

Follows the same general contract as Set.equals(Object).

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Specified by:

equals in interface SetIterable<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: SetIterable

Follows the same general contract as Set.hashCode().

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Specified by:

hashCode in interface SetIterable<T>

Overrides:

hashCode in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

groupBy

public <V> MutableSetMultimap<V,T> groupBy(Function<? super T, ? extends V> function)

Description copied from interface: MutableCollection

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

Example using a Java 8 method reference:

Multimap<String, Person> peopleByLastName =
    people.groupBy(Person::getLastName);

Co-variant example for MutableCollection:

MutableMultimap<String, Person> peopleByLastName =
    people.groupBy(Person::getLastName);

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface MutableSet<T>

Specified by:

groupBy in interface MutableSetIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface UnsortedSetIterable<T>

groupByEach

public <V> MutableSetMultimap<V,T> groupByEach(Function<? super T, ? extends Iterable<V>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface MutableCollection<T>

Specified by:

groupByEach in interface MutableSet<T>

Specified by:

groupByEach in interface MutableSetIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface UnsortedSetIterable<T>

groupByUniqueKey

public <V> MutableMap<V,T> groupByUniqueKey(Function<? super T, ? extends V> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface MutableCollection<T>

Specified by:

groupByUniqueKey in interface RichIterable<T>

See Also:

• RichIterable.groupBy(Function)

zip

@Deprecated
public <S> MutableSet<Pair<T,S>> zip(Iterable<S> that)

Deprecated.

in 6.0. Use OrderedIterable.zip(Iterable) instead.

Description copied from interface: RichIterable

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface MutableCollection<T>

Specified by:

zip in interface MutableSet<T>

Specified by:

zip in interface MutableSetIterable<T>

Specified by:

zip in interface RichIterable<T>

Specified by:

zip in interface UnsortedSetIterable<T>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

@Deprecated
public MutableSet<Pair<T,Integer>> zipWithIndex()

Deprecated.

in 6.0. Use OrderedIterable.zipWithIndex() instead.

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface MutableCollection<T>

Specified by:

zipWithIndex in interface MutableSet<T>

Specified by:

zipWithIndex in interface MutableSetIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface SetIterable<T>

Specified by:

zipWithIndex in interface UnsortedSetIterable<T>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

• RichIterable.zip(Iterable)

chunk

public RichIterable<RichIterable<T>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface RichIterable<T>

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.

union

public MutableSet<T> union(SetIterable<? extends T> set)

Description copied from interface: SetIterable

Returns the set of all objects that are a member of this or set or both. The union of [1, 2, 3] and [2, 3, 4] is the set [1, 2, 3, 4]. If equal elements appear in both sets, then the output will contain the copy from this.

Specified by:

union in interface MutableSet<T>

Specified by:

union in interface SetIterable<T>

Specified by:

union in interface UnsortedSetIterable<T>

unionInto

public <R extends Set<T>> R unionInto(SetIterable<? extends T> set,
 R targetSet)

Description copied from interface: SetIterable

Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

unionInto in interface SetIterable<T>

intersect

public MutableSet<T> intersect(SetIterable<? extends T> set)

Description copied from interface: SetIterable

Returns the set of all objects that are members of both this and set. The intersection of [1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances from the smaller of the two sets (this or set) based on the size. If the sizes are equal, the output will contain instances from this.

Note: If you need to ensure that the memory references from this are preserved in the resulting set, consider using this.select(that::contains) instead.

Specified by:

intersect in interface MutableSet<T>

Specified by:

intersect in interface SetIterable<T>

Specified by:

intersect in interface UnsortedSetIterable<T>

intersectInto

public <R extends Set<T>> R intersectInto(SetIterable<? extends T> set,
 R targetSet)

Description copied from interface: SetIterable

Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

intersectInto in interface SetIterable<T>

difference

public MutableSet<T> difference(SetIterable<? extends T> subtrahendSet)

Description copied from interface: SetIterable

Returns the set of all members of this that are not members of subtrahendSet. The difference of [1, 2, 3] and [2, 3, 4] is [1].

Specified by:

difference in interface MutableSet<T>

Specified by:

difference in interface SetIterable<T>

Specified by:

difference in interface UnsortedSetIterable<T>

differenceInto

public <R extends Set<T>> R differenceInto(SetIterable<? extends T> subtrahendSet,
 R targetSet)

Description copied from interface: SetIterable

Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

differenceInto in interface SetIterable<T>

symmetricDifference

public MutableSet<T> symmetricDifference(SetIterable<? extends T> setB)

Description copied from interface: SetIterable

Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both). For instance, for the sets [1, 2, 3] and [2, 3, 4], the symmetric difference set is [1, 4] . It is the set difference of the union and the intersection.

Specified by:

symmetricDifference in interface MutableSet<T>

Specified by:

symmetricDifference in interface SetIterable<T>

Specified by:

symmetricDifference in interface UnsortedSetIterable<T>

symmetricDifferenceInto

public <R extends Set<T>> R symmetricDifferenceInto(SetIterable<? extends T> set,
 R targetSet)

Description copied from interface: SetIterable

Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.

Specified by:

symmetricDifferenceInto in interface SetIterable<T>

isSubsetOf

public boolean isSubsetOf(SetIterable<? extends T> candidateSuperset)

Description copied from interface: SetIterable

Returns true if all the members of this are also members of candidateSuperset. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.

Specified by:

isSubsetOf in interface SetIterable<T>

isProperSubsetOf

public boolean isProperSubsetOf(SetIterable<? extends T> candidateSuperset)

Description copied from interface: SetIterable

Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal. For example, [1, 2] is a proper subset of [1, 2, 3], but [1, 2, 3] is not.

Specified by:

isProperSubsetOf in interface SetIterable<T>

powerSet

public MutableSet<UnsortedSetIterable<T>> powerSet()

Description copied from interface: UnsortedSetIterable

Returns the set whose members are all possible subsets of this. For example, the powerset of [1, 2] is [[], [1], [2], [1, 2]].

Specified by:

powerSet in interface MutableSet<T>

Specified by:

powerSet in interface UnsortedSetIterable<T>

cartesianProduct

public <B> LazyIterable<Pair<T,B>> cartesianProduct(SetIterable<B> set)

Description copied from interface: SetIterable

Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.

Specified by:

cartesianProduct in interface SetIterable<T>

asParallel

public ParallelUnsortedSetIterable<T> asParallel(ExecutorService executorService,
 int batchSize)

Description copied from interface: SetIterable

Returns a parallel iterable of this SetIterable.

Specified by:

asParallel in interface SetIterable<T>

Specified by:

asParallel in interface UnsortedSetIterable<T>