@Immutable public interface ImmutableSortedSet<T> extends SortedSetIterable<T>, ImmutableSetIterable<T>
MutableSortedSet
. MutableSortedSet.toImmutable()
will give you an appropriately trimmed implementation of ImmutableSortedSet. All
ImmutableSortedSet implementations must implement the SortedSet
interface so they can satisfy the Set.equals(Object)
contract and be compared against other Sets.Modifier and Type | Method and Description |
---|---|
SortedSet<T> |
castToSortedSet() |
<V> ImmutableList<V> |
collect(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.
|
ImmutableBooleanList |
collectBoolean(BooleanFunction<? super T> booleanFunction)
Returns a new primitive
boolean iterable with the results of applying the specified function on each element
of the source collection. |
ImmutableByteList |
collectByte(ByteFunction<? super T> byteFunction)
Returns a new primitive
byte iterable with the results of applying the specified function on each element
of the source collection. |
ImmutableCharList |
collectChar(CharFunction<? super T> charFunction)
Returns a new primitive
char iterable with the results of applying the specified function on each element
of the source collection. |
ImmutableDoubleList |
collectDouble(DoubleFunction<? super T> doubleFunction)
Returns a new primitive
double iterable with the results of applying the specified function on each element
of the source collection. |
ImmutableFloatList |
collectFloat(FloatFunction<? super T> floatFunction)
Returns a new primitive
float iterable with the results of applying the specified function on each element
of the source collection. |
<V> ImmutableList<V> |
collectIf(Predicate<? super T> predicate,
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.
|
ImmutableIntList |
collectInt(IntFunction<? super T> intFunction)
Returns a new primitive
int iterable with the results of applying the specified function on each element
of the source collection. |
ImmutableLongList |
collectLong(LongFunction<? super T> longFunction)
Returns a new primitive
long iterable with the results of applying the specified function on each element
of the source collection. |
ImmutableShortList |
collectShort(ShortFunction<? super T> shortFunction)
Returns a new primitive
short iterable with the results of applying the specified function on each element
of the source collection. |
<P,V> ImmutableList<V> |
collectWith(Function2<? super T,? super P,? extends V> function,
P parameter)
Same as
RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block. |
ImmutableSortedSet<T> |
difference(SetIterable<? extends T> subtrahendSet)
Returns the set of all members of
this that are not members of subtrahendSet . |
ImmutableSortedSet<T> |
distinct()
Returns a new
SortedIterable containing the distinct elements in this iterable. |
ImmutableSortedSet<T> |
drop(int count)
Returns an iterable after skipping the first
count elements
or an empty iterable if the count is greater than the length of the iterable. |
ImmutableSortedSet<T> |
dropWhile(Predicate<? super T> predicate)
Returns the final elements that do not satisfy the Predicate.
|
<V> ImmutableList<V> |
flatCollect(Function<? super T,? extends Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function) . |
<V> ImmutableSortedSetMultimap<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> ImmutableSortedSetMultimap<V,T> |
groupByEach(Function<? super T,? extends Iterable<V>> function)
Similar to
RichIterable.groupBy(Function) , except the result of evaluating function will return a collection of keys
for each value. |
ImmutableSortedSet<T> |
intersect(SetIterable<? extends T> set)
Returns the set of all objects that are members of both
this and set . |
ImmutableSortedSet<T> |
newWith(T element) |
ImmutableSortedSet<T> |
newWithAll(Iterable<? extends T> elements) |
ImmutableSortedSet<T> |
newWithout(T element) |
ImmutableSortedSet<T> |
newWithoutAll(Iterable<? extends T> elements) |
PartitionImmutableSortedSet<T> |
partition(Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
PartitionImmutableSortedSet<T> |
partitionWhile(Predicate<? super T> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
<P> PartitionImmutableSortedSet<T> |
partitionWith(Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
ImmutableSortedSet<SortedSetIterable<T>> |
powerSet()
Returns the set whose members are all possible subsets of
this . |
ImmutableSortedSet<T> |
reject(Predicate<? super T> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
<P> ImmutableSortedSet<T> |
rejectWith(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 . |
ImmutableSortedSet<T> |
select(Predicate<? super T> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
<S> ImmutableSortedSet<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz . |
<P> ImmutableSortedSet<T> |
selectWith(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 . |
ImmutableSortedSet<T> |
symmetricDifference(SetIterable<? extends T> setB)
Returns the set of all objects that are a member of exactly one of
this and setB (elements which
are in one of the sets, but not in both). |
ImmutableSortedSet<T> |
take(int count)
Returns the first
count elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable. |
ImmutableSortedSet<T> |
takeWhile(Predicate<? super T> predicate)
Returns the initial elements that satisfy the Predicate.
|
ImmutableSortedSet<T> |
tap(Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returns
this . |
ImmutableSortedSet<T> |
toReversed()
Returns a new ReversibleIterable in reverse order.
|
ImmutableSortedSet<T> |
union(SetIterable<? extends T> set)
Returns the set of all objects that are a member of
this or set or both. |
<S> ImmutableList<Pair<T,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ImmutableSortedSet<Pair<T,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
asParallel, comparator, toImmutable
compareTo
max, min, toStack
asReversed, detectLastIndex, reverseForEach
corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getLast, indexOf, zip, zipWithIndex
aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, each, flatCollect, groupBy, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, maxBy, 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
forEach, forEachWith
forEach, iterator, spliterator
cartesianProduct, differenceInto, equals, hashCode, intersectInto, isProperSubsetOf, isSubsetOf, symmetricDifferenceInto, unionInto
aggregateBy, aggregateInPlaceBy, groupByUniqueKey
ImmutableSortedSet<T> newWith(T element)
newWith
in interface ImmutableCollection<T>
ImmutableSortedSet<T> newWithout(T element)
newWithout
in interface ImmutableCollection<T>
ImmutableSortedSet<T> newWithAll(Iterable<? extends T> elements)
newWithAll
in interface ImmutableCollection<T>
ImmutableSortedSet<T> newWithoutAll(Iterable<? extends T> elements)
newWithoutAll
in interface ImmutableCollection<T>
ImmutableSortedSet<T> tap(Procedure<? super T> procedure)
RichIterable
this
.
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 ImmutableCollection<T>
tap
in interface ImmutableSetIterable<T>
tap
in interface RichIterable<T>
RichIterable.each(Procedure)
,
InternalIterable.forEach(Procedure)
ImmutableSortedSet<T> select(Predicate<? super T> predicate)
RichIterable
Example 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 ImmutableCollection<T>
select
in interface ImmutableSetIterable<T>
select
in interface OrderedIterable<T>
select
in interface ReversibleIterable<T>
select
in interface RichIterable<T>
select
in interface SetIterable<T>
select
in interface SortedIterable<T>
select
in interface SortedSetIterable<T>
<P> ImmutableSortedSet<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
RichIterable.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 ImmutableCollection<T>
selectWith
in interface ImmutableSetIterable<T>
selectWith
in interface OrderedIterable<T>
selectWith
in interface ReversibleIterable<T>
selectWith
in interface RichIterable<T>
selectWith
in interface SetIterable<T>
selectWith
in interface SortedIterable<T>
selectWith
in interface SortedSetIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
ImmutableSortedSet<T> reject(Predicate<? super T> predicate)
RichIterable
Example 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 ImmutableCollection<T>
reject
in interface ImmutableSetIterable<T>
reject
in interface OrderedIterable<T>
reject
in interface ReversibleIterable<T>
reject
in interface RichIterable<T>
reject
in interface SetIterable<T>
reject
in interface SortedIterable<T>
reject
in interface SortedSetIterable<T>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to false<P> ImmutableSortedSet<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
RichIterable.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 ImmutableCollection<T>
rejectWith
in interface ImmutableSetIterable<T>
rejectWith
in interface OrderedIterable<T>
rejectWith
in interface ReversibleIterable<T>
rejectWith
in interface RichIterable<T>
rejectWith
in interface SetIterable<T>
rejectWith
in interface SortedIterable<T>
rejectWith
in interface SortedSetIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
PartitionImmutableSortedSet<T> partition(Predicate<? super T> predicate)
RichIterable
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"); } });
partition
in interface ImmutableCollection<T>
partition
in interface ImmutableSetIterable<T>
partition
in interface OrderedIterable<T>
partition
in interface ReversibleIterable<T>
partition
in interface RichIterable<T>
partition
in interface SetIterable<T>
partition
in interface SortedIterable<T>
partition
in interface SortedSetIterable<T>
<P> PartitionImmutableSortedSet<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
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");
partitionWith
in interface ImmutableCollection<T>
partitionWith
in interface ImmutableSetIterable<T>
partitionWith
in interface OrderedIterable<T>
partitionWith
in interface ReversibleIterable<T>
partitionWith
in interface RichIterable<T>
partitionWith
in interface SetIterable<T>
partitionWith
in interface SortedSetIterable<T>
PartitionImmutableSortedSet<T> partitionWhile(Predicate<? super T> predicate)
SortedIterable
partitionWhile
in interface OrderedIterable<T>
partitionWhile
in interface ReversibleIterable<T>
partitionWhile
in interface SortedIterable<T>
partitionWhile
in interface SortedSetIterable<T>
<S> ImmutableSortedSet<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface ImmutableCollection<T>
selectInstancesOf
in interface ImmutableSetIterable<T>
selectInstancesOf
in interface OrderedIterable<T>
selectInstancesOf
in interface ReversibleIterable<T>
selectInstancesOf
in interface RichIterable<T>
selectInstancesOf
in interface SetIterable<T>
selectInstancesOf
in interface SortedIterable<T>
selectInstancesOf
in interface SortedSetIterable<T>
<V> ImmutableList<V> collect(Function<? super T,? extends V> function)
RichIterable
Example 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 ImmutableCollection<T>
collect
in interface OrderedIterable<T>
collect
in interface ReversibleIterable<T>
collect
in interface RichIterable<T>
collect
in interface SortedSetIterable<T>
ImmutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)
RichIterable
boolean
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
collectBoolean
in interface ImmutableCollection<T>
collectBoolean
in interface OrderedIterable<T>
collectBoolean
in interface ReversibleIterable<T>
collectBoolean
in interface RichIterable<T>
collectBoolean
in interface SortedSetIterable<T>
ImmutableByteList collectByte(ByteFunction<? super T> byteFunction)
RichIterable
byte
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
collectByte
in interface ImmutableCollection<T>
collectByte
in interface OrderedIterable<T>
collectByte
in interface ReversibleIterable<T>
collectByte
in interface RichIterable<T>
collectByte
in interface SortedSetIterable<T>
ImmutableCharList collectChar(CharFunction<? super T> charFunction)
RichIterable
char
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
collectChar
in interface ImmutableCollection<T>
collectChar
in interface OrderedIterable<T>
collectChar
in interface ReversibleIterable<T>
collectChar
in interface RichIterable<T>
collectChar
in interface SortedSetIterable<T>
ImmutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)
RichIterable
double
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
collectDouble
in interface ImmutableCollection<T>
collectDouble
in interface OrderedIterable<T>
collectDouble
in interface ReversibleIterable<T>
collectDouble
in interface RichIterable<T>
collectDouble
in interface SortedSetIterable<T>
ImmutableFloatList collectFloat(FloatFunction<? super T> floatFunction)
RichIterable
float
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
collectFloat
in interface ImmutableCollection<T>
collectFloat
in interface OrderedIterable<T>
collectFloat
in interface ReversibleIterable<T>
collectFloat
in interface RichIterable<T>
collectFloat
in interface SortedSetIterable<T>
ImmutableIntList collectInt(IntFunction<? super T> intFunction)
RichIterable
int
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
collectInt
in interface ImmutableCollection<T>
collectInt
in interface OrderedIterable<T>
collectInt
in interface ReversibleIterable<T>
collectInt
in interface RichIterable<T>
collectInt
in interface SortedSetIterable<T>
ImmutableLongList collectLong(LongFunction<? super T> longFunction)
RichIterable
long
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
collectLong
in interface ImmutableCollection<T>
collectLong
in interface OrderedIterable<T>
collectLong
in interface ReversibleIterable<T>
collectLong
in interface RichIterable<T>
collectLong
in interface SortedSetIterable<T>
ImmutableShortList collectShort(ShortFunction<? super T> shortFunction)
RichIterable
short
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
collectShort
in interface ImmutableCollection<T>
collectShort
in interface OrderedIterable<T>
collectShort
in interface ReversibleIterable<T>
collectShort
in interface RichIterable<T>
collectShort
in interface SortedSetIterable<T>
<P,V> ImmutableList<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
RichIterable
RichIterable.collect(Function)
with a Function2
and specified parameter which is passed to the block.
Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
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 ImmutableCollection<T>
collectWith
in interface OrderedIterable<T>
collectWith
in interface ReversibleIterable<T>
collectWith
in interface RichIterable<T>
collectWith
in interface SortedSetIterable<T>
function
- A Function2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argument P
in function
RichIterable
that contains the transformed elements returned by Function2.value(Object, Object)
RichIterable.collect(Function)
<V> ImmutableList<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
RichIterable
Example 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 ImmutableCollection<T>
collectIf
in interface OrderedIterable<T>
collectIf
in interface ReversibleIterable<T>
collectIf
in interface RichIterable<T>
collectIf
in interface SortedSetIterable<T>
<V> ImmutableList<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
RichIterable
flatCollect
is a special case of RichIterable.collect(Function)
. With collect
, when the Function
returns
a collection, the result is a collection of collections. flatCollect
outputs a single "flattened" collection
instead. This method is commonly called flatMap.
Consider the following example where we have a Person
class, and each Person
has a list of Address
objects. Take the following Function
:
Function<Person, List<Address>> addressFunction = Person::getAddresses; 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 ImmutableCollection<T>
flatCollect
in interface OrderedIterable<T>
flatCollect
in interface ReversibleIterable<T>
flatCollect
in interface RichIterable<T>
flatCollect
in interface SortedSetIterable<T>
function
- The Function
to applyfunction
ImmutableSortedSet<T> distinct()
SortedIterable
SortedIterable
containing the distinct elements in this iterable.
Conceptually similar to RichIterable.toSet()
.RichIterable.toList()
but retains the original order. If an element appears
multiple times in this iterable, the first one will be copied into the result.
distinct
in interface OrderedIterable<T>
distinct
in interface ReversibleIterable<T>
distinct
in interface SortedIterable<T>
distinct
in interface SortedSetIterable<T>
SortedIterable
of distinct elementsImmutableSortedSet<T> takeWhile(Predicate<? super T> predicate)
SortedIterable
takeWhile
in interface OrderedIterable<T>
takeWhile
in interface ReversibleIterable<T>
takeWhile
in interface SortedIterable<T>
takeWhile
in interface SortedSetIterable<T>
ImmutableSortedSet<T> dropWhile(Predicate<? super T> predicate)
SortedIterable
dropWhile
in interface OrderedIterable<T>
dropWhile
in interface ReversibleIterable<T>
dropWhile
in interface SortedIterable<T>
dropWhile
in interface SortedSetIterable<T>
<V> ImmutableSortedSetMultimap<V,T> groupBy(Function<? super T,? extends V> function)
RichIterable
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(); } });
groupBy
in interface ImmutableCollection<T>
groupBy
in interface ImmutableSetIterable<T>
groupBy
in interface OrderedIterable<T>
groupBy
in interface ReversibleIterable<T>
groupBy
in interface RichIterable<T>
groupBy
in interface SortedIterable<T>
groupBy
in interface SortedSetIterable<T>
<V> ImmutableSortedSetMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface ImmutableCollection<T>
groupByEach
in interface ImmutableSetIterable<T>
groupByEach
in interface OrderedIterable<T>
groupByEach
in interface ReversibleIterable<T>
groupByEach
in interface RichIterable<T>
groupByEach
in interface SortedIterable<T>
groupByEach
in interface SortedSetIterable<T>
<S> ImmutableList<Pair<T,S>> zip(Iterable<S> that)
RichIterable
RichIterable
formed from this RichIterable
and another RichIterable
by
combining corresponding elements in pairs. If one of the two RichIterable
s is longer than the other, its
remaining elements are ignored.zip
in interface ImmutableCollection<T>
zip
in interface OrderedIterable<T>
zip
in interface ReversibleIterable<T>
zip
in interface RichIterable<T>
zip
in interface SortedIterable<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.ImmutableSortedSet<Pair<T,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface ImmutableCollection<T>
zipWithIndex
in interface ImmutableSetIterable<T>
zipWithIndex
in interface OrderedIterable<T>
zipWithIndex
in interface ReversibleIterable<T>
zipWithIndex
in interface RichIterable<T>
zipWithIndex
in interface SetIterable<T>
zipWithIndex
in interface SortedIterable<T>
zipWithIndex
in interface SortedSetIterable<T>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
ImmutableSortedSet<T> toReversed()
ReversibleIterable
toReversed
in interface ReversibleIterable<T>
toReversed
in interface SortedSetIterable<T>
ImmutableSortedSet<T> take(int count)
ReversibleIterable
count
elements of the iterable
or all the elements in the iterable if count
is greater than the length of
the iterable.take
in interface ReversibleIterable<T>
take
in interface SortedSetIterable<T>
count
- the number of items to take.ImmutableSortedSet<T> drop(int count)
ReversibleIterable
count
elements
or an empty iterable if the count
is greater than the length of the iterable.drop
in interface ReversibleIterable<T>
drop
in interface SortedSetIterable<T>
count
- the number of items to drop.ImmutableSortedSet<T> union(SetIterable<? extends T> set)
SortedSetIterable
this
or set
or both. The union of [1, 2, 3]
and [2, 3, 4] is the set [1, 2, 3, 4]. If equal elements appear in both sets, then the output will contain the
copy from this
.union
in interface SetIterable<T>
union
in interface SortedSetIterable<T>
ImmutableSortedSet<T> intersect(SetIterable<? extends T> set)
SortedSetIterable
this
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
.intersect
in interface SetIterable<T>
intersect
in interface SortedSetIterable<T>
ImmutableSortedSet<T> difference(SetIterable<? extends T> subtrahendSet)
SortedSetIterable
this
that are not members of subtrahendSet
. The difference of
[1, 2, 3] and [2, 3, 4] is [1].difference
in interface SetIterable<T>
difference
in interface SortedSetIterable<T>
ImmutableSortedSet<T> symmetricDifference(SetIterable<? extends T> setB)
SortedSetIterable
this
and setB
(elements which
are in one of the sets, but not in both). For instance, for the sets [1, 2, 3] and [2, 3, 4], the symmetric
difference set is [1, 4] . It is the set difference of the union and the intersection.symmetricDifference
in interface SetIterable<T>
symmetricDifference
in interface SortedSetIterable<T>
ImmutableSortedSet<SortedSetIterable<T>> powerSet()
SortedSetIterable
this
. For example, the powerset of [1, 2] is
[[], [1], [2], [1, 2]].powerSet
in interface SortedSetIterable<T>
Copyright © 2004–2016. All rights reserved.