ImmutableCollection<T>, InternalIterable<T>, java.lang.Iterable<T>, ListIterable<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>public interface ImmutableList<T> extends ImmutableCollection<T>, ListIterable<T>
MutableList. MutableList.toImmutable()
will give you an appropriately trimmed implementation of ImmutableList. All ImmutableList implementations must
implement the java.util.List interface so they can satisfy the equals() contract and be compared against other list
structures like FastList or ArrayList.| Modifier and Type | Method | Description |
|---|---|---|
java.util.List<T> |
castToList() |
|
<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. |
default <V> ImmutableList<V> |
collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function) |
Returns a new OrderedIterable using results obtained by applying the specified function to each element
and its corresponding index.
|
ImmutableList<T> |
distinct() |
Returns a new
ListIterable containing the distinct elements in this list. |
ImmutableList<T> |
distinct(HashingStrategy<? super T> hashingStrategy) |
Returns a new
ListIterable containing the distinct elements in this list. |
<V> ImmutableList<T> |
distinctBy(Function<? super T,? extends V> function) |
Returns a new
ListIterable containing the distinct elements in this list. |
ImmutableList<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. |
ImmutableList<T> |
dropWhile(Predicate<? super T> predicate) |
Returns the final elements that do not satisfy the Predicate.
|
<V> ImmutableList<V> |
flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function) |
flatCollect is a special case of RichIterable.collect(Function). |
default <P,V> ImmutableList<V> |
flatCollectWith(Function2<? super T,? super P,? extends java.lang.Iterable<V>> function,
P parameter) |
|
<V> ImmutableListMultimap<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> ImmutableListMultimap<V,T> |
groupByEach(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. |
ImmutableList<T> |
newWith(T element) |
This method is similar to the
with method in MutableCollection
with the difference that a new copy of this collection with the element appended will be returned. |
ImmutableList<T> |
newWithAll(java.lang.Iterable<? extends T> elements) |
This method is similar to the
withAll method in MutableCollection
with the difference that a new copy of this collection with the elements appended will be returned. |
ImmutableList<T> |
newWithout(T element) |
This method is similar to the
without method in MutableCollection
with the difference that a new copy of this collection with the element removed will be returned. |
ImmutableList<T> |
newWithoutAll(java.lang.Iterable<? extends T> elements) |
This method is similar to the
withoutAll method in MutableCollection
with the difference that a new copy of this collection with the elements removed will be returned. |
PartitionImmutableList<T> |
partition(Predicate<? super T> predicate) |
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
PartitionImmutableList<T> |
partitionWhile(Predicate<? super T> predicate) |
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
<P> PartitionImmutableList<T> |
partitionWith(Predicate2<? super T,? super P> predicate,
P parameter) |
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
ImmutableList<T> |
reject(Predicate<? super T> predicate) |
Returns all elements of the source collection that return false when evaluating of the predicate.
|
<P> ImmutableList<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. |
ImmutableList<T> |
select(Predicate<? super T> predicate) |
Returns all elements of the source collection that return true when evaluating the predicate.
|
<S> ImmutableList<S> |
selectInstancesOf(java.lang.Class<S> clazz) |
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> ImmutableList<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. |
ImmutableList<T> |
subList(int fromIndex,
int toIndex) |
|
ImmutableList<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. |
ImmutableList<T> |
takeWhile(Predicate<? super T> predicate) |
Returns the initial elements that satisfy the Predicate.
|
ImmutableList<T> |
tap(Procedure<? super T> procedure) |
Executes the Procedure for each element in the iterable and returns
this. |
ImmutableList<T> |
toReversed() |
Returns a new ReversibleIterable in reverse order.
|
<S> ImmutableList<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. |
ImmutableList<Pair<T,java.lang.Integer>> |
zipWithIndex() |
Zips this
RichIterable with its indices. |
aggregateBy, aggregateInPlaceBy, castToCollection, countBy, countByEach, countByWith, groupByUniqueKey, parallelStream, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLongforEachWithasParallel, binarySearch, binarySearch, equals, get, getFirst, getLast, hashCode, lastIndexOf, listIterator, listIterator, toImmutable, toStackcollectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, indexOfasReversed, detectLastIndex, reverseForEach, reverseForEachWithIndexallSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectWith, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toStringImmutableList<T> newWith(T element)
ImmutableCollectionwith method in MutableCollection
with the difference that a new copy of this collection with the element appended will be returned.newWith in interface ImmutableCollection<T>ImmutableList<T> newWithout(T element)
ImmutableCollectionwithout method in MutableCollection
with the difference that a new copy of this collection with the element removed will be returned.newWithout in interface ImmutableCollection<T>ImmutableList<T> newWithAll(java.lang.Iterable<? extends T> elements)
ImmutableCollectionwithAll method in MutableCollection
with the difference that a new copy of this collection with the elements appended will be returned.newWithAll in interface ImmutableCollection<T>ImmutableList<T> newWithoutAll(java.lang.Iterable<? extends T> elements)
ImmutableCollectionwithoutAll method in MutableCollection
with the difference that a new copy of this collection with the elements removed will be returned.newWithoutAll in interface ImmutableCollection<T>ImmutableList<T> tap(Procedure<? super T> procedure)
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<Person>()
{
public void value(Person person)
{
LOGGER.info(person.getName());
}
});
tap in interface ImmutableCollection<T>tap in interface ListIterable<T>tap in interface OrderedIterable<T>tap in interface ReversibleIterable<T>tap in interface RichIterable<T>RichIterable.each(Procedure),
RichIterable.forEach(Procedure)ImmutableList<T> select(Predicate<? super T> predicate)
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 ImmutableCollection<T>select in interface ListIterable<T>select in interface OrderedIterable<T>select in interface ReversibleIterable<T>select in interface RichIterable<T><P> ImmutableList<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
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 ImmutableCollection<T>selectWith in interface ListIterable<T>selectWith in interface OrderedIterable<T>selectWith in interface ReversibleIterable<T>selectWith in interface RichIterable<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)ImmutableList<T> reject(Predicate<? super T> predicate)
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 ImmutableCollection<T>reject in interface ListIterable<T>reject in interface OrderedIterable<T>reject in interface ReversibleIterable<T>reject in interface RichIterable<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to false<P> ImmutableList<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
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 ImmutableCollection<T>rejectWith in interface ListIterable<T>rejectWith in interface OrderedIterable<T>rejectWith in interface ReversibleIterable<T>rejectWith in interface RichIterable<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)PartitionImmutableList<T> partition(Predicate<? super T> predicate)
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 ImmutableCollection<T>partition in interface ListIterable<T>partition in interface OrderedIterable<T>partition in interface ReversibleIterable<T>partition in interface RichIterable<T><P> PartitionImmutableList<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
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 ImmutableCollection<T>partitionWith in interface ListIterable<T>partitionWith in interface OrderedIterable<T>partitionWith in interface ReversibleIterable<T>partitionWith in interface RichIterable<T><S> ImmutableList<S> selectInstancesOf(java.lang.Class<S> clazz)
RichIterableclazz.
RichIterable<Integer> integers =
List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
selectInstancesOf in interface ImmutableCollection<T>selectInstancesOf in interface ListIterable<T>selectInstancesOf in interface OrderedIterable<T>selectInstancesOf in interface ReversibleIterable<T>selectInstancesOf in interface RichIterable<T><V> ImmutableList<V> collect(Function<? super T,? extends V> function)
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 ImmutableCollection<T>collect in interface ListIterable<T>collect in interface OrderedIterable<T>collect in interface ReversibleIterable<T>collect in interface RichIterable<T>default <V> ImmutableList<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)
OrderedIterablecollectWithIndex in interface ListIterable<T>collectWithIndex in interface OrderedIterable<T>collectWithIndex in interface ReversibleIterable<T>ImmutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)
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 ImmutableCollection<T>collectBoolean in interface ListIterable<T>collectBoolean in interface OrderedIterable<T>collectBoolean in interface ReversibleIterable<T>collectBoolean in interface RichIterable<T>ImmutableByteList collectByte(ByteFunction<? super T> byteFunction)
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 ImmutableCollection<T>collectByte in interface ListIterable<T>collectByte in interface OrderedIterable<T>collectByte in interface ReversibleIterable<T>collectByte in interface RichIterable<T>ImmutableCharList collectChar(CharFunction<? super T> charFunction)
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 ImmutableCollection<T>collectChar in interface ListIterable<T>collectChar in interface OrderedIterable<T>collectChar in interface ReversibleIterable<T>collectChar in interface RichIterable<T>ImmutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)
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 ImmutableCollection<T>collectDouble in interface ListIterable<T>collectDouble in interface OrderedIterable<T>collectDouble in interface ReversibleIterable<T>collectDouble in interface RichIterable<T>ImmutableFloatList collectFloat(FloatFunction<? super T> floatFunction)
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 ImmutableCollection<T>collectFloat in interface ListIterable<T>collectFloat in interface OrderedIterable<T>collectFloat in interface ReversibleIterable<T>collectFloat in interface RichIterable<T>ImmutableIntList collectInt(IntFunction<? super T> intFunction)
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 ImmutableCollection<T>collectInt in interface ListIterable<T>collectInt in interface OrderedIterable<T>collectInt in interface ReversibleIterable<T>collectInt in interface RichIterable<T>ImmutableLongList collectLong(LongFunction<? super T> longFunction)
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 ImmutableCollection<T>collectLong in interface ListIterable<T>collectLong in interface OrderedIterable<T>collectLong in interface ReversibleIterable<T>collectLong in interface RichIterable<T>ImmutableShortList collectShort(ShortFunction<? super T> shortFunction)
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 ImmutableCollection<T>collectShort in interface ListIterable<T>collectShort in interface OrderedIterable<T>collectShort in interface ReversibleIterable<T>collectShort in interface RichIterable<T><P,V> ImmutableList<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
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 ImmutableCollection<T>collectWith in interface ListIterable<T>collectWith in interface OrderedIterable<T>collectWith in interface ReversibleIterable<T>collectWith in interface RichIterable<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)<V> ImmutableList<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
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 ImmutableCollection<T>collectIf in interface ListIterable<T>collectIf in interface OrderedIterable<T>collectIf in interface ReversibleIterable<T>collectIf in interface RichIterable<T><V> ImmutableList<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
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; RichIterable<Person> people = ...;Using
collect returns a collection of collections of addresses.
RichIterable<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect returns a single flattened list of addresses.
RichIterable<Address> addresses = people.flatCollect(addressFunction);
flatCollect in interface ImmutableCollection<T>flatCollect in interface ListIterable<T>flatCollect in interface OrderedIterable<T>flatCollect in interface ReversibleIterable<T>flatCollect in interface RichIterable<T>function - The Function to applyfunctiondefault <P,V> ImmutableList<V> flatCollectWith(Function2<? super T,? super P,? extends java.lang.Iterable<V>> function, P parameter)
flatCollectWith in interface ImmutableCollection<T>flatCollectWith in interface ListIterable<T>flatCollectWith in interface OrderedIterable<T>flatCollectWith in interface ReversibleIterable<T>flatCollectWith in interface RichIterable<T><V> ImmutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
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 valueOf(Person person)
{
return person.getLastName();
}
});
groupBy in interface ImmutableCollection<T>groupBy in interface ListIterable<T>groupBy in interface OrderedIterable<T>groupBy in interface ReversibleIterable<T>groupBy in interface RichIterable<T><V> ImmutableListMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
RichIterableRichIterable.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 ListIterable<T>groupByEach in interface OrderedIterable<T>groupByEach in interface ReversibleIterable<T>groupByEach in interface RichIterable<T>ImmutableList<T> distinct()
ListIterableListIterable containing the distinct elements in this list.
Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears
multiple times in this list, the first one will be copied into the result.
distinct in interface ListIterable<T>distinct in interface OrderedIterable<T>distinct in interface ReversibleIterable<T>ListIterable of distinct elementsImmutableList<T> distinct(HashingStrategy<? super T> hashingStrategy)
ListIterableListIterable containing the distinct elements in this list. Takes a HashingStrategy.distinct in interface ListIterable<T>ListIterable of distinct elements<V> ImmutableList<T> distinctBy(Function<? super T,? extends V> function)
ListIterableListIterable containing the distinct elements in this list.
The specified function will be used to create a HashingStrategy to unique the elements.distinctBy in interface ListIterable<T>ListIterable.distinct(HashingStrategy)<S> ImmutableList<Pair<T,S>> zip(java.lang.Iterable<S> that)
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 ImmutableCollection<T>zip in interface ListIterable<T>zip in interface OrderedIterable<T>zip in interface ReversibleIterable<T>zip in interface RichIterable<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.ImmutableList<Pair<T,java.lang.Integer>> zipWithIndex()
RichIterableRichIterable with its indices.zipWithIndex in interface ImmutableCollection<T>zipWithIndex in interface ListIterable<T>zipWithIndex in interface OrderedIterable<T>zipWithIndex in interface ReversibleIterable<T>zipWithIndex in interface RichIterable<T>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)ImmutableList<T> take(int count)
ReversibleIterablecount elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable.take in interface ListIterable<T>take in interface ReversibleIterable<T>count - the number of items to take.ImmutableList<T> takeWhile(Predicate<? super T> predicate)
ListIterabletakeWhile in interface ListIterable<T>takeWhile in interface OrderedIterable<T>takeWhile in interface ReversibleIterable<T>ImmutableList<T> drop(int count)
ReversibleIterablecount elements
or an empty iterable if the count is greater than the length of the iterable.drop in interface ListIterable<T>drop in interface ReversibleIterable<T>count - the number of items to drop.ImmutableList<T> dropWhile(Predicate<? super T> predicate)
ListIterabledropWhile in interface ListIterable<T>dropWhile in interface OrderedIterable<T>dropWhile in interface ReversibleIterable<T>PartitionImmutableList<T> partitionWhile(Predicate<? super T> predicate)
ListIterablepartitionWhile in interface ListIterable<T>partitionWhile in interface OrderedIterable<T>partitionWhile in interface ReversibleIterable<T>java.util.List<T> castToList()
ImmutableList<T> subList(int fromIndex, int toIndex)
subList in interface ListIterable<T>List.subList(int, int)ImmutableList<T> toReversed()
ReversibleIterabletoReversed in interface ListIterable<T>toReversed in interface ReversibleIterable<T>Copyright © 2004–2020. All rights reserved.