public Interface ListIterable<T>

Returns a parallel iterable of this ListIterable.

Annotations

@Beta

Since

6.0

Searches for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator.

See Also

Collections#binarySearch(List, Object, Comparator)

Searches 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)

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collect.

Doc from org.eclipse.collections.api.RichIterable.collect.

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());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectBoolean.

Doc from org.eclipse.collections.api.RichIterable.collectBoolean.

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

BooleanIterable licenses =
    people.collectBoolean(person -> person.hasDrivingLicense());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectByte.

Doc from org.eclipse.collections.api.RichIterable.collectByte.

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

ByteIterable bytes =
    people.collectByte(person -> person.getCode());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectChar.

Doc from org.eclipse.collections.api.RichIterable.collectChar.

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

CharIterable chars =
    people.collectChar(person -> person.getMiddleInitial());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectDouble.

Doc from org.eclipse.collections.api.RichIterable.collectDouble.

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

DoubleIterable doubles =
    people.collectDouble(person -> person.getMilesFromNorthPole());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectFloat.

Doc from org.eclipse.collections.api.RichIterable.collectFloat.

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

FloatIterable floats =
    people.collectFloat(person -> person.getHeightInInches());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectIf.

Doc from org.eclipse.collections.api.RichIterable.collectIf.

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 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());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectInt.

Doc from org.eclipse.collections.api.RichIterable.collectInt.

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

IntIterable ints =
    people.collectInt(person -> person.getAge());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectLong.

Doc from org.eclipse.collections.api.RichIterable.collectLong.

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

LongIterable longs =
    people.collectLong(person -> person.getGuid());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectShort.

Doc from org.eclipse.collections.api.RichIterable.collectShort.

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

ShortIterable shorts =
    people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.collectWith.

Doc from org.eclipse.collections.api.RichIterable.collectWith.

Same as 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));

Annotations

@Override

Overrides default org.eclipse.collections.api.ordered.ReversibleIterable.collectWithIndex.

Doc from org.eclipse.collections.api.ordered.OrderedIterable.collectWithIndex.

Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.

Annotations

@Override

Since

9.1.

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.distinct.

Returns a new ListIterable containing the distinct elements in this list.

Conceptually similar to toSet().toList() but retains the original order. If an element appears multiple times in this list, the first one will be copied into the result.

Returns:ListIterable<T>

ListIterable of distinct elements

Annotations

@Override

Since

3.0

Returns a new ListIterable containing the distinct elements in this list. Takes a HashingStrategy.

Returns:ListIterable<T>

ListIterable of distinct elements

Since

7.0

Returns a new ListIterable containing 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

ListIterable#distinct(HashingStrategy)

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.drop.

Doc from org.eclipse.collections.api.ordered.ReversibleIterable.drop.

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.dropWhile.

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Annotations

@Override

Since

3.0

Follows the same general contract as List#equals(Object).

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.flatCollect.

Doc from org.eclipse.collections.api.RichIterable.flatCollect.

flatCollect is a special case of 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 = ...;

RichIterable<List<Address>> addresses = people.collect(addressFunction);

RichIterable<Address> addresses = people.flatCollect(addressFunction);

Annotations

@Override

Overrides default org.eclipse.collections.api.ordered.ReversibleIterable.flatCollectWith.

Doc from org.eclipse.collections.api.RichIterable.flatCollectWith.

Same as flatCollect, only with a Function2 that is passed an extra parameter.

Annotations

@Override

Since

9.2

Iterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.

Since

10.3

Returns the item at the specified position in this list iterable.

Redeclares org.eclipse.collections.api.ordered.OrderedIterable.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.

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.OrderedIterable.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.

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.groupBy.

Doc from org.eclipse.collections.api.RichIterable.groupBy.

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);

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.groupByEach.

Doc from org.eclipse.collections.api.RichIterable.groupByEach.

Similar to groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Annotations

@Override

Follows the same general contract as List#hashCode().

Annotations

@Override

Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.

Since

1.0.

See Also

List#listIterator()

Since

1.0.

See Also

List#listIterator(int)

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.partition.

Doc from org.eclipse.collections.api.RichIterable.partition.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.partitionWhile.

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.

Annotations

@Override

Since

3.0

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.partitionWith.

Doc from org.eclipse.collections.api.RichIterable.partitionWith.

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");

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.reject.

Doc from org.eclipse.collections.api.RichIterable.reject.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.rejectWith.

Doc from org.eclipse.collections.api.RichIterable.rejectWith.

Similar to 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));

Annotations

@Override

Returns a new ListIterable with all elements of the collection that return false when evaluating the specified predicate which is supplied each element and its relative index.

Since

11.0

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.select.

Doc from org.eclipse.collections.api.RichIterable.select.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.selectInstancesOf.

Doc from org.eclipse.collections.api.RichIterable.selectInstancesOf.

Returns all elements of the source collection that are instances of the Class clazz.

RichIterable<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.selectWith.

Doc from org.eclipse.collections.api.RichIterable.selectWith.

Similar to 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));

Annotations

@Override

Returns a new ListIterable with all elements of the collection that return true when evaluating the specified predicate which is supplied each element and its relative index.

Since

11.0

Since

6.0

See Also

List#subList(int, int)

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.take.

Doc from org.eclipse.collections.api.ordered.ReversibleIterable.take.

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.

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.takeWhile.

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Annotations

@Override

Since

3.0

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.tap.

Doc from org.eclipse.collections.api.RichIterable.tap.

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Annotations

@Override

Converts the ListIterable to an immutable implementation. Returns this for immutable lists.

Since

5.0

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.toReversed.

Doc from org.eclipse.collections.api.ordered.ReversibleIterable.toReversed.

Returns a new ReversibleIterable in reverse order.

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.zip.

Doc from org.eclipse.collections.api.ordered.OrderedIterable.zip.

Returns a OrderedIterable formed from this OrderedIterable and another Iterable by combining corresponding elements in pairs. The second Iterable should also be ordered. If one of the two Iterables is longer than the other, its remaining elements are ignored.

Annotations

@Override

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.zipWithIndex.

Doc from org.eclipse.collections.api.RichIterable.zipWithIndex.

Zips this RichIterable with its indices.

Annotations

@Override