public final class SetAdapter<T> extends AbstractCollectionAdapter<T> implements java.io.Serializable, com.gs.collections.api.set.MutableSet<T>
adapt(Set) factory method.| Modifier and Type | Method and Description |
|---|---|
static <E> com.gs.collections.api.set.MutableSet<E> |
adapt(java.util.Set<E> set) |
com.gs.collections.api.set.MutableSet<T> |
asSynchronized()
Returns a synchronized (thread-safe) collection backed by this collection.
|
com.gs.collections.api.set.MutableSet<T> |
asUnmodifiable()
Returns an unmodifable view of the set.
|
<B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>> |
cartesianProduct(com.gs.collections.api.set.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. |
com.gs.collections.api.set.MutableSet<T> |
clone() |
<V> com.gs.collections.api.set.MutableSet<V> |
collect(com.gs.collections.api.block.function.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.
|
com.gs.collections.api.set.primitive.MutableBooleanSet |
collectBoolean(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.set.primitive.MutableByteSet |
collectByte(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.set.primitive.MutableCharSet |
collectChar(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.set.primitive.MutableDoubleSet |
collectDouble(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.set.primitive.MutableFloatSet |
collectFloat(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.set.MutableSet<V> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
com.gs.collections.api.block.function.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.
|
com.gs.collections.api.set.primitive.MutableIntSet |
collectInt(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.set.primitive.MutableLongSet |
collectLong(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.set.primitive.MutableShortSet |
collectShort(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.set.MutableSet<V> |
collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
P parameter)
Same as collect with a
Function2 and specified parameter which is passed to the block
|
boolean |
contains(java.lang.Object o)
Returns true if the iterable has an element which responds true to element.equals(object).
|
boolean |
containsAll(java.util.Collection<?> collection)
Returns true if all elements in source are contained in this collection.
|
com.gs.collections.api.set.MutableSet<T> |
difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)
Returns the set of all members of
this that are not members of subtrahendSet. |
<R extends java.util.Set<T>> |
differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet,
R targetSet)
Same as
SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it. |
boolean |
equals(java.lang.Object obj)
Follows the same general contract as
Set.equals(Object). |
<V> com.gs.collections.api.set.MutableSet<V> |
flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function). |
protected java.util.Set<T> |
getDelegate() |
<V> UnifiedSetMultimap<V,T> |
groupBy(com.gs.collections.api.block.function.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(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
Similar to
RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value. |
int |
hashCode()
Follows the same general contract as
Set.hashCode(). |
com.gs.collections.api.set.MutableSet<T> |
intersect(com.gs.collections.api.set.SetIterable<? extends T> set)
Returns the set of all objects that are members of both
this and set. |
<R extends java.util.Set<T>> |
intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set,
R targetSet)
Same as
SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it. |
boolean |
isProperSubsetOf(com.gs.collections.api.set.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(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
Returns true if all the members of
this are also members of candidateSuperset. |
com.gs.collections.api.set.MutableSet<T> |
newEmpty()
Deprecated.
use
UnifiedSet.newSet() instead (inlineable) |
com.gs.collections.api.partition.set.PartitionMutableSet<T> |
partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> com.gs.collections.api.partition.set.PartitionMutableSet<T> |
partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
com.gs.collections.api.set.MutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>> |
powerSet()
Returns the set whose members are all possible subsets of
this. |
com.gs.collections.api.set.MutableSet<T> |
reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
|
<P> com.gs.collections.api.set.MutableSet<T> |
rejectWith(com.gs.collections.api.block.predicate.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(java.lang.Iterable<?> iterable) |
com.gs.collections.api.set.MutableSet<T> |
select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
|
<S> com.gs.collections.api.set.MutableSet<S> |
selectInstancesOf(java.lang.Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> com.gs.collections.api.set.MutableSet<T> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
|
com.gs.collections.api.set.MutableSet<T> |
symmetricDifference(com.gs.collections.api.set.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 java.util.Set<T>> |
symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set,
R targetSet)
Same as
SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it. |
com.gs.collections.api.set.ImmutableSet<T> |
toImmutable()
Returns an immutable copy of this set.
|
com.gs.collections.api.set.MutableSet<T> |
union(com.gs.collections.api.set.SetIterable<? extends T> set)
Returns the set of all objects that are a member of
this or set or both. |
<R extends java.util.Set<T>> |
unionInto(com.gs.collections.api.set.SetIterable<? extends T> set,
R targetSet)
Same as
SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it. |
SetAdapter<T> |
with(T... elements) |
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 element1,
T element2) |
SetAdapter<T> |
with(T element1,
T element2,
T element3) |
SetAdapter<T> |
withAll(java.lang.Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing
elements.
|
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(java.lang.Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing
elements.
|
<S> com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,S>> |
zip(java.lang.Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, wrap, zip, zipWithIndexfinalize, getClass, notify, notifyAll, wait, wait, waitaggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexforEach, forEachWith, forEachWithIndexprotected java.util.Set<T> getDelegate()
getDelegate in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.MutableSet<T> asUnmodifiable()
com.gs.collections.api.set.MutableSetpublic com.gs.collections.api.set.MutableSet<T> asSynchronized()
com.gs.collections.api.collection.MutableCollection
MutableCollection collection = myCollection.asSynchronized();
...
synchronized(collection)
{
Iterator i = c.iterator(); // Must be in the synchronized block
while (i.hasNext())
foo(i.next());
}
Failure to follow this advice may result in non-deterministic behavior.
The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is
properly synchronized internally.
MutableCollection collection = myCollection.asSynchronized();
...
collection.forEach(new Procedure()
{
public void value(Object each)
{
...
}
});
The returned collection does not pass the hashCode and equals operations through to the
backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve
the contracts of these operations in the case that the backing collection is a set or a list.
The returned collection will be serializable if this collection is serializable.public com.gs.collections.api.set.ImmutableSet<T> toImmutable()
com.gs.collections.api.set.MutableSetpublic static <E> com.gs.collections.api.set.MutableSet<E> adapt(java.util.Set<E> set)
public com.gs.collections.api.set.MutableSet<T> clone()
clone in interface com.gs.collections.api.set.MutableSet<T>clone in class java.lang.Objectpublic boolean contains(java.lang.Object o)
com.gs.collections.api.RichIterablepublic boolean containsAll(java.util.Collection<?> collection)
com.gs.collections.api.RichIterablecontainsAll in interface com.gs.collections.api.RichIterable<T>containsAll in interface java.util.Collection<T>containsAll in interface java.util.Set<T>containsAll in class AbstractCollectionAdapter<T>Collection.containsAll(Collection)public boolean equals(java.lang.Object obj)
com.gs.collections.api.set.SetIterableSet.equals(Object).public int hashCode()
com.gs.collections.api.set.SetIterableSet.hashCode().public SetAdapter<T> with(T element)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.with("1"); list = list.with("2"); return list;
FixedSizeCollection a new instance of MutableCollection will be returned by with, and any
variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling add on itself.public SetAdapter<T> with(T element1, T element2)
public SetAdapter<T> with(T element1, T element2, T element3)
public SetAdapter<T> with(T... elements)
public SetAdapter<T> without(T element)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.without("1"); list = list.without("2"); return list;
FixedSizeCollection a new instance of MutableCollection will be returned by without, and
any variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling remove on itself.public SetAdapter<T> withAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.withAll(FastList.newListWith("1", "2")); return list;
FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and
any variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling addAll on itself.public SetAdapter<T> withoutAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.withoutAll(FastList.newListWith("1", "2")); return list;
FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll,
and any variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling removeAll on itself.@Deprecated public com.gs.collections.api.set.MutableSet<T> newEmpty()
UnifiedSet.newSet() instead (inlineable)com.gs.collections.api.collection.MutableCollectionpublic com.gs.collections.api.set.MutableSet<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.collection.MutableCollectione.g.
return people.select(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.getAddress().getCity().equals("Metuchen");
}
});
select in interface com.gs.collections.api.collection.MutableCollection<T>select in interface com.gs.collections.api.RichIterable<T>select in interface com.gs.collections.api.set.MutableSet<T>select in interface com.gs.collections.api.set.SetIterable<T>select in interface com.gs.collections.api.set.UnsortedSetIterable<T>select in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.MutableSet<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.collection.MutableCollectione.g.
return people.reject(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.person.getLastName().equals("Smith");
}
});
e.g.
return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject in interface com.gs.collections.api.collection.MutableCollection<T>reject in interface com.gs.collections.api.RichIterable<T>reject in interface com.gs.collections.api.set.MutableSet<T>reject in interface com.gs.collections.api.set.SetIterable<T>reject in interface com.gs.collections.api.set.UnsortedSetIterable<T>reject in class AbstractCollectionAdapter<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic com.gs.collections.api.partition.set.PartitionMutableSet<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterablee.g.
return people.partition(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getState().getName().equals("New York");
}
});
partition in interface com.gs.collections.api.collection.MutableCollection<T>partition in interface com.gs.collections.api.RichIterable<T>partition in interface com.gs.collections.api.set.MutableSet<T>partition in interface com.gs.collections.api.set.SetIterable<T>partition in class AbstractCollectionAdapter<T>public <P> com.gs.collections.api.partition.set.PartitionMutableSet<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterablee.g.
return people.partitionWith(new Predicate2<Person, String>()
{
public boolean accept(Person person, String state)
{
return person.getAddress().getState().getName().equals(state);
}
}, "New York");
partitionWith in interface com.gs.collections.api.collection.MutableCollection<T>partitionWith in interface com.gs.collections.api.RichIterable<T>partitionWith in interface com.gs.collections.api.set.MutableSet<T>partitionWith in interface com.gs.collections.api.set.SetIterable<T>partitionWith in class AbstractCollectionAdapter<T>public <S> com.gs.collections.api.set.MutableSet<S> selectInstancesOf(java.lang.Class<S> clazz)
com.gs.collections.api.RichIterableclazz.selectInstancesOf in interface com.gs.collections.api.collection.MutableCollection<T>selectInstancesOf in interface com.gs.collections.api.RichIterable<T>selectInstancesOf in interface com.gs.collections.api.set.MutableSet<T>selectInstancesOf in interface com.gs.collections.api.set.SetIterable<T>selectInstancesOf in interface com.gs.collections.api.set.UnsortedSetIterable<T>selectInstancesOf in class AbstractCollectionAdapter<T>public <V> com.gs.collections.api.set.MutableSet<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.collection.MutableCollectione.g.
return people.collect(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface com.gs.collections.api.collection.MutableCollection<T>collect in interface com.gs.collections.api.RichIterable<T>collect in interface com.gs.collections.api.set.MutableSet<T>collect in interface com.gs.collections.api.set.UnsortedSetIterable<T>collect in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableBooleanSet collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
com.gs.collections.api.RichIterableboolean 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.
e.g.
return people.collectBoolean(new BooleanFunction<Person>()
{
public boolean booleanValueOf(Person person)
{
return person.hasDrivingLicense();
}
});
collectBoolean in interface com.gs.collections.api.collection.MutableCollection<T>collectBoolean in interface com.gs.collections.api.RichIterable<T>collectBoolean in interface com.gs.collections.api.set.MutableSet<T>collectBoolean in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectBoolean in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableByteSet collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
com.gs.collections.api.RichIterablebyte 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.
e.g.
return people.collectByte(new ByteFunction<Person>()
{
public byte byteValueOf(Person person)
{
return person.getCode();
}
});
collectByte in interface com.gs.collections.api.collection.MutableCollection<T>collectByte in interface com.gs.collections.api.RichIterable<T>collectByte in interface com.gs.collections.api.set.MutableSet<T>collectByte in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectByte in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableCharSet collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
com.gs.collections.api.RichIterablechar 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.
e.g.
return people.collectChar(new CharFunction<Person>()
{
public char charValueOf(Person person)
{
return person.getMiddleInitial();
}
});
collectChar in interface com.gs.collections.api.collection.MutableCollection<T>collectChar in interface com.gs.collections.api.RichIterable<T>collectChar in interface com.gs.collections.api.set.MutableSet<T>collectChar in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectChar in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableDoubleSet collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
com.gs.collections.api.RichIterabledouble 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.
e.g.
return people.collectDouble(new DoubleFunction<Person>()
{
public double doubleValueOf(Person person)
{
return person.getMilesFromNorthPole();
}
});
collectDouble in interface com.gs.collections.api.collection.MutableCollection<T>collectDouble in interface com.gs.collections.api.RichIterable<T>collectDouble in interface com.gs.collections.api.set.MutableSet<T>collectDouble in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectDouble in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableFloatSet collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
com.gs.collections.api.RichIterablefloat 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.
e.g.
return people.collectFloat(new FloatFunction<Person>()
{
public float floatValueOf(Person person)
{
return person.getHeightInInches();
}
});
collectFloat in interface com.gs.collections.api.collection.MutableCollection<T>collectFloat in interface com.gs.collections.api.RichIterable<T>collectFloat in interface com.gs.collections.api.set.MutableSet<T>collectFloat in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectFloat in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableIntSet collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
com.gs.collections.api.RichIterableint 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.
e.g.
return people.collectInt(new IntFunction<Person>()
{
public int intValueOf(Person person)
{
return person.getAge();
}
});
collectInt in interface com.gs.collections.api.collection.MutableCollection<T>collectInt in interface com.gs.collections.api.RichIterable<T>collectInt in interface com.gs.collections.api.set.MutableSet<T>collectInt in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectInt in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableLongSet collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
com.gs.collections.api.RichIterablelong 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.
e.g.
return people.collectLong(new LongFunction<Person>()
{
public long longValueOf(Person person)
{
return person.getGuid();
}
});
collectLong in interface com.gs.collections.api.collection.MutableCollection<T>collectLong in interface com.gs.collections.api.RichIterable<T>collectLong in interface com.gs.collections.api.set.MutableSet<T>collectLong in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectLong in class AbstractCollectionAdapter<T>public com.gs.collections.api.set.primitive.MutableShortSet collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
com.gs.collections.api.RichIterableshort 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.
e.g.
return people.collectShort(new ShortFunction<Person>()
{
public short shortValueOf(Person person)
{
return person.getNumberOfJunkMailItemsReceivedPerMonth();
}
});
collectShort in interface com.gs.collections.api.collection.MutableCollection<T>collectShort in interface com.gs.collections.api.RichIterable<T>collectShort in interface com.gs.collections.api.set.MutableSet<T>collectShort in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectShort in class AbstractCollectionAdapter<T>public <V> com.gs.collections.api.set.MutableSet<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.RichIterableflatCollect 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 = new Function<Person, List<Address>>() {
public List<Address> valueOf(Person person) {
return person.getAddresses();
}
};
MutableList<Person> people = ...;
Using collect returns a collection of collections of addresses.
MutableList<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect returns a single flattened list of addresses.
MutableList<Address> addresses = people.flatCollect(addressFunction);
flatCollect in interface com.gs.collections.api.collection.MutableCollection<T>flatCollect in interface com.gs.collections.api.RichIterable<T>flatCollect in interface com.gs.collections.api.set.MutableSet<T>flatCollect in interface com.gs.collections.api.set.UnsortedSetIterable<T>flatCollect in class AbstractCollectionAdapter<T>function - The Function to applyfunctionpublic <V> com.gs.collections.api.set.MutableSet<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.collection.MutableCollectione.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf in interface com.gs.collections.api.collection.MutableCollection<T>collectIf in interface com.gs.collections.api.RichIterable<T>collectIf in interface com.gs.collections.api.set.MutableSet<T>collectIf in interface com.gs.collections.api.set.UnsortedSetIterable<T>collectIf in class AbstractCollectionAdapter<T>public <V> UnifiedSetMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterablee.g.
return people.groupBy(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
groupBy in interface com.gs.collections.api.collection.MutableCollection<T>groupBy in interface com.gs.collections.api.RichIterable<T>groupBy in interface com.gs.collections.api.set.MutableSet<T>groupBy in interface com.gs.collections.api.set.UnsortedSetIterable<T>groupBy in class AbstractCollectionAdapter<T>public <V> UnifiedSetMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.RichIterableRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value.groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>groupByEach in interface com.gs.collections.api.RichIterable<T>groupByEach in interface com.gs.collections.api.set.MutableSet<T>groupByEach in interface com.gs.collections.api.set.UnsortedSetIterable<T>groupByEach in class AbstractCollectionAdapter<T>public <P> com.gs.collections.api.set.MutableSet<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.collection.MutableCollectione.g. return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
selectWith in interface com.gs.collections.api.collection.MutableCollection<T>selectWith in interface com.gs.collections.api.RichIterable<T>selectWith in interface com.gs.collections.api.set.MutableSet<T>selectWith in interface com.gs.collections.api.set.SetIterable<T>selectWith in interface com.gs.collections.api.set.UnsortedSetIterable<T>selectWith in class AbstractCollectionAdapter<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)public <P> com.gs.collections.api.set.MutableSet<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.collection.MutableCollectione.g. return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
rejectWith in interface com.gs.collections.api.collection.MutableCollection<T>rejectWith in interface com.gs.collections.api.RichIterable<T>rejectWith in interface com.gs.collections.api.set.MutableSet<T>rejectWith in interface com.gs.collections.api.set.SetIterable<T>rejectWith in interface com.gs.collections.api.set.UnsortedSetIterable<T>rejectWith in class AbstractCollectionAdapter<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)public <P,V> com.gs.collections.api.set.MutableSet<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)
com.gs.collections.api.RichIterableFunction2 and specified parameter which is passed to the block