@Immutable public abstract class AbstractImmutableSet<T> extends AbstractImmutableCollection<T> implements com.gs.collections.api.set.ImmutableSet<T>, java.util.Set<T>
| Modifier and Type | Class and Description |
|---|---|
protected class |
AbstractImmutableSet.ImmutableSetIterator |
| Constructor and Description |
|---|
AbstractImmutableSet() |
| Modifier and Type | Method and Description |
|---|---|
com.gs.collections.api.set.ParallelUnsortedSetIterable<T> |
asParallel(java.util.concurrent.ExecutorService executorService,
int batchSize)
Returns a parallel iterable of this SetIterable.
|
<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. |
java.util.Set<T> |
castToSet() |
<V> com.gs.collections.api.set.ImmutableSet<V> |
collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
com.gs.collections.api.set.primitive.ImmutableBooleanSet |
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.ImmutableByteSet |
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.ImmutableCharSet |
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.ImmutableDoubleSet |
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.ImmutableFloatSet |
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.ImmutableSet<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 collection with the results of applying the specified function on each element of the source
collection, but only for those elements which return true upon evaluation of the predicate.
|
com.gs.collections.api.set.primitive.ImmutableIntSet |
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.ImmutableLongSet |
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.ImmutableShortSet |
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.ImmutableSet<V> |
collectWith(com.gs.collections.api.block.function.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. |
com.gs.collections.api.set.ImmutableSet<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. |
<V> com.gs.collections.api.set.ImmutableSet<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). |
<V> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> |
groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
R target)
Same as
RichIterable.groupBy(Function), except that the results are gathered into the specified target
multimap. |
<V> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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. |
<V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> |
groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
R target)
Same as
RichIterable.groupByEach(Function), except that the results are gathered into the specified target
multimap. |
com.gs.collections.api.set.ImmutableSet<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. |
protected com.gs.collections.api.collection.MutableCollection<T> |
newMutable(int size) |
com.gs.collections.api.set.ImmutableSet<T> |
newWith(T element) |
com.gs.collections.api.set.ImmutableSet<T> |
newWithAll(java.lang.Iterable<? extends T> elements) |
com.gs.collections.api.set.ImmutableSet<T> |
newWithout(T element) |
com.gs.collections.api.set.ImmutableSet<T> |
newWithoutAll(java.lang.Iterable<? extends T> elements) |
protected int |
nullSafeHashCode(java.lang.Object element) |
com.gs.collections.api.partition.set.PartitionImmutableSet<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.PartitionImmutableSet<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.ImmutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>> |
powerSet()
Returns the set whose members are all possible subsets of
this. |
com.gs.collections.api.set.ImmutableSet<T> |
reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
<P> com.gs.collections.api.set.ImmutableSet<T> |
rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
com.gs.collections.api.set.ImmutableSet<T> |
select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
<S> com.gs.collections.api.set.ImmutableSet<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.ImmutableSet<T> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
com.gs.collections.api.set.ImmutableSet<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> |
tap(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returns
this. |
com.gs.collections.api.set.ImmutableSet<T> |
toImmutable()
Converts the UnsortedSetIterable to an immutable implementation.
|
com.gs.collections.api.set.ImmutableSet<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. |
<S> com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,S>> |
zip(java.lang.Iterable<S> that)
Deprecated.
in 6.0. Use
OrderedIterable.zip(Iterable) instead. |
com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> |
zipWithIndex()
Deprecated.
in 6.0. Use
OrderedIterable.zipWithIndex() instead. |
add, addAll, aggregateBy, aggregateInPlaceBy, chunk, clear, groupByUniqueKey, remove, removeAll, removeAllFrom, retainAllallSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, forEachWith, forEachWithIndex, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaggregateBy, aggregateInPlaceBy, groupByUniqueKeyallSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, each, flatCollect, getFirst, getLast, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexpublic java.util.Set<T> castToSet()
castToSet in interface com.gs.collections.api.set.ImmutableSet<T>protected int nullSafeHashCode(java.lang.Object element)
public com.gs.collections.api.set.ImmutableSet<T> newWithAll(java.lang.Iterable<? extends T> elements)
public com.gs.collections.api.set.ImmutableSet<T> newWithoutAll(java.lang.Iterable<? extends T> elements)
public com.gs.collections.api.set.ImmutableSet<T> tap(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.RichIterablethis.
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()
{
public void value(Person person)
{
LOGGER.info(person.getName());
}
});
tap in interface com.gs.collections.api.collection.ImmutableCollection<T>tap in interface com.gs.collections.api.RichIterable<T>tap in interface com.gs.collections.api.set.ImmutableSet<T>tap in interface com.gs.collections.api.set.ImmutableSetIterable<T>RichIterable.each(Procedure),
InternalIterable.forEach(Procedure)public com.gs.collections.api.set.ImmutableSet<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableExample using a Java 8 lambda expression:
RichIterable<Person> selected =
people.select(person -> person.getAddress().getCity().equals("London"));
Example using an anonymous inner class:
RichIterable<Person> selected =
people.select(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getCity().equals("London");
}
});select in interface com.gs.collections.api.collection.ImmutableCollection<T>select in interface com.gs.collections.api.RichIterable<T>select in interface com.gs.collections.api.set.ImmutableSet<T>select in interface com.gs.collections.api.set.ImmutableSetIterable<T>select in interface com.gs.collections.api.set.SetIterable<T>select in interface com.gs.collections.api.set.UnsortedSetIterable<T>public <P> com.gs.collections.api.set.ImmutableSet<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableRichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
Example using a Java 8 lambda expression:
RichIterable<Person> selected =
people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18));
Example using an anonymous inner class:
RichIterable<Person> selected =
people.selectWith(new Predicate2<Person, Integer>()
{
public boolean accept(Person person, Integer age)
{
return person.getAge() >= age;
}
}, Integer.valueOf(18));
selectWith in interface com.gs.collections.api.collection.ImmutableCollection<T>selectWith in interface com.gs.collections.api.RichIterable<T>selectWith in interface com.gs.collections.api.set.ImmutableSet<T>selectWith in interface com.gs.collections.api.set.ImmutableSetIterable<T>selectWith in interface com.gs.collections.api.set.SetIterable<T>selectWith in interface com.gs.collections.api.set.UnsortedSetIterable<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 com.gs.collections.api.set.ImmutableSet<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableExample using a Java 8 lambda expression:
RichIterable<Person> rejected =
people.reject(person -> person.person.getLastName().equals("Smith"));
Example using an anonymous inner class:
RichIterable<Person> rejected =
people.reject(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.person.getLastName().equals("Smith");
}
});
reject in interface com.gs.collections.api.collection.ImmutableCollection<T>reject in interface com.gs.collections.api.RichIterable<T>reject in interface com.gs.collections.api.set.ImmutableSet<T>reject in interface com.gs.collections.api.set.ImmutableSetIterable<T>reject in interface com.gs.collections.api.set.SetIterable<T>reject in interface com.gs.collections.api.set.UnsortedSetIterable<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic <P> com.gs.collections.api.set.ImmutableSet<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableRichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
Example using a Java 8 lambda expression:
RichIterable<Person> rejected =
people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
Example using an anonymous inner class:
MutableList<Person> rejected =
people.rejectWith(new Predicate2<Person, Integer>()
{
public boolean accept(Person person, Integer age)
{
return person.getAge() < age;
}
}, Integer.valueOf(18));
rejectWith in interface com.gs.collections.api.collection.ImmutableCollection<T>rejectWith in interface com.gs.collections.api.RichIterable<T>rejectWith in interface com.gs.collections.api.set.ImmutableSet<T>rejectWith in interface com.gs.collections.api.set.ImmutableSetIterable<T>rejectWith in interface com.gs.collections.api.set.SetIterable<T>rejectWith in interface com.gs.collections.api.set.UnsortedSetIterable<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 com.gs.collections.api.partition.set.PartitionImmutableSet<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableExample 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");
}
});
partition in interface com.gs.collections.api.collection.ImmutableCollection<T>partition in interface com.gs.collections.api.RichIterable<T>partition in interface com.gs.collections.api.set.ImmutableSet<T>partition in interface com.gs.collections.api.set.ImmutableSetIterable<T>partition in interface com.gs.collections.api.set.SetIterable<T>public <P> com.gs.collections.api.partition.set.PartitionImmutableSet<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableExample 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");
partitionWith in interface com.gs.collections.api.collection.ImmutableCollection<T>partitionWith in interface com.gs.collections.api.RichIterable<T>partitionWith in interface com.gs.collections.api.set.ImmutableSet<T>partitionWith in interface com.gs.collections.api.set.ImmutableSetIterable<T>partitionWith in interface com.gs.collections.api.set.SetIterable<T>public <S> com.gs.collections.api.set.ImmutableSet<S> selectInstancesOf(java.lang.Class<S> clazz)
com.gs.collections.api.RichIterableclazz.selectInstancesOf in interface com.gs.collections.api.collection.ImmutableCollection<T>selectInstancesOf in interface com.gs.collections.api.RichIterable<T>selectInstancesOf in interface com.gs.collections.api.set.ImmutableSet<T>selectInstancesOf in interface com.gs.collections.api.set.ImmutableSetIterable<T>selectInstancesOf in interface com.gs.collections.api.set.SetIterable<T>selectInstancesOf in interface com.gs.collections.api.set.UnsortedSetIterable<T>public <V> com.gs.collections.api.set.ImmutableSet<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterableExample using a Java 8 lambda expression:
RichIterable<String> names =
people.collect(person -> person.getFirstName() + " " + person.getLastName());
Example using an anonymous inner class:
RichIterable<String> names =
people.collect(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface com.gs.collections.api.collection.ImmutableCollection<T>collect in interface com.gs.collections.api.RichIterable<T>collect in interface com.gs.collections.api.set.ImmutableSet<T>collect in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableBooleanSet 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.
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();
}
});
collectBoolean in interface com.gs.collections.api.collection.ImmutableCollection<T>collectBoolean in interface com.gs.collections.api.RichIterable<T>collectBoolean in interface com.gs.collections.api.set.ImmutableSet<T>collectBoolean in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableByteSet 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.
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();
}
});
collectByte in interface com.gs.collections.api.collection.ImmutableCollection<T>collectByte in interface com.gs.collections.api.RichIterable<T>collectByte in interface com.gs.collections.api.set.ImmutableSet<T>collectByte in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableCharSet 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.
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();
}
});
collectChar in interface com.gs.collections.api.collection.ImmutableCollection<T>collectChar in interface com.gs.collections.api.RichIterable<T>collectChar in interface com.gs.collections.api.set.ImmutableSet<T>collectChar in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableDoubleSet 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.
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();
}
});
collectDouble in interface com.gs.collections.api.collection.ImmutableCollection<T>collectDouble in interface com.gs.collections.api.RichIterable<T>collectDouble in interface com.gs.collections.api.set.ImmutableSet<T>collectDouble in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableFloatSet 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.
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();
}
});
collectFloat in interface com.gs.collections.api.collection.ImmutableCollection<T>collectFloat in interface com.gs.collections.api.RichIterable<T>collectFloat in interface com.gs.collections.api.set.ImmutableSet<T>collectFloat in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableIntSet 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.
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();
}
});
collectInt in interface com.gs.collections.api.collection.ImmutableCollection<T>collectInt in interface com.gs.collections.api.RichIterable<T>collectInt in interface com.gs.collections.api.set.ImmutableSet<T>collectInt in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableLongSet 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.
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();
}
});
collectLong in interface com.gs.collections.api.collection.ImmutableCollection<T>collectLong in interface com.gs.collections.api.RichIterable<T>collectLong in interface com.gs.collections.api.set.ImmutableSet<T>collectLong in interface com.gs.collections.api.set.UnsortedSetIterable<T>public com.gs.collections.api.set.primitive.ImmutableShortSet 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.
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();
}
});
collectShort in interface com.gs.collections.api.collection.ImmutableCollection<T>collectShort in interface com.gs.collections.api.RichIterable<T>collectShort in interface com.gs.collections.api.set.ImmutableSet<T>collectShort in interface com.gs.collections.api.set.UnsortedSetIterable<T>public <P,V> com.gs.collections.api.set.ImmutableSet<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)
com.gs.collections.api.RichIterableRichIterable.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));
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));
collectWith in interface com.gs.collections.api.collection.ImmutableCollection<T>collectWith in interface com.gs.collections.api.RichIterable<T>collectWith in interface com.gs.collections.api.set.ImmutableSet<T>collectWith in interface com.gs.collections.api.set.UnsortedSetIterable<T>function - A Function2 to use as the collect transformation functionparameter - A parameter to pass in for evaluation of the second argument P in functionRichIterable that contains the transformed elements returned by Function2.value(Object, Object)RichIterable.collect(Function)public <V> com.gs.collections.api.set.ImmutableSet<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.RichIterableExample using a Java 8 lambda and method reference:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
Example using Predicates factory:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
collectIf in interface com.gs.collections.api.collection.ImmutableCollection<T>collectIf in interface com.gs.collections.api.RichIterable<T>collectIf in interface com.gs.collections.api.set.ImmutableSet<T>collectIf in interface com.gs.collections.api.set.UnsortedSetIterable<T>public <V> com.gs.collections.api.set.ImmutableSet<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 = 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.ImmutableCollection<T>flatCollect in interface com.gs.collections.api.RichIterable<T>flatCollect in interface com.gs.collections.api.set.ImmutableSet<T>flatCollect in interface com.gs.collections.api.set.UnsortedSetIterable<T>function - The Function to applyfunctionpublic com.gs.collections.api.set.ImmutableSet<T> toImmutable()
com.gs.collections.api.set.UnsortedSetIterablepublic <V> com.gs.collections.api.multimap.set.ImmutableSetMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterableExample 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 value(Person person)
{
return person.getLastName();
}
});
groupBy in interface com.gs.collections.api.collection.ImmutableCollection<T>groupBy in interface com.gs.collections.api.RichIterable<T>groupBy in interface com.gs.collections.api.set.ImmutableSet<T>groupBy in interface com.gs.collections.api.set.ImmutableSetIterable<T>groupBy in interface com.gs.collections.api.set.UnsortedSetIterable<T>public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)
com.gs.collections.api.RichIterableRichIterable.groupBy(Function), except that the results are gathered into the specified target
multimap.
Example using a Java 8 method reference:
FastListMultimap<String, Person> peopleByLastName =
people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());
Example using an anonymous inner class:
FastListMultimap<String, Person> peopleByLastName =
people.groupBy(new Function<Person, String>()
{
public String value(Person person)
{
return person.getLastName();
}
}, new FastListMultimap<String, Person>());
groupBy in interface com.gs.collections.api.RichIterable<T>groupBy in class AbstractRichIterable<T>public <V> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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.ImmutableCollection<T>groupByEach in interface com.gs.collections.api.RichIterable<T>groupByEach in interface com.gs.collections.api.set.ImmutableSet<T>groupByEach in interface com.gs.collections.api.set.ImmutableSetIterable<T>groupByEach in interface com.gs.collections.api.set.UnsortedSetIterable<T>public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target)
com.gs.collections.api.RichIterableRichIterable.groupByEach(Function), except that the results are gathered into the specified target
multimap.groupByEach in interface com.gs.collections.api.RichIterable<T>groupByEach in class AbstractRichIterable<T>@Deprecated public <S> com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)
OrderedIterable.zip(Iterable) instead.com.gs.collections.api.RichIterableRichIterable 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.zip in interface com.gs.collections.api.collection.ImmutableCollection<T>zip in interface com.gs.collections.api.RichIterable<T>zip in interface com.gs.collections.api.set.ImmutableSet<T>zip in interface com.gs.collections.api.set.UnsortedSetIterable<T>S - the type of the second half of the returned pairsthat - The RichIterable providing the second half of each result pairRichIterable 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.@Deprecated public com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()
OrderedIterable.zipWithIndex() instead.com.gs.collections.api.RichIterableRichIterable with its indices.zipWithIndex in interface com.gs.collections.api.collection.ImmutableCollection<T>zipWithIndex in interface com.gs.collections.api.RichIterable<T>zipWithIndex in interface com.gs.collections.api.set.ImmutableSet<T>zipWithIndex in interface com.gs.collections.api.set.ImmutableSetIterable<T>zipWithIndex in interface com.gs.collections.api.set.SetIterable<T>zipWithIndex in interface com.gs.collections.api.set.UnsortedSetIterable<T>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)protected com.gs.collections.api.collection.MutableCollection<T> newMutable(int size)
newMutable in class AbstractImmutableCollection<T>public com.gs.collections.api.set.ImmutableSet<T> union(com.gs.collections.api.set.SetIterable<? extends T> set)
com.gs.collections.api.set.SetIterablethis 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.public <R extends java.util.Set<T>> R unionInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet)
com.gs.collections.api.set.SetIterableSetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.unionInto in interface com.gs.collections.api.set.SetIterable<T>public com.gs.collections.api.set.ImmutableSet<T> intersect(com.gs.collections.api.set.SetIterable<? extends T> set)
com.gs.collections.api.set.SetIterablethis and set. The intersection of
[1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances from this, not set.public <R extends java.util.Set<T>> R intersectInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet)
com.gs.collections.api.set.SetIterableSetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.intersectInto in interface com.gs.collections.api.set.SetIterable<T>public com.gs.collections.api.set.ImmutableSet<T> difference(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet)
com.gs.collections.api.set.SetIterablethis that are not members of subtrahendSet. The difference of
[1, 2, 3] and [2, 3, 4] is [1].public <R extends java.util.Set<T>> R differenceInto(com.gs.collections.api.set.SetIterable<? extends T> subtrahendSet, R targetSet)
com.gs.collections.api.set.SetIterableSetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.differenceInto in interface com.gs.collections.api.set.SetIterable<T>public com.gs.collections.api.set.ImmutableSet<T> symmetricDifference(com.gs.collections.api.set.SetIterable<? extends T> setB)
com.gs.collections.api.set.SetIterablethis 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.public <R extends java.util.Set<T>> R symmetricDifferenceInto(com.gs.collections.api.set.SetIterable<? extends T> set, R targetSet)
com.gs.collections.api.set.SetIterableSetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.symmetricDifferenceInto in interface com.gs.collections.api.set.SetIterable<T>public boolean isSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
com.gs.collections.api.set.SetIterablethis are also members of candidateSuperset.
For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.isSubsetOf in interface com.gs.collections.api.set.SetIterable<T>public boolean isProperSubsetOf(com.gs.collections.api.set.SetIterable<? extends T> candidateSuperset)
com.gs.collections.api.set.SetIterablethis 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.isProperSubsetOf in interface com.gs.collections.api.set.SetIterable<T>public com.gs.collections.api.set.ImmutableSet<com.gs.collections.api.set.UnsortedSetIterable<T>> powerSet()
com.gs.collections.api.set.UnsortedSetIterablethis. For example, the powerset of [1, 2] is
[[], [1], [2], [1, 2]].public <B> com.gs.collections.api.LazyIterable<com.gs.collections.api.tuple.Pair<T,B>> cartesianProduct(com.gs.collections.api.set.SetIterable<B> set)
com.gs.collections.api.set.SetIterablethis and b is a
member of set.cartesianProduct in interface com.gs.collections.api.set.SetIterable<T>public com.gs.collections.api.set.ParallelUnsortedSetIterable<T> asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)
com.gs.collections.api.set.SetIterable