Eclipse Collections 13.0.0 · org.eclipse.collections.impl.bag.mutable.AbstractMutableBagIterable

Access	Constructor and Description
public	AbstractMutableBagIterable()

Method Summary

Modifier and Type	Method and Description
public boolean	addAll(Collection<? extends T> source) Implements java.util.Collection.addAll. Adds all of the elements in the specified collection to this collection (optional operation).
protected boolean	addAllBag(Bag<? extends T> source)
public boolean	addAllIterable(Iterable<? extends T> iterable) Implements org.eclipse.collections.api.collection.MutableCollection.addAllIterable.
public boolean	allSatisfy(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.allSatisfy. Implements org.eclipse.collections.api.RichIterable.allSatisfy. Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
public <P> boolean	allSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.allSatisfyWith. Implements org.eclipse.collections.api.RichIterable.allSatisfyWith. Returns true if the predicate evaluates to true for every element of the collection, or returns false.
public boolean	anySatisfy(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.anySatisfy. Implements org.eclipse.collections.api.RichIterable.anySatisfy. Returns true if the predicate evaluates to true for any element of the iterable.
public <P> boolean	anySatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.anySatisfyWith. Implements org.eclipse.collections.api.RichIterable.anySatisfyWith. Returns true if the predicate evaluates to true for any element of the collection, or return false.
public MutableList<ObjectIntPair<T>>	bottomOccurrences(int n) Implements org.eclipse.collections.api.bag.MutableBagIterable.bottomOccurrences, org.eclipse.collections.api.bag.Bag.bottomOccurrences. Returns the `count` least frequently occurring items.
public RichIterable<RichIterable<T>>	chunk(int size) Implements org.eclipse.collections.api.RichIterable.chunk. Partitions elements in fixed size chunks.
public <V> MutableBag<V>	countBy(Function<? super T, ? extends V> function) Overrides default org.eclipse.collections.api.RichIterable.countBy, org.eclipse.collections.api.collection.MutableCollection.countBy. This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
public <V> MutableBag<V>	countByEach(Function<? super T, ? extends Iterable<V>> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.countByEach. Overrides default org.eclipse.collections.api.RichIterable.countByEach, org.eclipse.collections.api.collection.MutableCollection.countByEach. This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
public <V, P> MutableBag<V>	countByWith(Function2<? super T, ? super P, ? extends V> function, P parameter) Overrides default org.eclipse.collections.api.RichIterable.countByWith, org.eclipse.collections.api.collection.MutableCollection.countByWith. This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
public T	detect(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.detect. Implements org.eclipse.collections.api.RichIterable.detect. Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
public T	detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function) Overrides default org.eclipse.collections.api.RichIterable.detectIfNone. Returns the first element of the iterable for which the predicate evaluates to true.
public Optional<T>	detectOptional(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectOptional. Implements org.eclipse.collections.api.RichIterable.detectOptional. Returns the first element of the iterable for which the predicate evaluates to true as an Optional.
public <P> T	detectWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWith. Implements org.eclipse.collections.api.RichIterable.detectWith. Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
public <P> T	detectWithIfNone(Predicate2<? super T, ? super P> predicate, P parameter, Function0<? extends T> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWithIfNone. Implements org.eclipse.collections.api.RichIterable.detectWithIfNone. Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
public <P> Optional<T>	detectWithOptional(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWithOptional. Implements org.eclipse.collections.api.RichIterable.detectWithOptional. Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.
public T	getFirst() Implements org.eclipse.collections.api.RichIterable.getFirst. Returns the first element of an iterable.
protected abstract RichIterable<T>	getKeysView()
public T	getLast() Implements org.eclipse.collections.api.RichIterable.getLast. Returns the last element of an iterable.
public <V> MutableMap<V, T>	groupByUniqueKey(Function<? super T, ? extends V> function) Overrides default org.eclipse.collections.api.collection.MutableCollection.groupByUniqueKey. Implements org.eclipse.collections.api.RichIterable.groupByUniqueKey. For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
public T	max() Overrides org.eclipse.collections.impl.AbstractRichIterable.max. Implements org.eclipse.collections.api.RichIterable.max. Returns the maximum element out of this container based on the natural order.
public T	max(Comparator<? super T> comparator) Overrides org.eclipse.collections.impl.AbstractRichIterable.max. Implements org.eclipse.collections.api.RichIterable.max. Returns the maximum element out of this container based on the comparator.
public <V extends Comparable<? super V>> T	maxBy(Function<? super T, ? extends V> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.maxBy. Implements org.eclipse.collections.api.RichIterable.maxBy. Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
public T	min() Overrides org.eclipse.collections.impl.AbstractRichIterable.min. Implements org.eclipse.collections.api.RichIterable.min. Returns the minimum element out of this container based on the natural order.
public T	min(Comparator<? super T> comparator) Overrides org.eclipse.collections.impl.AbstractRichIterable.min. Implements org.eclipse.collections.api.RichIterable.min. Returns the minimum element out of this container based on the comparator.
public <V extends Comparable<? super V>> T	minBy(Function<? super T, ? extends V> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.minBy. Implements org.eclipse.collections.api.RichIterable.minBy. Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
public boolean	noneSatisfy(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.noneSatisfy. Implements org.eclipse.collections.api.RichIterable.noneSatisfy. Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
public <P> boolean	noneSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.noneSatisfyWith. Implements org.eclipse.collections.api.RichIterable.noneSatisfyWith. Returns true if the predicate evaluates to false for every element of the collection, or return false.
public boolean	removeAll(Collection<?> collection) Implements java.util.Collection.removeAll. Removes all of this collection's elements that are also contained in the specified collection (optional operation).
public boolean	retainAll(Collection<?> collection) Implements java.util.Collection.retainAll. Retains only the elements in this collection that are contained in the specified collection (optional operation).
public boolean	retainAllIterable(Iterable<?> iterable) Implements org.eclipse.collections.api.collection.MutableCollection.retainAllIterable.
public <P> Twin<MutableList<T>>	selectAndRejectWith(Predicate2<? super T, ? super P> predicate, P parameter) Implements org.eclipse.collections.api.collection.MutableCollection.selectAndRejectWith. Filters a collection into two separate collections based on a predicate returned via a Pair.
public <V> MutableObjectDoubleMap<V>	sumByDouble(Function<? super T, ? extends V> groupBy, DoubleFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByDouble, org.eclipse.collections.api.collection.MutableCollection.sumByDouble. Groups and sums the values using the two specified functions.
public <V> MutableObjectDoubleMap<V>	sumByFloat(Function<? super T, ? extends V> groupBy, FloatFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByFloat, org.eclipse.collections.api.collection.MutableCollection.sumByFloat. Groups and sums the values using the two specified functions.
public <V> MutableObjectLongMap<V>	sumByInt(Function<? super T, ? extends V> groupBy, IntFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByInt, org.eclipse.collections.api.collection.MutableCollection.sumByInt. Groups and sums the values using the two specified functions.
public <V> MutableObjectLongMap<V>	sumByLong(Function<? super T, ? extends V> groupBy, LongFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByLong, org.eclipse.collections.api.collection.MutableCollection.sumByLong. Groups and sums the values using the two specified functions.
public MutableList<ObjectIntPair<T>>	topOccurrences(int n) Implements org.eclipse.collections.api.bag.MutableBagIterable.topOccurrences, org.eclipse.collections.api.bag.Bag.topOccurrences. Returns the `count` most frequently occurring items.

AbstractMutableBagIterable	back to summary
public AbstractMutableBagIterable()

Method Detail

addAll	back to summary
public boolean addAll(Collection<? extends T> source) Implements java.util.Collection.addAll. Doc from java.util.Collection.addAll. Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.) If the specified collection has a defined encounter order, processing of its elements generally occurs in that order. Annotations @Override

addAll

back to summary

public boolean addAll(Collection<? extends T> source)

Implements java.util.Collection.addAll.

Doc from java.util.Collection.addAll.

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.) If the specified collection has a defined encounter order, processing of its elements generally occurs in that order.

Annotations

@Override

addAllBag	back to summary
protected boolean addAllBag(Bag<? extends T> source)

addAllIterable	back to summary
public boolean addAllIterable(Iterable<? extends T> iterable) Implements org.eclipse.collections.api.collection.MutableCollection.addAllIterable. Annotations @Override

addAllIterable

back to summary

public boolean addAllIterable(Iterable<? extends T> iterable)

Implements org.eclipse.collections.api.collection.MutableCollection.addAllIterable.

Annotations

@Override

allSatisfy	back to summary
public boolean allSatisfy(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.allSatisfy. Implements org.eclipse.collections.api.RichIterable.allSatisfy. Doc from org.eclipse.collections.api.RichIterable.allSatisfy. Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false. Annotations @Override

allSatisfy

back to summary

public boolean allSatisfy(Predicate<? super T> predicate)

Overrides org.eclipse.collections.impl.AbstractRichIterable.allSatisfy.

Implements org.eclipse.collections.api.RichIterable.allSatisfy.

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

Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Annotations

@Override

allSatisfyWith	back to summary
public <P> boolean allSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.allSatisfyWith. Implements org.eclipse.collections.api.RichIterable.allSatisfyWith. Doc from org.eclipse.collections.api.RichIterable.allSatisfyWith. Returns true if the predicate evaluates to true for every element of the collection, or returns false. Annotations @Override

allSatisfyWith

back to summary

public boolean allSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter)

Overrides org.eclipse.collections.impl.AbstractRichIterable.allSatisfyWith.

Implements org.eclipse.collections.api.RichIterable.allSatisfyWith.

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

Returns true if the predicate evaluates to true for every element of the collection, or returns false.

Annotations

@Override

anySatisfy	back to summary
public boolean anySatisfy(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.anySatisfy. Implements org.eclipse.collections.api.RichIterable.anySatisfy. Doc from org.eclipse.collections.api.RichIterable.anySatisfy. Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate. Annotations @Override

anySatisfy

back to summary

public boolean anySatisfy(Predicate<? super T> predicate)

Overrides org.eclipse.collections.impl.AbstractRichIterable.anySatisfy.

Implements org.eclipse.collections.api.RichIterable.anySatisfy.

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

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.

Annotations

@Override

anySatisfyWith	back to summary
public <P> boolean anySatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.anySatisfyWith. Implements org.eclipse.collections.api.RichIterable.anySatisfyWith. Doc from org.eclipse.collections.api.RichIterable.anySatisfyWith. Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty. Annotations @Override

anySatisfyWith

back to summary

public boolean anySatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter)

Overrides org.eclipse.collections.impl.AbstractRichIterable.anySatisfyWith.

Implements org.eclipse.collections.api.RichIterable.anySatisfyWith.

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

Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.

Annotations

@Override

bottomOccurrences back to summary

bottomOccurrences	back to summary
public MutableList<ObjectIntPair<T>> bottomOccurrences(int n) Implements org.eclipse.collections.api.bag.MutableBagIterable.bottomOccurrences, org.eclipse.collections.api.bag.Bag.bottomOccurrences. Doc from org.eclipse.collections.api.bag.Bag.bottomOccurrences. Returns the `count` least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned. Annotations @Override

public MutableList<ObjectIntPair<T>> bottomOccurrences(int n)

Implements org.eclipse.collections.api.bag.MutableBagIterable.bottomOccurrences, org.eclipse.collections.api.bag.Bag.bottomOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.bottomOccurrences.

Returns the count least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Annotations

@Override

chunk	back to summary
public RichIterable<RichIterable<T>> chunk(int size) Implements org.eclipse.collections.api.RichIterable.chunk. Doc from org.eclipse.collections.api.RichIterable.chunk. Partitions elements in fixed size chunks. Annotations @Override

chunk

back to summary

public RichIterable<RichIterable<T>> chunk(int size)

Implements org.eclipse.collections.api.RichIterable.chunk.

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

Partitions elements in fixed size chunks.

Annotations

@Override

countBy	back to summary
public <V> MutableBag<V> countBy(Function<? super T, ? extends V> function) Overrides default org.eclipse.collections.api.RichIterable.countBy, org.eclipse.collections.api.collection.MutableCollection.countBy. Doc from org.eclipse.collections.api.RichIterable.countBy. This method will count the number of occurrences of each value calculated by applying the function to each element of the collection. Annotations @Override Since 9.0

countBy

back to summary

public <V> MutableBag<V> countBy(Function<? super T, ? extends V> function)

Overrides default org.eclipse.collections.api.RichIterable.countBy, org.eclipse.collections.api.collection.MutableCollection.countBy.

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

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Annotations

@Override

Since

9.0

countByEach	back to summary
public <V> MutableBag<V> countByEach(Function<? super T, ? extends Iterable<V>> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.countByEach. Overrides default org.eclipse.collections.api.RichIterable.countByEach, org.eclipse.collections.api.collection.MutableCollection.countByEach. Doc from org.eclipse.collections.api.RichIterable.countByEach. This method will count the number of occurrences of each value calculated by applying the function to each element of the collection. Annotations @Override Since 10.0.0

countByEach

back to summary

public <V> MutableBag<V> countByEach(Function<? super T, ? extends Iterable<V>> function)

Overrides org.eclipse.collections.impl.AbstractRichIterable.countByEach.

Overrides default org.eclipse.collections.api.RichIterable.countByEach, org.eclipse.collections.api.collection.MutableCollection.countByEach.

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

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Annotations

@Override

Since

10.0.0

countByWith	back to summary
public <V, P> MutableBag<V> countByWith(Function2<? super T, ? super P, ? extends V> function, P parameter) Overrides default org.eclipse.collections.api.RichIterable.countByWith, org.eclipse.collections.api.collection.MutableCollection.countByWith. Doc from org.eclipse.collections.api.RichIterable.countByWith. This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument. Annotations @Override Since 9.0

countByWith

back to summary

public <V, P> MutableBag<V> countByWith(Function2<? super T, ? super P, ? extends V> function, P parameter)

Overrides default org.eclipse.collections.api.RichIterable.countByWith, org.eclipse.collections.api.collection.MutableCollection.countByWith.

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

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.

Annotations

@Override

Since

9.0

detect	back to summary
public T detect(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.detect. Implements org.eclipse.collections.api.RichIterable.detect. Doc from org.eclipse.collections.api.RichIterable.detect. Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find. Example using a Java 8 lambda expression: Person person = people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith")); Annotations @Override

detect

back to summary

public T detect(Predicate<? super T> predicate)

Overrides org.eclipse.collections.impl.AbstractRichIterable.detect.

Implements org.eclipse.collections.api.RichIterable.detect.

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

Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

Example using a Java 8 lambda expression:

Person person =
    people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));

Annotations

@Override

detectIfNone	back to summary
public T detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function) Overrides default org.eclipse.collections.api.RichIterable.detectIfNone. Doc from org.eclipse.collections.api.RichIterable.detectIfNone. Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function. Annotations @Override

detectIfNone

back to summary

public T detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)

Overrides default org.eclipse.collections.api.RichIterable.detectIfNone.

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

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Annotations

@Override

detectOptional	back to summary
public Optional<T> detectOptional(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectOptional. Implements org.eclipse.collections.api.RichIterable.detectOptional. Doc from org.eclipse.collections.api.RichIterable.detectOptional. Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find. Example using a Java 8 lambda expression: Person person = people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith")); Annotations @Override

detectOptional

back to summary

public Optional<T> detectOptional(Predicate<? super T> predicate)

Overrides org.eclipse.collections.impl.AbstractRichIterable.detectOptional.

Implements org.eclipse.collections.api.RichIterable.detectOptional.

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

Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

Example using a Java 8 lambda expression:

Person person =
    people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));

Annotations

@Override

detectWith	back to summary
public <P> T detectWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWith. Implements org.eclipse.collections.api.RichIterable.detectWith. Doc from org.eclipse.collections.api.RichIterable.detectWith. Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true. Example using a Java 8 lambda expression: Person person = people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith"); Annotations @Override

detectWith

back to summary

public T detectWith(Predicate2<? super T, ? super P> predicate, P parameter)

Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWith.

Implements org.eclipse.collections.api.RichIterable.detectWith.

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

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

Example using a Java 8 lambda expression:

Person person =
    people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");

Annotations

@Override

detectWithIfNone	back to summary
public <P> T detectWithIfNone(Predicate2<? super T, ? super P> predicate, P parameter, Function0<? extends T> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWithIfNone. Implements org.eclipse.collections.api.RichIterable.detectWithIfNone. Doc from org.eclipse.collections.api.RichIterable.detectWithIfNone. Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function. Annotations @Override

detectWithIfNone

back to summary

public T detectWithIfNone(Predicate2<? super T, ? super P> predicate, P parameter, Function0<? extends T> function)

Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWithIfNone.

Implements org.eclipse.collections.api.RichIterable.detectWithIfNone.

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

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.

Annotations

@Override

detectWithOptional	back to summary
public <P> Optional<T> detectWithOptional(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWithOptional. Implements org.eclipse.collections.api.RichIterable.detectWithOptional. Doc from org.eclipse.collections.api.RichIterable.detectWithOptional. Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional. Example using a Java 8 lambda expression: Optional<Person> person = people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith"); Annotations @Override

detectWithOptional

back to summary

public Optional<T> detectWithOptional(Predicate2<? super T, ? super P> predicate, P parameter)

Overrides org.eclipse.collections.impl.AbstractRichIterable.detectWithOptional.

Implements org.eclipse.collections.api.RichIterable.detectWithOptional.

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

Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

Example using a Java 8 lambda expression:

Optional<Person> person =
    people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");

Annotations

@Override

getFirst	back to summary
public T getFirst() Implements org.eclipse.collections.api.RichIterable.getFirst. Doc from org.eclipse.collections.api.RichIterable.getFirst. Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty. The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set. Annotations @Override

getFirst

back to summary

public T getFirst()

Implements org.eclipse.collections.api.RichIterable.getFirst.

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

Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Annotations

@Override

getKeysView	back to summary
protected abstract RichIterable<T> getKeysView()

getLast	back to summary
public T getLast() Implements org.eclipse.collections.api.RichIterable.getLast. Doc from org.eclipse.collections.api.RichIterable.getLast. Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty. The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set. Annotations @Override

getLast

back to summary

public T getLast()

Implements org.eclipse.collections.api.RichIterable.getLast.

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

Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Annotations

@Override

groupByUniqueKey	back to summary
public <V> MutableMap<V, T> groupByUniqueKey(Function<? super T, ? extends V> function) Overrides default org.eclipse.collections.api.collection.MutableCollection.groupByUniqueKey. Implements org.eclipse.collections.api.RichIterable.groupByUniqueKey. Doc from org.eclipse.collections.api.RichIterable.groupByUniqueKey. For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown. Annotations @Override

groupByUniqueKey

back to summary

public <V> MutableMap<V, T> groupByUniqueKey(Function<? super T, ? extends V> function)

Overrides default org.eclipse.collections.api.collection.MutableCollection.groupByUniqueKey.

Implements org.eclipse.collections.api.RichIterable.groupByUniqueKey.

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

For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Annotations

@Override

max	back to summary
public T max() Overrides org.eclipse.collections.impl.AbstractRichIterable.max. Implements org.eclipse.collections.api.RichIterable.max. Doc from org.eclipse.collections.api.RichIterable.max. Returns the maximum element out of this container based on the natural order. Annotations @Override

max

back to summary

public T max()

Overrides org.eclipse.collections.impl.AbstractRichIterable.max.

Implements org.eclipse.collections.api.RichIterable.max.

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

Returns the maximum element out of this container based on the natural order.

Annotations

@Override

max	back to summary
public T max(Comparator<? super T> comparator) Overrides org.eclipse.collections.impl.AbstractRichIterable.max. Implements org.eclipse.collections.api.RichIterable.max. Doc from org.eclipse.collections.api.RichIterable.max. Returns the maximum element out of this container based on the comparator. Annotations @Override

max

back to summary

public T max(Comparator<? super T> comparator)

Overrides org.eclipse.collections.impl.AbstractRichIterable.max.

Implements org.eclipse.collections.api.RichIterable.max.

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

Returns the maximum element out of this container based on the comparator.

Annotations

@Override

maxBy	back to summary
public <V extends Comparable<? super V>> T maxBy(Function<? super T, ? extends V> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.maxBy. Implements org.eclipse.collections.api.RichIterable.maxBy. Doc from org.eclipse.collections.api.RichIterable.maxBy. Returns the maximum elements out of this container based on the natural order of the attribute returned by Function. Annotations @Override

maxBy

back to summary

public <V extends Comparable<? super V>> T maxBy(Function<? super T, ? extends V> function)

Overrides org.eclipse.collections.impl.AbstractRichIterable.maxBy.

Implements org.eclipse.collections.api.RichIterable.maxBy.

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

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Annotations

@Override

min	back to summary
public T min() Overrides org.eclipse.collections.impl.AbstractRichIterable.min. Implements org.eclipse.collections.api.RichIterable.min. Doc from org.eclipse.collections.api.RichIterable.min. Returns the minimum element out of this container based on the natural order. Annotations @Override

min

back to summary

public T min()

Overrides org.eclipse.collections.impl.AbstractRichIterable.min.

Implements org.eclipse.collections.api.RichIterable.min.

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

Returns the minimum element out of this container based on the natural order.

Annotations

@Override

min	back to summary
public T min(Comparator<? super T> comparator) Overrides org.eclipse.collections.impl.AbstractRichIterable.min. Implements org.eclipse.collections.api.RichIterable.min. Doc from org.eclipse.collections.api.RichIterable.min. Returns the minimum element out of this container based on the comparator. Annotations @Override

min

back to summary

public T min(Comparator<? super T> comparator)

Overrides org.eclipse.collections.impl.AbstractRichIterable.min.

Implements org.eclipse.collections.api.RichIterable.min.

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

Returns the minimum element out of this container based on the comparator.

Annotations

@Override

minBy	back to summary
public <V extends Comparable<? super V>> T minBy(Function<? super T, ? extends V> function) Overrides org.eclipse.collections.impl.AbstractRichIterable.minBy. Implements org.eclipse.collections.api.RichIterable.minBy. Doc from org.eclipse.collections.api.RichIterable.minBy. Returns the minimum elements out of this container based on the natural order of the attribute returned by Function. Annotations @Override

minBy

back to summary

public <V extends Comparable<? super V>> T minBy(Function<? super T, ? extends V> function)

Overrides org.eclipse.collections.impl.AbstractRichIterable.minBy.

Implements org.eclipse.collections.api.RichIterable.minBy.

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

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Annotations

@Override

noneSatisfy	back to summary
public boolean noneSatisfy(Predicate<? super T> predicate) Overrides org.eclipse.collections.impl.AbstractRichIterable.noneSatisfy. Implements org.eclipse.collections.api.RichIterable.noneSatisfy. Doc from org.eclipse.collections.api.RichIterable.noneSatisfy. Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false. Annotations @Override

noneSatisfy

back to summary

public boolean noneSatisfy(Predicate<? super T> predicate)

Overrides org.eclipse.collections.impl.AbstractRichIterable.noneSatisfy.

Implements org.eclipse.collections.api.RichIterable.noneSatisfy.

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

Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Annotations

@Override

noneSatisfyWith	back to summary
public <P> boolean noneSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter) Overrides org.eclipse.collections.impl.AbstractRichIterable.noneSatisfyWith. Implements org.eclipse.collections.api.RichIterable.noneSatisfyWith. Doc from org.eclipse.collections.api.RichIterable.noneSatisfyWith. Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty. Annotations @Override

noneSatisfyWith

back to summary

public boolean noneSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter)

Overrides org.eclipse.collections.impl.AbstractRichIterable.noneSatisfyWith.

Implements org.eclipse.collections.api.RichIterable.noneSatisfyWith.

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

Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.

Annotations

@Override

removeAll	back to summary
public boolean removeAll(Collection<?> collection) Implements java.util.Collection.removeAll. Doc from java.util.Collection.removeAll. Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection. Annotations @Override

removeAll

back to summary

public boolean removeAll(Collection<?> collection)

Implements java.util.Collection.removeAll.

Doc from java.util.Collection.removeAll.

Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Annotations

@Override

retainAll	back to summary
public boolean retainAll(Collection<?> collection) Implements java.util.Collection.retainAll. Doc from java.util.Collection.retainAll. Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection. Annotations @Override

retainAll

back to summary

public boolean retainAll(Collection<?> collection)

Implements java.util.Collection.retainAll.

Doc from java.util.Collection.retainAll.

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Annotations

@Override

retainAllIterable	back to summary
public boolean retainAllIterable(Iterable<?> iterable) Implements org.eclipse.collections.api.collection.MutableCollection.retainAllIterable. Annotations @Override

retainAllIterable

back to summary

public boolean retainAllIterable(Iterable<?> iterable)

Implements org.eclipse.collections.api.collection.MutableCollection.retainAllIterable.

Annotations

@Override

selectAndRejectWith	back to summary
public <P> Twin<MutableList<T>> selectAndRejectWith(Predicate2<? super T, ? super P> predicate, P parameter) Implements org.eclipse.collections.api.collection.MutableCollection.selectAndRejectWith. Doc from org.eclipse.collections.api.collection.MutableCollection.selectAndRejectWith. Filters a collection into two separate collections based on a predicate returned via a Pair. e.g. return lastNames.selectAndRejectWith(Predicates2.lessThan(), "Mason"); Annotations @Override

selectAndRejectWith

back to summary

public Twin<MutableList<T>> selectAndRejectWith(Predicate2<? super T, ? super P> predicate, P parameter)

Implements org.eclipse.collections.api.collection.MutableCollection.selectAndRejectWith.

Doc from org.eclipse.collections.api.collection.MutableCollection.selectAndRejectWith.

Filters a collection into two separate collections based on a predicate returned via a Pair.

e.g.
return lastNames.selectAndRejectWith(Predicates2.lessThan(), "Mason");

Annotations

@Override

sumByDouble	back to summary
public <V> MutableObjectDoubleMap<V> sumByDouble(Function<? super T, ? extends V> groupBy, DoubleFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByDouble, org.eclipse.collections.api.collection.MutableCollection.sumByDouble. Doc from org.eclipse.collections.api.RichIterable.sumByDouble. Groups and sums the values using the two specified functions. Annotations @Override

sumByDouble

back to summary

public <V> MutableObjectDoubleMap<V> sumByDouble(Function<? super T, ? extends V> groupBy, DoubleFunction<? super T> function)

Implements org.eclipse.collections.api.RichIterable.sumByDouble, org.eclipse.collections.api.collection.MutableCollection.sumByDouble.

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

Groups and sums the values using the two specified functions.

Annotations

@Override

sumByFloat	back to summary
public <V> MutableObjectDoubleMap<V> sumByFloat(Function<? super T, ? extends V> groupBy, FloatFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByFloat, org.eclipse.collections.api.collection.MutableCollection.sumByFloat. Doc from org.eclipse.collections.api.RichIterable.sumByFloat. Groups and sums the values using the two specified functions. Annotations @Override

sumByFloat

back to summary

public <V> MutableObjectDoubleMap<V> sumByFloat(Function<? super T, ? extends V> groupBy, FloatFunction<? super T> function)

Implements org.eclipse.collections.api.RichIterable.sumByFloat, org.eclipse.collections.api.collection.MutableCollection.sumByFloat.

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

Groups and sums the values using the two specified functions.

Annotations

@Override

sumByInt	back to summary
public <V> MutableObjectLongMap<V> sumByInt(Function<? super T, ? extends V> groupBy, IntFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByInt, org.eclipse.collections.api.collection.MutableCollection.sumByInt. Doc from org.eclipse.collections.api.RichIterable.sumByInt. Groups and sums the values using the two specified functions. Annotations @Override

sumByInt

back to summary

public <V> MutableObjectLongMap<V> sumByInt(Function<? super T, ? extends V> groupBy, IntFunction<? super T> function)

Implements org.eclipse.collections.api.RichIterable.sumByInt, org.eclipse.collections.api.collection.MutableCollection.sumByInt.

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

Groups and sums the values using the two specified functions.

Annotations

@Override

sumByLong	back to summary
public <V> MutableObjectLongMap<V> sumByLong(Function<? super T, ? extends V> groupBy, LongFunction<? super T> function) Implements org.eclipse.collections.api.RichIterable.sumByLong, org.eclipse.collections.api.collection.MutableCollection.sumByLong. Doc from org.eclipse.collections.api.RichIterable.sumByLong. Groups and sums the values using the two specified functions. Annotations @Override

sumByLong

back to summary

public <V> MutableObjectLongMap<V> sumByLong(Function<? super T, ? extends V> groupBy, LongFunction<? super T> function)

Implements org.eclipse.collections.api.RichIterable.sumByLong, org.eclipse.collections.api.collection.MutableCollection.sumByLong.

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

Groups and sums the values using the two specified functions.

Annotations

@Override

topOccurrences back to summary

topOccurrences	back to summary
public MutableList<ObjectIntPair<T>> topOccurrences(int n) Implements org.eclipse.collections.api.bag.MutableBagIterable.topOccurrences, org.eclipse.collections.api.bag.Bag.topOccurrences. Doc from org.eclipse.collections.api.bag.Bag.topOccurrences. Returns the `count` most frequently occurring items. In the event of a tie, all the items with the number of occurrences that match the occurrences of the last item will be returned. Annotations @Override

public MutableList<ObjectIntPair<T>> topOccurrences(int n)

Implements org.eclipse.collections.api.bag.MutableBagIterable.topOccurrences, org.eclipse.collections.api.bag.Bag.topOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.topOccurrences.

Returns the count most frequently occurring items. In the event of a tie, all the items with the number of occurrences that match the occurrences of the last item will be returned.

Annotations

@Override

public abstract Class AbstractMutableBagIterable<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail