Interface ImmutableList<T>
- All Superinterfaces:
ImmutableCollection<T>
,InternalIterable<T>
,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.-
Method Summary
Modifier and Type Method Description 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 primitiveboolean
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 primitivebyte
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 primitivechar
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 primitivedouble
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 primitivefloat
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 primitiveint
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 primitivelong
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 primitiveshort
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 asRichIterable.collect(Function)
with aFunction2
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 newListIterable
containing the distinct elements in this list.ImmutableList<T>
distinct(HashingStrategy<? super T> hashingStrategy)
Returns a newListIterable
containing the distinct elements in this list.<V> ImmutableList<T>
distinctBy(Function<? super T,? extends V> function)
Returns a newListIterable
containing the distinct elements in this list.ImmutableList<T>
drop(int count)
Returns an iterable after skipping the firstcount
elements or an empty iterable if thecount
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 Iterable<V>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.default <P, V> ImmutableList<V>
flatCollectWith(Function2<? super T,? super P,? extends 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 Iterable<V>> function)
Similar toRichIterable.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 thewith
method inMutableCollection
with the difference that a new copy of this collection with the element appended will be returned.ImmutableList<T>
newWithAll(Iterable<? extends T> elements)
This method is similar to thewithAll
method inMutableCollection
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 thewithout
method inMutableCollection
with the difference that a new copy of this collection with the element removed will be returned.ImmutableList<T>
newWithoutAll(Iterable<? extends T> elements)
This method is similar to thewithoutAll
method inMutableCollection
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 toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.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(Class<S> clazz)
Returns all elements of the source collection that are instances of the Classclazz
.<P> ImmutableList<T>
selectWith(Predicate2<? super T,? super P> predicate, P parameter)
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.ImmutableList<T>
subList(int fromIndex, int toIndex)
ImmutableList<T>
take(int count)
Returns the firstcount
elements of the iterable or all the elements in the iterable ifcount
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 returnsthis
.ImmutableList<T>
toReversed()
Returns a new ReversibleIterable in reverse order.<S> ImmutableList<Pair<T,S>>
zip(Iterable<S> that)
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs.ImmutableList<Pair<T,Integer>>
zipWithIndex()
Zips thisRichIterable
with its indices.Methods inherited from interface org.eclipse.collections.api.collection.ImmutableCollection
aggregateBy, aggregateInPlaceBy, castToCollection, countBy, countByEach, countByWith, groupByUniqueKey, parallelStream, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong
Methods inherited from interface org.eclipse.collections.api.list.ListIterable
asParallel, binarySearch, binarySearch, equals, forEachInBoth, get, getFirst, getLast, hashCode, lastIndexOf, listIterator, listIterator, toImmutable
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, indexOf, max, min, toStack, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
asReversed, detectLastIndex, reverseForEach, reverseForEachWithIndex
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, 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, toString
-
Method Details
-
newWith
Description copied from interface:ImmutableCollection
This method is similar to thewith
method inMutableCollection
with the difference that a new copy of this collection with the element appended will be returned.- Specified by:
newWith
in interfaceImmutableCollection<T>
-
newWithout
Description copied from interface:ImmutableCollection
This method is similar to thewithout
method inMutableCollection
with the difference that a new copy of this collection with the element removed will be returned.- Specified by:
newWithout
in interfaceImmutableCollection<T>
-
newWithAll
Description copied from interface:ImmutableCollection
This method is similar to thewithAll
method inMutableCollection
with the difference that a new copy of this collection with the elements appended will be returned.- Specified by:
newWithAll
in interfaceImmutableCollection<T>
-
newWithoutAll
Description copied from interface:ImmutableCollection
This method is similar to thewithoutAll
method inMutableCollection
with the difference that a new copy of this collection with the elements removed will be returned.- Specified by:
newWithoutAll
in interfaceImmutableCollection<T>
-
tap
Description copied from interface:RichIterable
Executes the Procedure for each element in the iterable and returnsthis
.Example using a Java 8 lambda expression:
RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
RichIterable<Person> tapped = people.tap(new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
- Specified by:
tap
in interfaceImmutableCollection<T>
- Specified by:
tap
in interfaceListIterable<T>
- Specified by:
tap
in interfaceOrderedIterable<T>
- Specified by:
tap
in interfaceReversibleIterable<T>
- Specified by:
tap
in interfaceRichIterable<T>
- See Also:
RichIterable.each(Procedure)
,RichIterable.forEach(Procedure)
-
select
Description copied from interface:RichIterable
Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.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"); } });
- Specified by:
select
in interfaceImmutableCollection<T>
- Specified by:
select
in interfaceListIterable<T>
- Specified by:
select
in interfaceOrderedIterable<T>
- Specified by:
select
in interfaceReversibleIterable<T>
- Specified by:
select
in interfaceRichIterable<T>
-
selectWith
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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));
- Specified by:
selectWith
in interfaceImmutableCollection<T>
- Specified by:
selectWith
in interfaceListIterable<T>
- Specified by:
selectWith
in interfaceOrderedIterable<T>
- Specified by:
selectWith
in interfaceReversibleIterable<T>
- Specified by:
selectWith
in interfaceRichIterable<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
reject
Description copied from interface:RichIterable
Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).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"); } });
- Specified by:
reject
in interfaceImmutableCollection<T>
- Specified by:
reject
in interfaceListIterable<T>
- Specified by:
reject
in interfaceOrderedIterable<T>
- Specified by:
reject
in interfaceReversibleIterable<T>
- Specified by:
reject
in interfaceRichIterable<T>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
rejectWith
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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));
- Specified by:
rejectWith
in interfaceImmutableCollection<T>
- Specified by:
rejectWith
in interfaceListIterable<T>
- Specified by:
rejectWith
in interfaceOrderedIterable<T>
- Specified by:
rejectWith
in interfaceReversibleIterable<T>
- Specified by:
rejectWith
in interfaceRichIterable<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
partition
Description copied from interface:RichIterable
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
- Specified by:
partition
in interfaceImmutableCollection<T>
- Specified by:
partition
in interfaceListIterable<T>
- Specified by:
partition
in interfaceOrderedIterable<T>
- Specified by:
partition
in interfaceReversibleIterable<T>
- Specified by:
partition
in interfaceRichIterable<T>
-
partitionWith
<P> PartitionImmutableList<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)Description copied from interface:RichIterable
Filters a collection into a PartitionIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
- Specified by:
partitionWith
in interfaceImmutableCollection<T>
- Specified by:
partitionWith
in interfaceListIterable<T>
- Specified by:
partitionWith
in interfaceOrderedIterable<T>
- Specified by:
partitionWith
in interfaceReversibleIterable<T>
- Specified by:
partitionWith
in interfaceRichIterable<T>
-
selectInstancesOf
Description copied from interface:RichIterable
Returns all elements of the source collection that are instances of the Classclazz
.RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
- Specified by:
selectInstancesOf
in interfaceImmutableCollection<T>
- Specified by:
selectInstancesOf
in interfaceListIterable<T>
- Specified by:
selectInstancesOf
in interfaceOrderedIterable<T>
- Specified by:
selectInstancesOf
in interfaceReversibleIterable<T>
- Specified by:
selectInstancesOf
in interfaceRichIterable<T>
-
collect
Description copied from interface:RichIterable
Returns a new collection 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:
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(); } });
- Specified by:
collect
in interfaceImmutableCollection<T>
- Specified by:
collect
in interfaceListIterable<T>
- Specified by:
collect
in interfaceOrderedIterable<T>
- Specified by:
collect
in interfaceReversibleIterable<T>
- Specified by:
collect
in interfaceRichIterable<T>
-
collectWithIndex
default <V> ImmutableList<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)Description copied from interface:OrderedIterable
Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.- Specified by:
collectWithIndex
in interfaceListIterable<T>
- Specified by:
collectWithIndex
in interfaceOrderedIterable<T>
- Specified by:
collectWithIndex
in interfaceReversibleIterable<T>
- Since:
- 9.1.
-
collectBoolean
Description copied from interface:RichIterable
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
- Specified by:
collectBoolean
in interfaceImmutableCollection<T>
- Specified by:
collectBoolean
in interfaceListIterable<T>
- Specified by:
collectBoolean
in interfaceOrderedIterable<T>
- Specified by:
collectBoolean
in interfaceReversibleIterable<T>
- Specified by:
collectBoolean
in interfaceRichIterable<T>
-
collectByte
Description copied from interface:RichIterable
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
- Specified by:
collectByte
in interfaceImmutableCollection<T>
- Specified by:
collectByte
in interfaceListIterable<T>
- Specified by:
collectByte
in interfaceOrderedIterable<T>
- Specified by:
collectByte
in interfaceReversibleIterable<T>
- Specified by:
collectByte
in interfaceRichIterable<T>
-
collectChar
Description copied from interface:RichIterable
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
- Specified by:
collectChar
in interfaceImmutableCollection<T>
- Specified by:
collectChar
in interfaceListIterable<T>
- Specified by:
collectChar
in interfaceOrderedIterable<T>
- Specified by:
collectChar
in interfaceReversibleIterable<T>
- Specified by:
collectChar
in interfaceRichIterable<T>
-
collectDouble
Description copied from interface:RichIterable
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
- Specified by:
collectDouble
in interfaceImmutableCollection<T>
- Specified by:
collectDouble
in interfaceListIterable<T>
- Specified by:
collectDouble
in interfaceOrderedIterable<T>
- Specified by:
collectDouble
in interfaceReversibleIterable<T>
- Specified by:
collectDouble
in interfaceRichIterable<T>
-
collectFloat
Description copied from interface:RichIterable
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
- Specified by:
collectFloat
in interfaceImmutableCollection<T>
- Specified by:
collectFloat
in interfaceListIterable<T>
- Specified by:
collectFloat
in interfaceOrderedIterable<T>
- Specified by:
collectFloat
in interfaceReversibleIterable<T>
- Specified by:
collectFloat
in interfaceRichIterable<T>
-
collectInt
Description copied from interface:RichIterable
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
- Specified by:
collectInt
in interfaceImmutableCollection<T>
- Specified by:
collectInt
in interfaceListIterable<T>
- Specified by:
collectInt
in interfaceOrderedIterable<T>
- Specified by:
collectInt
in interfaceReversibleIterable<T>
- Specified by:
collectInt
in interfaceRichIterable<T>
-
collectLong
Description copied from interface:RichIterable
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
- Specified by:
collectLong
in interfaceImmutableCollection<T>
- Specified by:
collectLong
in interfaceListIterable<T>
- Specified by:
collectLong
in interfaceOrderedIterable<T>
- Specified by:
collectLong
in interfaceReversibleIterable<T>
- Specified by:
collectLong
in interfaceRichIterable<T>
-
collectShort
Description copied from interface:RichIterable
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
- Specified by:
collectShort
in interfaceImmutableCollection<T>
- Specified by:
collectShort
in interfaceListIterable<T>
- Specified by:
collectShort
in interfaceOrderedIterable<T>
- Specified by:
collectShort
in interfaceReversibleIterable<T>
- Specified by:
collectShort
in interfaceRichIterable<T>
-
collectWith
<P, V> ImmutableList<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
- Specified by:
collectWith
in interfaceImmutableCollection<T>
- Specified by:
collectWith
in interfaceListIterable<T>
- Specified by:
collectWith
in interfaceOrderedIterable<T>
- Specified by:
collectWith
in interfaceReversibleIterable<T>
- Specified by:
collectWith
in interfaceRichIterable<T>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
collectIf
<V> ImmutableList<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)Description copied from interface:RichIterable
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. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).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());
- Specified by:
collectIf
in interfaceImmutableCollection<T>
- Specified by:
collectIf
in interfaceListIterable<T>
- Specified by:
collectIf
in interfaceOrderedIterable<T>
- Specified by:
collectIf
in interfaceReversibleIterable<T>
- Specified by:
collectIf
in interfaceRichIterable<T>
-
flatCollect
Description copied from interface:RichIterable
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
returns a collection, the result is a collection of collections.flatCollect
outputs a single "flattened" collection instead. This method is commonly called flatMap.Consider the following example where we have a
Person
class, and eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
returns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollect
in interfaceImmutableCollection<T>
- Specified by:
flatCollect
in interfaceListIterable<T>
- Specified by:
flatCollect
in interfaceOrderedIterable<T>
- Specified by:
flatCollect
in interfaceReversibleIterable<T>
- Specified by:
flatCollect
in interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
flatCollectWith
default <P, V> ImmutableList<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)- Specified by:
flatCollectWith
in interfaceImmutableCollection<T>
- Specified by:
flatCollectWith
in interfaceListIterable<T>
- Specified by:
flatCollectWith
in interfaceOrderedIterable<T>
- Specified by:
flatCollectWith
in interfaceReversibleIterable<T>
- Specified by:
flatCollectWith
in interfaceRichIterable<T>
- Since:
- 9.2
-
groupBy
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.Example using a Java 8 method reference:
Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
- Specified by:
groupBy
in interfaceImmutableCollection<T>
- Specified by:
groupBy
in interfaceListIterable<T>
- Specified by:
groupBy
in interfaceOrderedIterable<T>
- Specified by:
groupBy
in interfaceReversibleIterable<T>
- Specified by:
groupBy
in interfaceRichIterable<T>
-
groupByEach
Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceImmutableCollection<T>
- Specified by:
groupByEach
in interfaceListIterable<T>
- Specified by:
groupByEach
in interfaceOrderedIterable<T>
- Specified by:
groupByEach
in interfaceReversibleIterable<T>
- Specified by:
groupByEach
in interfaceRichIterable<T>
-
distinct
ImmutableList<T> distinct()Description copied from interface:ListIterable
Returns a newListIterable
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.- Specified by:
distinct
in interfaceListIterable<T>
- Specified by:
distinct
in interfaceOrderedIterable<T>
- Specified by:
distinct
in interfaceReversibleIterable<T>
- Returns:
ListIterable
of distinct elements
-
distinct
Description copied from interface:ListIterable
Returns a newListIterable
containing the distinct elements in this list. Takes a HashingStrategy.- Specified by:
distinct
in interfaceListIterable<T>
- Returns:
ListIterable
of distinct elements
-
distinctBy
Description copied from interface:ListIterable
Returns a newListIterable
containing the distinct elements in this list. The specified function will be used to create a HashingStrategy to unique the elements.- Specified by:
distinctBy
in interfaceListIterable<T>
- Since:
- 9.0
- See Also:
ListIterable.distinct(HashingStrategy)
-
zip
Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceImmutableCollection<T>
- Specified by:
zip
in interfaceListIterable<T>
- Specified by:
zip
in interfaceOrderedIterable<T>
- Specified by:
zip
in interfaceReversibleIterable<T>
- Specified by:
zip
in interfaceRichIterable<T>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
ImmutableList<Pair<T,Integer>> zipWithIndex()Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceImmutableCollection<T>
- Specified by:
zipWithIndex
in interfaceListIterable<T>
- Specified by:
zipWithIndex
in interfaceOrderedIterable<T>
- Specified by:
zipWithIndex
in interfaceReversibleIterable<T>
- Specified by:
zipWithIndex
in interfaceRichIterable<T>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
take
Description copied from interface:ReversibleIterable
Returns the firstcount
elements of the iterable or all the elements in the iterable ifcount
is greater than the length of the iterable.- Specified by:
take
in interfaceListIterable<T>
- Specified by:
take
in interfaceReversibleIterable<T>
- Parameters:
count
- the number of items to take.
-
takeWhile
Description copied from interface:ListIterable
Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
takeWhile
in interfaceListIterable<T>
- Specified by:
takeWhile
in interfaceOrderedIterable<T>
- Specified by:
takeWhile
in interfaceReversibleIterable<T>
-
drop
Description copied from interface:ReversibleIterable
Returns an iterable after skipping the firstcount
elements or an empty iterable if thecount
is greater than the length of the iterable.- Specified by:
drop
in interfaceListIterable<T>
- Specified by:
drop
in interfaceReversibleIterable<T>
- Parameters:
count
- the number of items to drop.
-
dropWhile
Description copied from interface:ListIterable
Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
dropWhile
in interfaceListIterable<T>
- Specified by:
dropWhile
in interfaceOrderedIterable<T>
- Specified by:
dropWhile
in interfaceReversibleIterable<T>
-
partitionWhile
Description copied from interface:ListIterable
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.- Specified by:
partitionWhile
in interfaceListIterable<T>
- Specified by:
partitionWhile
in interfaceOrderedIterable<T>
- Specified by:
partitionWhile
in interfaceReversibleIterable<T>
-
castToList
-
subList
- Specified by:
subList
in interfaceListIterable<T>
- Since:
- 6.0
- See Also:
List.subList(int, int)
-
toReversed
ImmutableList<T> toReversed()Description copied from interface:ReversibleIterable
Returns a new ReversibleIterable in reverse order.- Specified by:
toReversed
in interfaceListIterable<T>
- Specified by:
toReversed
in interfaceReversibleIterable<T>
-