Class SetAdapter<T>
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<T>
,Collection<T>
,Set<T>
,MutableCollection<T>
,InternalIterable<T>
,RichIterable<T>
,MutableSet<T>
,MutableSetIterable<T>
,SetIterable<T>
,UnsortedSetIterable<T>
public final class SetAdapter<T> extends AbstractCollectionAdapter<T> implements Serializable, MutableSet<T>
To create a new wrapper around an existing Set instance, use the adapt(Set)
factory method.
- See Also:
- Serialized Form
-
Method Summary
Modifier and Type Method Description static <E> MutableSet<E>
adapt(Set<E> set)
ParallelUnsortedSetIterable<T>
asParallel(ExecutorService executorService, int batchSize)
Returns a parallel iterable of this SetIterable.MutableSet<T>
asSynchronized()
Returns a synchronized wrapper backed by this collection.MutableSet<T>
asUnmodifiable()
Returns an unmodifiable view of the set.<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 ofthis
and b is a member ofset
.MutableSet<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 primitiveboolean
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 primitivebyte
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 primitivechar
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 primitivedouble
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 primitivefloat
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 primitiveint
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 primitivelong
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 primitiveshort
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 asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.boolean
contains(Object o)
Returns true if the iterable has an element which responds true to element.equals(object).boolean
containsAll(Collection<?> collection)
Returns true if all elements in source are contained in this collection.MutableSet<T>
difference(SetIterable<? extends T> subtrahendSet)
Returns the set of all members ofthis
that are not members ofsubtrahendSet
.<R extends Set<T>>
RdifferenceInto(SetIterable<? extends T> subtrahendSet, R targetSet)
Same asSetIterable.difference(SetIterable)
but adds all the objects totargetSet
and returns it.boolean
equals(Object obj)
Follows the same general contract asSet.equals(Object)
.<V> MutableSet<V>
flatCollect(Function<? super T,? extends Iterable<V>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.<V> UnifiedSetMultimap<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> UnifiedSetMultimap<V,T>
groupByEach(Function<? super T,? extends Iterable<V>> function)
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.int
hashCode()
Follows the same general contract asSet.hashCode()
.MutableSet<T>
intersect(SetIterable<? extends T> set)
Returns the set of all objects that are members of boththis
andset
.<R extends Set<T>>
RintersectInto(SetIterable<? extends T> set, R targetSet)
Same asSetIterable.intersect(SetIterable)
but adds all the objects totargetSet
and returns it.boolean
isProperSubsetOf(SetIterable<? extends T> candidateSuperset)
Returns true if all the members ofthis
are also members ofcandidateSuperset
and the two sets are not equal.boolean
isSubsetOf(SetIterable<? extends T> candidateSuperset)
Returns true if all the members ofthis
are also members ofcandidateSuperset
.MutableSet<T>
newEmpty()
Deprecated.useUnifiedSet.newSet()
instead (inlineable)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 ofthis
.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.boolean
removeAllIterable(Iterable<?> iterable)
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 Classclazz
.<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 ofthis
andsetB
(elements which are in one of the sets, but not in both).<R extends Set<T>>
RsymmetricDifferenceInto(SetIterable<? extends T> set, R targetSet)
Same asSetIterable.symmetricDifference(SetIterable)
but adds all the objects totargetSet
and returns it.MutableSet<T>
tap(Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returnsthis
.ImmutableSet<T>
toImmutable()
Returns an immutable copy of this set.MutableSet<T>
union(SetIterable<? extends T> set)
Returns the set of all objects that are a member ofthis
orset
or both.<R extends Set<T>>
RunionInto(SetIterable<? extends T> set, R targetSet)
Same asSetIterable.union(SetIterable)
but adds all the objects totargetSet
and returns it.SetAdapter<T>
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.SetAdapter<T>
with(T... elements)
SetAdapter<T>
with(T element1, T element2)
SetAdapter<T>
with(T element1, T element2, T element3)
SetAdapter<T>
withAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.SetAdapter<T>
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.SetAdapter<T>
withoutAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.<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 org.eclipse.collections.impl.collection.mutable.AbstractCollectionAdapter
add, addAll, addAllIterable, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, asLazy, chunk, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex
Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, flatCollectWith, groupByUniqueKey, injectIntoWith, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, containsBy, 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, 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, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
-
Method Details
-
asUnmodifiable
Description copied from interface:MutableSet
Returns an unmodifiable view of the set.- Specified by:
asUnmodifiable
in interfaceMutableCollection<T>
- Specified by:
asUnmodifiable
in interfaceMutableSet<T>
- Returns:
- an unmodifiable view of this set
- See Also:
Collections.unmodifiableCollection(Collection)
-
asSynchronized
Description copied from interface:MutableCollection
Returns a synchronized wrapper backed by this collection. This is the equivalent of usingCollections.synchronizedCollection(this)
only with a return type that supports the full iteration protocols available onMutableCollection
. 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 interfaceMutableCollection<T>
- Specified by:
asSynchronized
in interfaceMutableSet<T>
- Returns:
- a synchronized view of this collection.
- See Also:
Collections.synchronizedCollection(Collection)
-
toImmutable
Description copied from interface:MutableSet
Returns an immutable copy of this set. If the set is immutable, it returns itself.- Specified by:
toImmutable
in interfaceMutableCollection<T>
- Specified by:
toImmutable
in interfaceMutableSet<T>
- Specified by:
toImmutable
in interfaceSetIterable<T>
- Specified by:
toImmutable
in interfaceUnsortedSetIterable<T>
-
adapt
-
clone
- Specified by:
clone
in interfaceMutableSet<T>
-
contains
Description copied from interface:RichIterable
Returns true if the iterable has an element which responds true to element.equals(object).- Specified by:
contains
in interfaceCollection<T>
- Specified by:
contains
in interfaceRichIterable<T>
- Specified by:
contains
in interfaceSet<T>
- Overrides:
contains
in classAbstractCollectionAdapter<T>
-
containsAll
Description copied from interface:RichIterable
Returns true if all elements in source are contained in this collection.- Specified by:
containsAll
in interfaceCollection<T>
- Specified by:
containsAll
in interfaceRichIterable<T>
- Specified by:
containsAll
in interfaceSet<T>
- Overrides:
containsAll
in classAbstractCollectionAdapter<T>
- See Also:
Collection.containsAll(Collection)
-
equals
Description copied from interface:SetIterable
Follows the same general contract asSet.equals(Object)
. -
hashCode
public int hashCode()Description copied from interface:SetIterable
Follows the same general contract asSet.hashCode()
. -
with
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 ofFixedSizeCollection
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 interfaceMutableCollection<T>
- Specified by:
with
in interfaceMutableSet<T>
- Specified by:
with
in interfaceMutableSetIterable<T>
- See Also:
Collection.add(Object)
-
with
-
with
-
with
-
without
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 ofFixedSizeCollection
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 interfaceMutableCollection<T>
- Specified by:
without
in interfaceMutableSet<T>
- Specified by:
without
in interfaceMutableSetIterable<T>
- See Also:
Collection.remove(Object)
-
withAll
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 ofFixedSizeCollection
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 interfaceMutableCollection<T>
- Specified by:
withAll
in interfaceMutableSet<T>
- Specified by:
withAll
in interfaceMutableSetIterable<T>
- See Also:
Collection.addAll(Collection)
-
withoutAll
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 ofFixedSizeCollection
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 interfaceMutableCollection<T>
- Specified by:
withoutAll
in interfaceMutableSet<T>
- Specified by:
withoutAll
in interfaceMutableSetIterable<T>
- See Also:
Collection.removeAll(Collection)
-
newEmpty
Deprecated.useUnifiedSet.newSet()
instead (inlineable)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 interfaceMutableCollection<T>
- Specified by:
newEmpty
in interfaceMutableSet<T>
-
tap
Description copied from interface:RichIterable
Executes the Procedure for each element in the iterable and returnsthis
.Example using a Java 8 lambda expression:
RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
RichIterable<Person> tapped = people.tap(new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
- Specified by:
tap
in interfaceMutableCollection<T>
- Specified by:
tap
in interfaceMutableSet<T>
- Specified by:
tap
in interfaceMutableSetIterable<T>
- Specified by:
tap
in interfaceRichIterable<T>
- Specified by:
tap
in interfaceSetIterable<T>
- Specified by:
tap
in interfaceUnsortedSetIterable<T>
- Overrides:
tap
in classAbstractCollectionAdapter<T>
- See Also:
RichIterable.each(Procedure)
,RichIterable.forEach(Procedure)
-
select
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 interfaceMutableCollection<T>
- Specified by:
select
in interfaceMutableSet<T>
- Specified by:
select
in interfaceMutableSetIterable<T>
- Specified by:
select
in interfaceRichIterable<T>
- Specified by:
select
in interfaceSetIterable<T>
- Specified by:
select
in interfaceUnsortedSetIterable<T>
- Overrides:
select
in classAbstractCollectionAdapter<T>
-
reject
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 thePredicates
factory:MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
- Specified by:
reject
in interfaceMutableCollection<T>
- Specified by:
reject
in interfaceMutableSet<T>
- Specified by:
reject
in interfaceMutableSetIterable<T>
- Specified by:
reject
in interfaceRichIterable<T>
- Specified by:
reject
in interfaceSetIterable<T>
- Specified by:
reject
in interfaceUnsortedSetIterable<T>
- Overrides:
reject
in classAbstractCollectionAdapter<T>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
partition
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"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return 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 interfaceMutableCollection<T>
- Specified by:
partition
in interfaceMutableSet<T>
- Specified by:
partition
in interfaceMutableSetIterable<T>
- Specified by:
partition
in interfaceRichIterable<T>
- Specified by:
partition
in interfaceSetIterable<T>
- Overrides:
partition
in classAbstractCollectionAdapter<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");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return 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 interfaceMutableCollection<T>
- Specified by:
partitionWith
in interfaceMutableSet<T>
- Specified by:
partitionWith
in interfaceMutableSetIterable<T>
- Specified by:
partitionWith
in interfaceRichIterable<T>
- Specified by:
partitionWith
in interfaceSetIterable<T>
- Overrides:
partitionWith
in classAbstractCollectionAdapter<T>
-
selectInstancesOf
Description copied from interface:MutableCollection
Returns all elements of the source collection that are instances of the Classclazz
.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 interfaceMutableCollection<T>
- Specified by:
selectInstancesOf
in interfaceMutableSet<T>
- Specified by:
selectInstancesOf
in interfaceMutableSetIterable<T>
- Specified by:
selectInstancesOf
in interfaceRichIterable<T>
- Specified by:
selectInstancesOf
in interfaceSetIterable<T>
- Specified by:
selectInstancesOf
in interfaceUnsortedSetIterable<T>
- Overrides:
selectInstancesOf
in classAbstractCollectionAdapter<T>
-
collect
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 interfaceMutableCollection<T>
- Specified by:
collect
in interfaceMutableSet<T>
- Specified by:
collect
in interfaceRichIterable<T>
- Specified by:
collect
in interfaceUnsortedSetIterable<T>
- Overrides:
collect
in classAbstractCollectionAdapter<T>
-
collectBoolean
Description copied from interface:MutableCollection
Returns a new primitiveboolean
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());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
Co-variant example for MutableCollection:MutableBooleanCollection licenses = people.collectBoolean(person -> person.hasDrivingLicense());
- Specified by:
collectBoolean
in interfaceMutableCollection<T>
- Specified by:
collectBoolean
in interfaceMutableSet<T>
- Specified by:
collectBoolean
in interfaceRichIterable<T>
- Specified by:
collectBoolean
in interfaceUnsortedSetIterable<T>
- Overrides:
collectBoolean
in classAbstractCollectionAdapter<T>
-
collectByte
Description copied from interface:MutableCollection
Returns a new primitivebyte
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());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
Co-variant example for MutableCollection:MutableByteCollection bytes = people.collectByte(person -> person.getCode());
- Specified by:
collectByte
in interfaceMutableCollection<T>
- Specified by:
collectByte
in interfaceMutableSet<T>
- Specified by:
collectByte
in interfaceRichIterable<T>
- Specified by:
collectByte
in interfaceUnsortedSetIterable<T>
- Overrides:
collectByte
in classAbstractCollectionAdapter<T>
-
collectChar
Description copied from interface:MutableCollection
Returns a new primitivechar
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());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
Co-variant example for MutableCollection:MutableCharCollection chars = people.collectChar(person -> person.getMiddleInitial());
- Specified by:
collectChar
in interfaceMutableCollection<T>
- Specified by:
collectChar
in interfaceMutableSet<T>
- Specified by:
collectChar
in interfaceRichIterable<T>
- Specified by:
collectChar
in interfaceUnsortedSetIterable<T>
- Overrides:
collectChar
in classAbstractCollectionAdapter<T>
-
collectDouble
Description copied from interface:MutableCollection
Returns a new primitivedouble
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());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
Co-variant example for MutableCollection:MutableDoubleCollection doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
- Specified by:
collectDouble
in interfaceMutableCollection<T>
- Specified by:
collectDouble
in interfaceMutableSet<T>
- Specified by:
collectDouble
in interfaceRichIterable<T>
- Specified by:
collectDouble
in interfaceUnsortedSetIterable<T>
- Overrides:
collectDouble
in classAbstractCollectionAdapter<T>
-
collectFloat
Description copied from interface:MutableCollection
Returns a new primitivefloat
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());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
Co-variant example for MutableCollection:MutableFloatCollection floats = people.collectFloat(person -> person.getHeightInInches());
- Specified by:
collectFloat
in interfaceMutableCollection<T>
- Specified by:
collectFloat
in interfaceMutableSet<T>
- Specified by:
collectFloat
in interfaceRichIterable<T>
- Specified by:
collectFloat
in interfaceUnsortedSetIterable<T>
- Overrides:
collectFloat
in classAbstractCollectionAdapter<T>
-
collectInt
Description copied from interface:MutableCollection
Returns a new primitiveint
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());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
Co-variant example for MutableCollection:MutableIntCollection ints = people.collectInt(person -> person.getAge());
- Specified by:
collectInt
in interfaceMutableCollection<T>
- Specified by:
collectInt
in interfaceMutableSet<T>
- Specified by:
collectInt
in interfaceRichIterable<T>
- Specified by:
collectInt
in interfaceUnsortedSetIterable<T>
- Overrides:
collectInt
in classAbstractCollectionAdapter<T>
-
collectLong
Description copied from interface:MutableCollection
Returns a new primitivelong
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());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
Co-variant example for MutableCollection:MutableLongCollection longs = people.collectLong(person -> person.getGuid());
- Specified by:
collectLong
in interfaceMutableCollection<T>
- Specified by:
collectLong
in interfaceMutableSet<T>
- Specified by:
collectLong
in interfaceRichIterable<T>
- Specified by:
collectLong
in interfaceUnsortedSetIterable<T>
- Overrides:
collectLong
in classAbstractCollectionAdapter<T>
-
collectShort
Description copied from interface:MutableCollection
Returns a new primitiveshort
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());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
Co-variant example for MutableCollection:MutableShortCollection shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
- Specified by:
collectShort
in interfaceMutableCollection<T>
- Specified by:
collectShort
in interfaceMutableSet<T>
- Specified by:
collectShort
in interfaceRichIterable<T>
- Specified by:
collectShort
in interfaceUnsortedSetIterable<T>
- Overrides:
collectShort
in classAbstractCollectionAdapter<T>
-
flatCollect
Description copied from interface:MutableCollection
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
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 eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
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 interfaceMutableCollection<T>
- Specified by:
flatCollect
in interfaceMutableSet<T>
- Specified by:
flatCollect
in interfaceRichIterable<T>
- Specified by:
flatCollect
in interfaceUnsortedSetIterable<T>
- Overrides:
flatCollect
in classAbstractCollectionAdapter<T>
- Parameters:
function
- TheFunction
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 interfaceMutableCollection<T>
- Specified by:
collectIf
in interfaceMutableSet<T>
- Specified by:
collectIf
in interfaceRichIterable<T>
- Specified by:
collectIf
in interfaceUnsortedSetIterable<T>
- Overrides:
collectIf
in classAbstractCollectionAdapter<T>
-
groupBy
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);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
Co-variant example for MutableCollection:MutableMultimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
- Specified by:
groupBy
in interfaceMutableCollection<T>
- Specified by:
groupBy
in interfaceMutableSet<T>
- Specified by:
groupBy
in interfaceMutableSetIterable<T>
- Specified by:
groupBy
in interfaceRichIterable<T>
- Specified by:
groupBy
in interfaceUnsortedSetIterable<T>
- Overrides:
groupBy
in classAbstractCollectionAdapter<T>
-
groupByEach
public <V> UnifiedSetMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceMutableCollection<T>
- Specified by:
groupByEach
in interfaceMutableSet<T>
- Specified by:
groupByEach
in interfaceMutableSetIterable<T>
- Specified by:
groupByEach
in interfaceRichIterable<T>
- Specified by:
groupByEach
in interfaceUnsortedSetIterable<T>
- Overrides:
groupByEach
in classAbstractCollectionAdapter<T>
-
selectWith
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 interfaceMutableCollection<T>
- Specified by:
selectWith
in interfaceMutableSet<T>
- Specified by:
selectWith
in interfaceMutableSetIterable<T>
- Specified by:
selectWith
in interfaceRichIterable<T>
- Specified by:
selectWith
in interfaceSetIterable<T>
- Specified by:
selectWith
in interfaceUnsortedSetIterable<T>
- Overrides:
selectWith
in classAbstractCollectionAdapter<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
rejectWith
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 interfaceMutableCollection<T>
- Specified by:
rejectWith
in interfaceMutableSet<T>
- Specified by:
rejectWith
in interfaceMutableSetIterable<T>
- Specified by:
rejectWith
in interfaceRichIterable<T>
- Specified by:
rejectWith
in interfaceSetIterable<T>
- Specified by:
rejectWith
in interfaceUnsortedSetIterable<T>
- Overrides:
rejectWith
in classAbstractCollectionAdapter<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
collectWith
public <P, V> MutableSet<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)Description copied from interface:MutableCollection
Same asRichIterable.collect(Function)
with aFunction2
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));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, 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 interfaceMutableCollection<T>
- Specified by:
collectWith
in interfaceMutableSet<T>
- Specified by:
collectWith
in interfaceRichIterable<T>
- Specified by:
collectWith
in interfaceUnsortedSetIterable<T>
- Overrides:
collectWith
in classAbstractCollectionAdapter<T>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
zip
Deprecated.in 6.0. UseOrderedIterable.zip(Iterable)
instead.Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceMutableCollection<T>
- Specified by:
zip
in interfaceMutableSet<T>
- Specified by:
zip
in interfaceMutableSetIterable<T>
- Specified by:
zip
in interfaceRichIterable<T>
- Specified by:
zip
in interfaceUnsortedSetIterable<T>
- Overrides:
zip
in classAbstractCollectionAdapter<T>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
Deprecated.in 6.0. UseOrderedIterable.zipWithIndex()
instead.Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceMutableCollection<T>
- Specified by:
zipWithIndex
in interfaceMutableSet<T>
- Specified by:
zipWithIndex
in interfaceMutableSetIterable<T>
- Specified by:
zipWithIndex
in interfaceRichIterable<T>
- Specified by:
zipWithIndex
in interfaceSetIterable<T>
- Specified by:
zipWithIndex
in interfaceUnsortedSetIterable<T>
- Overrides:
zipWithIndex
in classAbstractCollectionAdapter<T>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
removeAllIterable
- Specified by:
removeAllIterable
in interfaceMutableCollection<T>
- Overrides:
removeAllIterable
in classAbstractCollectionAdapter<T>
- See Also:
Collection.removeAll(Collection)
-
union
Description copied from interface:SetIterable
Returns the set of all objects that are a member ofthis
orset
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 fromthis
.- Specified by:
union
in interfaceMutableSet<T>
- Specified by:
union
in interfaceSetIterable<T>
- Specified by:
union
in interfaceUnsortedSetIterable<T>
-
unionInto
Description copied from interface:SetIterable
Same asSetIterable.union(SetIterable)
but adds all the objects totargetSet
and returns it.- Specified by:
unionInto
in interfaceSetIterable<T>
-
intersect
Description copied from interface:SetIterable
Returns the set of all objects that are members of boththis
andset
. The intersection of [1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances fromthis
, notset
.- Specified by:
intersect
in interfaceMutableSet<T>
- Specified by:
intersect
in interfaceSetIterable<T>
- Specified by:
intersect
in interfaceUnsortedSetIterable<T>
-
intersectInto
Description copied from interface:SetIterable
Same asSetIterable.intersect(SetIterable)
but adds all the objects totargetSet
and returns it.- Specified by:
intersectInto
in interfaceSetIterable<T>
-
difference
Description copied from interface:SetIterable
Returns the set of all members ofthis
that are not members ofsubtrahendSet
. The difference of [1, 2, 3] and [2, 3, 4] is [1].- Specified by:
difference
in interfaceMutableSet<T>
- Specified by:
difference
in interfaceSetIterable<T>
- Specified by:
difference
in interfaceUnsortedSetIterable<T>
-
differenceInto
Description copied from interface:SetIterable
Same asSetIterable.difference(SetIterable)
but adds all the objects totargetSet
and returns it.- Specified by:
differenceInto
in interfaceSetIterable<T>
-
symmetricDifference
Description copied from interface:SetIterable
Returns the set of all objects that are a member of exactly one ofthis
andsetB
(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 interfaceMutableSet<T>
- Specified by:
symmetricDifference
in interfaceSetIterable<T>
- Specified by:
symmetricDifference
in interfaceUnsortedSetIterable<T>
-
symmetricDifferenceInto
Description copied from interface:SetIterable
Same asSetIterable.symmetricDifference(SetIterable)
but adds all the objects totargetSet
and returns it.- Specified by:
symmetricDifferenceInto
in interfaceSetIterable<T>
-
isSubsetOf
Description copied from interface:SetIterable
Returns true if all the members ofthis
are also members ofcandidateSuperset
. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.- Specified by:
isSubsetOf
in interfaceSetIterable<T>
-
isProperSubsetOf
Description copied from interface:SetIterable
Returns true if all the members ofthis
are also members ofcandidateSuperset
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 interfaceSetIterable<T>
-
powerSet
Description copied from interface:UnsortedSetIterable
Returns the set whose members are all possible subsets ofthis
. For example, the powerset of [1, 2] is [[], [1], [2], [1, 2]].- Specified by:
powerSet
in interfaceMutableSet<T>
- Specified by:
powerSet
in interfaceUnsortedSetIterable<T>
-
cartesianProduct
Description copied from interface:SetIterable
Returns the set whose members are all possible ordered pairs (a, b) where a is a member ofthis
and b is a member ofset
.- Specified by:
cartesianProduct
in interfaceSetIterable<T>
-
asParallel
Description copied from interface:SetIterable
Returns a parallel iterable of this SetIterable.- Specified by:
asParallel
in interfaceSetIterable<T>
- Specified by:
asParallel
in interfaceUnsortedSetIterable<T>
-