Interface ListIterable<T>
- All Superinterfaces:
- InternalIterable<T>,- Iterable<T>,- OrderedIterable<T>,- ReversibleIterable<T>,- RichIterable<T>
- All Known Subinterfaces:
- FixedSizeList<T>,- ImmutableList<T>,- MultiReaderList<T>,- MutableList<T>
- All Known Implementing Classes:
- AbstractArrayAdapter,- AbstractListAdapter,- AbstractMemoryEfficientMutableList,- AbstractMutableList,- ArrayAdapter,- ArrayListAdapter,- CompositeFastList,- FastList,- ListAdapter,- MultiReaderFastList,- RandomAccessListAdapter,- SynchronizedMutableList,- UnmodifiableMutableList
public interface ListIterable<T> extends ReversibleIterable<T>
- 
Method SummaryModifier and Type Method Description ParallelListIterable<T>asParallel(ExecutorService executorService, int batchSize)Returns a parallel iterable of this ListIterable.default intbinarySearch(T key)Searches for the specified object using the binary search algorithm.default intbinarySearch(T key, Comparator<? super T> comparator)Searches for the specified object using the binary search algorithm.<V> ListIterable<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.BooleanListcollectBoolean(BooleanFunction<? super T> booleanFunction)Returns a new primitivebooleaniterable with the results of applying the specified function on each element of the source collection.ByteListcollectByte(ByteFunction<? super T> byteFunction)Returns a new primitivebyteiterable with the results of applying the specified function on each element of the source collection.CharListcollectChar(CharFunction<? super T> charFunction)Returns a new primitivechariterable with the results of applying the specified function on each element of the source collection.DoubleListcollectDouble(DoubleFunction<? super T> doubleFunction)Returns a new primitivedoubleiterable with the results of applying the specified function on each element of the source collection.FloatListcollectFloat(FloatFunction<? super T> floatFunction)Returns a new primitivefloatiterable with the results of applying the specified function on each element of the source collection.<V> ListIterable<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.IntListcollectInt(IntFunction<? super T> intFunction)Returns a new primitiveintiterable with the results of applying the specified function on each element of the source collection.LongListcollectLong(LongFunction<? super T> longFunction)Returns a new primitivelongiterable with the results of applying the specified function on each element of the source collection.ShortListcollectShort(ShortFunction<? super T> shortFunction)Returns a new primitiveshortiterable with the results of applying the specified function on each element of the source collection.<P, V> ListIterable<V>collectWith(Function2<? super T,? super P,? extends V> function, P parameter)Same asRichIterable.collect(Function)with aFunction2and specified parameter which is passed to the block.default <V> ListIterable<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.ListIterable<T>distinct()Returns a newListIterablecontaining the distinct elements in this list.ListIterable<T>distinct(HashingStrategy<? super T> hashingStrategy)Returns a newListIterablecontaining the distinct elements in this list.<V> ListIterable<T>distinctBy(Function<? super T,? extends V> function)Returns a newListIterablecontaining the distinct elements in this list.ListIterable<T>drop(int count)Returns an iterable after skipping the firstcountelements or an empty iterable if thecountis greater than the length of the iterable.ListIterable<T>dropWhile(Predicate<? super T> predicate)Returns the final elements that do not satisfy the Predicate.booleanequals(Object o)Follows the same general contract asList.equals(Object).<V> ListIterable<V>flatCollect(Function<? super T,? extends Iterable<V>> function)flatCollectis a special case ofRichIterable.collect(Function).default <P, V> ListIterable<V>flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)default <T2> voidforEachInBoth(ListIterable<T2> other, Procedure2<? super T,? super T2> procedure)Iterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.Tget(int index)Returns the item at the specified position in this list iterable.TgetFirst()Returns the item at index 0 of the container.TgetLast()Returns the item at index (size() - 1) of the container.<V> ListMultimap<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> ListMultimap<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.inthashCode()Follows the same general contract asList.hashCode().intlastIndexOf(Object o)Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.ListIterator<T>listIterator()ListIterator<T>listIterator(int index)PartitionList<T>partition(Predicate<? super T> predicate)Filters a collection into a PartitionedIterable based on the evaluation of the predicate.PartitionList<T>partitionWhile(Predicate<? super T> predicate)Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.<P> PartitionList<T>partitionWith(Predicate2<? super T,? super P> predicate, P parameter)Filters a collection into a PartitionIterable based on the evaluation of the predicate.ListIterable<T>reject(Predicate<? super T> predicate)Returns all elements of the source collection that return false when evaluating of the predicate.<P> ListIterable<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.ListIterable<T>select(Predicate<? super T> predicate)Returns all elements of the source collection that return true when evaluating the predicate.<S> ListIterable<S>selectInstancesOf(Class<S> clazz)Returns all elements of the source collection that are instances of the Classclazz.<P> ListIterable<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.ListIterable<T>subList(int fromIndex, int toIndex)ListIterable<T>take(int count)Returns the firstcountelements of the iterable or all the elements in the iterable ifcountis greater than the length of the iterable.ListIterable<T>takeWhile(Predicate<? super T> predicate)Returns the initial elements that satisfy the Predicate.ListIterable<T>tap(Procedure<? super T> procedure)Executes the Procedure for each element in the iterable and returnsthis.ImmutableList<T>toImmutable()Converts the ListIterable to an immutable implementation.ListIterable<T>toReversed()Returns a new ReversibleIterable in reverse order.<S> ListIterable<Pair<T,S>>zip(Iterable<S> that)Returns aOrderedIterableformed from thisOrderedIterableand anotherIterableby combining corresponding elements in pairs.ListIterable<Pair<T,Integer>>zipWithIndex()Zips thisRichIterablewith its indices.Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterablecollectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, indexOf, max, min, toStack, zip, zipWithIndexMethods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterableasReversed, detectLastIndex, reverseForEach, reverseForEachWithIndexMethods inherited from interface org.eclipse.collections.api.RichIterableaggregateBy, 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, containsBy, count, countBy, countBy, countByEach, countByEach, countByWith, 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, 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, sumByDouble, sumByFloat, sumByInt, sumByLong, 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- 
getReturns the item at the specified position in this list iterable.
- 
lastIndexOfReturns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
- 
getFirstT getFirst()Returns the item at index 0 of the container. If the container is empty, null is returned. If null is a valid item of the container, then a developer will need to check to see if the container is empty first.- Specified by:
- getFirstin interface- OrderedIterable<T>
- Specified by:
- getFirstin interface- RichIterable<T>
 
- 
getLastT getLast()Returns the item at index (size() - 1) of the container. If the container is empty, null is returned. If null is a valid item of the container, then a developer will need to check to see if the container is empty first.- Specified by:
- getLastin interface- OrderedIterable<T>
- Specified by:
- getLastin interface- RichIterable<T>
 
- 
listIteratorListIterator<T> listIterator()- Since:
- 1.0.
- See Also:
- List.listIterator()
 
- 
listIterator- Since:
- 1.0.
- See Also:
- List.listIterator(int)
 
- 
toImmutableImmutableList<T> toImmutable()Converts the ListIterable to an immutable implementation. Returns this for immutable lists.- Since:
- 5.0
 
- 
tapDescription copied from interface:RichIterableExecutes 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:
- tapin interface- OrderedIterable<T>
- Specified by:
- tapin interface- ReversibleIterable<T>
- Specified by:
- tapin interface- RichIterable<T>
- See Also:
- RichIterable.each(Procedure),- RichIterable.forEach(Procedure)
 
- 
selectDescription copied from interface:RichIterableReturns 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:
- selectin interface- OrderedIterable<T>
- Specified by:
- selectin interface- ReversibleIterable<T>
- Specified by:
- selectin interface- RichIterable<T>
 
- 
selectWithDescription copied from interface:RichIterableSimilar toRichIterable.select(Predicate), except with an evaluation parameter for the second generic argument inPredicate2.E.g. return a Collectionof 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:
- selectWithin interface- OrderedIterable<T>
- Specified by:
- selectWithin interface- ReversibleIterable<T>
- Specified by:
- selectWithin interface- RichIterable<T>
- Parameters:
- predicate- a- Predicate2to use as the select criteria
- parameter- a parameter to pass in for evaluation of the second argument- Pin- predicate
- See Also:
- RichIterable.select(Predicate)
 
- 
rejectDescription copied from interface:RichIterableReturns 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:
- rejectin interface- OrderedIterable<T>
- Specified by:
- rejectin interface- ReversibleIterable<T>
- Specified by:
- rejectin interface- RichIterable<T>
- Parameters:
- predicate- a- Predicateto use as the reject criteria
- Returns:
- a RichIterable that contains elements that cause Predicate.accept(Object)method to evaluate to false
 
- 
rejectWithDescription copied from interface:RichIterableSimilar toRichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument inPredicate2.E.g. return a Collectionof 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:
- rejectWithin interface- OrderedIterable<T>
- Specified by:
- rejectWithin interface- ReversibleIterable<T>
- Specified by:
- rejectWithin interface- RichIterable<T>
- Parameters:
- predicate- a- Predicate2to use as the select criteria
- parameter- a parameter to pass in for evaluation of the second argument- Pin- predicate
- See Also:
- RichIterable.select(Predicate)
 
- 
partitionDescription copied from interface:RichIterableFilters 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:
- partitionin interface- OrderedIterable<T>
- Specified by:
- partitionin interface- ReversibleIterable<T>
- Specified by:
- partitionin interface- RichIterable<T>
 
- 
partitionWithDescription copied from interface:RichIterableFilters 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:
- partitionWithin interface- OrderedIterable<T>
- Specified by:
- partitionWithin interface- ReversibleIterable<T>
- Specified by:
- partitionWithin interface- RichIterable<T>
 
- 
selectInstancesOfDescription copied from interface:RichIterableReturns 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:
- selectInstancesOfin interface- OrderedIterable<T>
- Specified by:
- selectInstancesOfin interface- ReversibleIterable<T>
- Specified by:
- selectInstancesOfin interface- RichIterable<T>
 
- 
collectDescription copied from interface:RichIterableReturns 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:
- collectin interface- OrderedIterable<T>
- Specified by:
- collectin interface- ReversibleIterable<T>
- Specified by:
- collectin interface- RichIterable<T>
 
- 
collectWithIndexdefault <V> ListIterable<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)Description copied from interface:OrderedIterableReturns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.- Specified by:
- collectWithIndexin interface- OrderedIterable<T>
- Specified by:
- collectWithIndexin interface- ReversibleIterable<T>
- Since:
- 9.1.
 
- 
collectBooleanDescription copied from interface:RichIterableReturns a new primitivebooleaniterable 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:
- collectBooleanin interface- OrderedIterable<T>
- Specified by:
- collectBooleanin interface- ReversibleIterable<T>
- Specified by:
- collectBooleanin interface- RichIterable<T>
 
- 
collectByteDescription copied from interface:RichIterableReturns a new primitivebyteiterable 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:
- collectBytein interface- OrderedIterable<T>
- Specified by:
- collectBytein interface- ReversibleIterable<T>
- Specified by:
- collectBytein interface- RichIterable<T>
 
- 
collectCharDescription copied from interface:RichIterableReturns a new primitivechariterable 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:
- collectCharin interface- OrderedIterable<T>
- Specified by:
- collectCharin interface- ReversibleIterable<T>
- Specified by:
- collectCharin interface- RichIterable<T>
 
- 
collectDoubleDescription copied from interface:RichIterableReturns a new primitivedoubleiterable 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:
- collectDoublein interface- OrderedIterable<T>
- Specified by:
- collectDoublein interface- ReversibleIterable<T>
- Specified by:
- collectDoublein interface- RichIterable<T>
 
- 
collectFloatDescription copied from interface:RichIterableReturns a new primitivefloatiterable 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:
- collectFloatin interface- OrderedIterable<T>
- Specified by:
- collectFloatin interface- ReversibleIterable<T>
- Specified by:
- collectFloatin interface- RichIterable<T>
 
- 
collectIntDescription copied from interface:RichIterableReturns a new primitiveintiterable 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:
- collectIntin interface- OrderedIterable<T>
- Specified by:
- collectIntin interface- ReversibleIterable<T>
- Specified by:
- collectIntin interface- RichIterable<T>
 
- 
collectLongDescription copied from interface:RichIterableReturns a new primitivelongiterable 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:
- collectLongin interface- OrderedIterable<T>
- Specified by:
- collectLongin interface- ReversibleIterable<T>
- Specified by:
- collectLongin interface- RichIterable<T>
 
- 
collectShortDescription copied from interface:RichIterableReturns a new primitiveshortiterable 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:
- collectShortin interface- OrderedIterable<T>
- Specified by:
- collectShortin interface- ReversibleIterable<T>
- Specified by:
- collectShortin interface- RichIterable<T>
 
- 
collectWith<P, V> ListIterable<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)Description copied from interface:RichIterableSame asRichIterable.collect(Function)with aFunction2and 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:
- collectWithin interface- OrderedIterable<T>
- Specified by:
- collectWithin interface- ReversibleIterable<T>
- Specified by:
- collectWithin interface- RichIterable<T>
- Parameters:
- function- A- Function2to use as the collect transformation function
- parameter- A parameter to pass in for evaluation of the second argument- Pin- function
- Returns:
- A new RichIterablethat contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
- RichIterable.collect(Function)
 
- 
collectIf<V> ListIterable<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)Description copied from interface:RichIterableReturns 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:
- collectIfin interface- OrderedIterable<T>
- Specified by:
- collectIfin interface- ReversibleIterable<T>
- Specified by:
- collectIfin interface- RichIterable<T>
 
- 
flatCollectDescription copied from interface:RichIterableflatCollectis a special case ofRichIterable.collect(Function). Withcollect, when theFunctionreturns a collection, the result is a collection of collections.flatCollectoutputs a single "flattened" collection instead. This method is commonly called flatMap.Consider the following example where we have a Personclass, and eachPersonhas a list ofAddressobjects. Take the followingFunction:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...; Usingcollectreturns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction); UsingflatCollectreturns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction); - Specified by:
- flatCollectin interface- OrderedIterable<T>
- Specified by:
- flatCollectin interface- ReversibleIterable<T>
- Specified by:
- flatCollectin interface- RichIterable<T>
- Parameters:
- function- The- Functionto apply
- Returns:
- a new flattened collection produced by applying the given function
 
- 
flatCollectWithdefault <P, V> ListIterable<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)- Specified by:
- flatCollectWithin interface- OrderedIterable<T>
- Specified by:
- flatCollectWithin interface- ReversibleIterable<T>
- Specified by:
- flatCollectWithin interface- RichIterable<T>
- Since:
- 9.2
 
- 
groupByDescription copied from interface:RichIterableFor 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:
- groupByin interface- OrderedIterable<T>
- Specified by:
- groupByin interface- ReversibleIterable<T>
- Specified by:
- groupByin interface- RichIterable<T>
 
- 
groupByEachDescription copied from interface:RichIterableSimilar toRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.- Specified by:
- groupByEachin interface- OrderedIterable<T>
- Specified by:
- groupByEachin interface- ReversibleIterable<T>
- Specified by:
- groupByEachin interface- RichIterable<T>
 
- 
distinctListIterable<T> distinct()Returns a newListIterablecontaining 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:
- distinctin interface- OrderedIterable<T>
- Specified by:
- distinctin interface- ReversibleIterable<T>
- Returns:
- ListIterableof distinct elements
- Since:
- 3.0
 
- 
distinctReturns a newListIterablecontaining the distinct elements in this list. Takes a HashingStrategy.- Returns:
- ListIterableof distinct elements
- Since:
- 7.0
 
- 
distinctByReturns a newListIterablecontaining the distinct elements in this list. The specified function will be used to create a HashingStrategy to unique the elements.- Since:
- 9.0
- See Also:
- distinct(HashingStrategy)
 
- 
zipDescription copied from interface:OrderedIterableReturns aOrderedIterableformed from thisOrderedIterableand anotherIterableby combining corresponding elements in pairs. The secondIterableshould also be ordered. If one of the twoIterables is longer than the other, its remaining elements are ignored.- Specified by:
- zipin interface- OrderedIterable<T>
- Specified by:
- zipin interface- ReversibleIterable<T>
- Specified by:
- zipin interface- RichIterable<T>
- Type Parameters:
- S- the type of the second half of the returned pairs
- Parameters:
- that- The- Iterableproviding the second half of each result pair
- Returns:
- A new OrderedIterablecontaining pairs consisting of corresponding elements of thisOrderedIterableand that. The length of the returnedOrderedIterableis the minimum of the lengths of thisOrderedIterableand that.
 
- 
zipWithIndexListIterable<Pair<T,Integer>> zipWithIndex()Description copied from interface:RichIterableZips thisRichIterablewith its indices.- Specified by:
- zipWithIndexin interface- OrderedIterable<T>
- Specified by:
- zipWithIndexin interface- ReversibleIterable<T>
- Specified by:
- zipWithIndexin interface- RichIterable<T>
- Returns:
- A new RichIterablecontaining pairs consisting of all elements of thisRichIterablepaired with their index. Indices start at 0.
- See Also:
- RichIterable.zip(Iterable)
 
- 
takeDescription copied from interface:ReversibleIterableReturns the firstcountelements of the iterable or all the elements in the iterable ifcountis greater than the length of the iterable.- Specified by:
- takein interface- ReversibleIterable<T>
- Parameters:
- count- the number of items to take.
 
- 
takeWhileReturns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
- takeWhilein interface- OrderedIterable<T>
- Specified by:
- takeWhilein interface- ReversibleIterable<T>
- Since:
- 3.0
 
- 
dropDescription copied from interface:ReversibleIterableReturns an iterable after skipping the firstcountelements or an empty iterable if thecountis greater than the length of the iterable.- Specified by:
- dropin interface- ReversibleIterable<T>
- Parameters:
- count- the number of items to drop.
 
- 
dropWhileReturns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
- dropWhilein interface- OrderedIterable<T>
- Specified by:
- dropWhilein interface- ReversibleIterable<T>
- Since:
- 3.0
 
- 
partitionWhileReturns 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:
- partitionWhilein interface- OrderedIterable<T>
- Specified by:
- partitionWhilein interface- ReversibleIterable<T>
- Since:
- 3.0
 
- 
toReversedListIterable<T> toReversed()Description copied from interface:ReversibleIterableReturns a new ReversibleIterable in reverse order.- Specified by:
- toReversedin interface- ReversibleIterable<T>
 
- 
asParallelReturns a parallel iterable of this ListIterable.- Since:
- 6.0
 
- 
binarySearchSearches for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator.
- 
binarySearchSearches for the specified object using the binary search algorithm. The elements in this list must implement Comparable and the list must be sorted into ascending order.- See Also:
- Collections.binarySearch(List, Object)
 
- 
equalsFollows the same general contract asList.equals(Object).
- 
hashCodeint hashCode()Follows the same general contract asList.hashCode().
- 
subList- Since:
- 6.0
- See Also:
- List.subList(int, int)
 
- 
forEachInBothdefault <T2> void forEachInBoth(ListIterable<T2> other, Procedure2<? super T,? super T2> procedure)Iterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.- Since:
- 10.3
 
 
-