Package org.eclipse.collections.impl

Class AbstractRichIterable<T>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<T>

All Implemented Interfaces:

Iterable<T>, InternalIterable<T>, RichIterable<T>

Direct Known Subclasses:

AbstractBag, AbstractImmutableCollection, AbstractLazyIterable, AbstractMapIterable, AbstractMutableCollection

public abstract class AbstractRichIterable<T>
extends Object
implements RichIterable<T>

Constructor Summary

Constructors

Constructor	Description
AbstractRichIterable()

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfy(Predicate<? super T> predicate)
<P> boolean	allSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
boolean	anySatisfy(Predicate<? super T> predicate)
<P> boolean	anySatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
void	appendString(Appendable appendable, String separator)
void	appendString(Appendable appendable, String start, String separator, String end)
LazyIterable<T>	asLazy()
<V,R extends Collection<V>> R	collect(Function<? super T,? extends V> function, R target)
<V,R extends Collection<V>> R	collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function, R target)
<P,V,R extends Collection<V>> R	collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R target)
boolean	contains(Object object)
boolean	containsAll(Collection<?> collection)
boolean	containsAllArguments(Object... elements)
boolean	containsAllIterable(Iterable<?> source)
int	count(Predicate<? super T> predicate)
<V> Bag<V>	countByEach(Function<? super T,? extends Iterable<V>> function)
<P> int	countWith(Predicate2<? super T,? super P> predicate, P parameter)
T	detect(Predicate<? super T> predicate)
Optional<T>	detectOptional(Predicate<? super T> predicate)
<P> T	detectWith(Predicate2<? super T,? super P> predicate, P parameter)
<P> T	detectWithIfNone(Predicate2<? super T,? super P> predicate, P parameter, Function0<? extends T> function)
<P> Optional<T>	detectWithOptional(Predicate2<? super T,? super P> predicate, P parameter)
<V,R extends Collection<V>> R	flatCollect(Function<? super T,? extends Iterable<V>> function, R target)
void	forEach(Procedure<? super T> procedure)
<P> void	forEachWith(Procedure2<? super T,? super P> procedure, P parameter)
void	forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
<V,R extends MutableMultimap<V,T>> R	groupBy(Function<? super T,? extends V> function, R target)
<V,R extends MutableMultimap<V,T>> R	groupByEach(Function<? super T,? extends Iterable<V>> function, R target)
<V,R extends MutableMapIterable<V,T>> R	groupByUniqueKey(Function<? super T,? extends V> function, R target)
double	injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super T> function)
float	injectInto(float injectedValue, FloatObjectToFloatFunction<? super T> function)
int	injectInto(int injectedValue, IntObjectToIntFunction<? super T> function)
long	injectInto(long injectedValue, LongObjectToLongFunction<? super T> function)
<IV> IV	injectInto(IV injectedValue, Function2<? super IV,? super T,? extends IV> function)
<R extends Collection<T>> R	into(R target)
boolean	isEmpty()
T	max()
T	max(Comparator<? super T> comparator)
<V extends Comparable<? super V>> T	maxBy(Function<? super T,? extends V> function)
T	min()
T	min(Comparator<? super T> comparator)
<V extends Comparable<? super V>> T	minBy(Function<? super T,? extends V> function)
boolean	noneSatisfy(Predicate<? super T> predicate)
<P> boolean	noneSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
<R extends Collection<T>> R	reject(Predicate<? super T> predicate, R target)
<P,R extends Collection<T>> R	rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
<R extends Collection<T>> R	select(Predicate<? super T> predicate, R target)
<P,R extends Collection<T>> R	selectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
double	sumOfDouble(DoubleFunction<? super T> function)
double	sumOfFloat(FloatFunction<? super T> function)
long	sumOfInt(IntFunction<? super T> function)
long	sumOfLong(LongFunction<? super T> function)
Object[]	toArray()
<E> E[]	toArray(E[] array)
MutableBag<T>	toBag()
<K,V> MutableBiMap<K,V>	toBiMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
MutableList<T>	toList()
<K,V> MutableMap<K,V>	toMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
MutableSet<T>	toSet()
MutableSortedBag<T>	toSortedBag()
MutableSortedBag<T>	toSortedBag(Comparator<? super T> comparator)
<V extends Comparable<? super V>> MutableSortedBag<T>	toSortedBagBy(Function<? super T,? extends V> function)
<V extends Comparable<? super V>> MutableList<T>	toSortedListBy(Function<? super T,? extends V> function)
<K,V> MutableSortedMap<K,V>	toSortedMap(Comparator<? super K> comparator, Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
<K,V> MutableSortedMap<K,V>	toSortedMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
<KK extends Comparable<? super KK>,NK,NV> MutableSortedMap<NK,NV>	toSortedMapBy(Function<? super NK,KK> sortBy, Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
MutableSortedSet<T>	toSortedSet()
MutableSortedSet<T>	toSortedSet(Comparator<? super T> comparator)
<V extends Comparable<? super V>> MutableSortedSet<T>	toSortedSetBy(Function<? super T,? extends V> function)
String	toString()	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
<S,R extends Collection<Pair<T,S>>> R	zip(Iterable<S> that, R target)
<R extends Collection<Pair<T,Integer>>> R	zipWithIndex(R target)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach

Methods inherited from interface java.lang.Iterable

iterator, spliterator

Methods inherited from interface org.eclipse.collections.api.RichIterable

aggregateBy, aggregateBy, aggregateInPlaceBy, appendString, chunk, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countBy, countByEach, countByWith, countByWith, detectIfNone, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, flatCollectWith, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, makeString, makeString, makeString, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, notEmpty, partition, partitionWith, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectInstancesOf, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, tap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toMap, toSortedList, toSortedList, zip, zipWithIndex

Constructor Detail

AbstractRichIterable

public AbstractRichIterable()

Method Detail

contains

public boolean contains(Object object)

Specified by:

contains in interface RichIterable<T>

containsAllIterable

public boolean containsAllIterable(Iterable<?> source)

Specified by:

containsAllIterable in interface RichIterable<T>

containsAllArguments

public boolean containsAllArguments(Object... elements)

Specified by:

containsAllArguments in interface RichIterable<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface RichIterable<T>

toArray

public <E> E[] toArray(E[] array)

Specified by:

toArray in interface RichIterable<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface RichIterable<T>

toList

public MutableList<T> toList()

Specified by:

toList in interface RichIterable<T>

toSortedListBy

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

Specified by:

toSortedListBy in interface RichIterable<T>

toSortedSet

public MutableSortedSet<T> toSortedSet()

Specified by:

toSortedSet in interface RichIterable<T>

toSortedSet

public MutableSortedSet<T> toSortedSet(Comparator<? super T> comparator)

Specified by:

toSortedSet in interface RichIterable<T>

toSortedSetBy

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

Specified by:

toSortedSetBy in interface RichIterable<T>

toSet

public MutableSet<T> toSet()

Specified by:

toSet in interface RichIterable<T>

toBag

public MutableBag<T> toBag()

Specified by:

toBag in interface RichIterable<T>

toSortedBag

public MutableSortedBag<T> toSortedBag()

Specified by:

toSortedBag in interface RichIterable<T>

toSortedBag

public MutableSortedBag<T> toSortedBag(Comparator<? super T> comparator)

Specified by:

toSortedBag in interface RichIterable<T>

toSortedBagBy

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

Specified by:

toSortedBagBy in interface RichIterable<T>

toMap

public <K,V> MutableMap<K,V> toMap(Function<? super T,? extends K> keyFunction,
                                               Function<? super T,? extends V> valueFunction)

Specified by:

toMap in interface RichIterable<T>

toSortedMap

public <K,V> MutableSortedMap<K,V> toSortedMap(Function<? super T,? extends K> keyFunction,
                                                           Function<? super T,? extends V> valueFunction)

Specified by:

toSortedMap in interface RichIterable<T>

toSortedMap

public <K,V> MutableSortedMap<K,V> toSortedMap(Comparator<? super K> comparator,
                                                           Function<? super T,? extends K> keyFunction,
                                                           Function<? super T,? extends V> valueFunction)

Specified by:

toSortedMap in interface RichIterable<T>

toSortedMapBy

public <KK extends Comparable<? super KK>,NK,NV> MutableSortedMap<NK,NV> toSortedMapBy(Function<? super NK,KK> sortBy,
                                                                                                         Function<? super T,? extends NK> keyFunction,
                                                                                                         Function<? super T,? extends NV> valueFunction)

Specified by:

toSortedMapBy in interface RichIterable<T>

toBiMap

public <K,V> MutableBiMap<K,V> toBiMap(Function<? super T,? extends K> keyFunction,
                                                   Function<? super T,? extends V> valueFunction)

Specified by:

toBiMap in interface RichIterable<T>

select

public <R extends Collection<T>> R select(Predicate<? super T> predicate,
                                          R target)

Specified by:

select in interface RichIterable<T>

selectWith

public <P,R extends Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate,
                                                      P parameter,
                                                      R target)

Specified by:

selectWith in interface RichIterable<T>

reject

public <R extends Collection<T>> R reject(Predicate<? super T> predicate,
                                          R target)

Specified by:

reject in interface RichIterable<T>

rejectWith

public <P,R extends Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate,
                                                      P parameter,
                                                      R target)

Specified by:

rejectWith in interface RichIterable<T>

collect

public <V,R extends Collection<V>> R collect(Function<? super T,? extends V> function,
                                                   R target)

Specified by:

collect in interface RichIterable<T>

collectWith

public <P,V,R extends Collection<V>> R collectWith(Function2<? super T,? super P,? extends V> function,
                                                               P parameter,
                                                               R target)

Specified by:

collectWith in interface RichIterable<T>

collectIf

public <V,R extends Collection<V>> R collectIf(Predicate<? super T> predicate,
                                                     Function<? super T,? extends V> function,
                                                     R target)

Specified by:

collectIf in interface RichIterable<T>

detectWithIfNone

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

Specified by:

detectWithIfNone in interface RichIterable<T>

min

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

Specified by:

min in interface RichIterable<T>

max

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

Specified by:

max in interface RichIterable<T>

min

public T min()

Specified by:

min in interface RichIterable<T>

max

public T max()

Specified by:

max in interface RichIterable<T>

minBy

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

Specified by:

minBy in interface RichIterable<T>

maxBy

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

Specified by:

maxBy in interface RichIterable<T>

asLazy

public LazyIterable<T> asLazy()

Specified by:

asLazy in interface RichIterable<T>

flatCollect

public <V,R extends Collection<V>> R flatCollect(Function<? super T,? extends Iterable<V>> function,
                                                       R target)

Specified by:

flatCollect in interface RichIterable<T>

detect

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

Specified by:

detect in interface RichIterable<T>

detectWith

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

Specified by:

detectWith in interface RichIterable<T>

detectOptional

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

Specified by:

detectOptional in interface RichIterable<T>

detectWithOptional

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

Specified by:

detectWithOptional in interface RichIterable<T>

anySatisfy

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

Specified by:

anySatisfy in interface RichIterable<T>

allSatisfy

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

Specified by:

allSatisfy in interface RichIterable<T>

noneSatisfy

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

Specified by:

noneSatisfy in interface RichIterable<T>

anySatisfyWith

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

Specified by:

anySatisfyWith in interface RichIterable<T>

allSatisfyWith

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

Specified by:

allSatisfyWith in interface RichIterable<T>

noneSatisfyWith

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

Specified by:

noneSatisfyWith in interface RichIterable<T>

count

public int count(Predicate<? super T> predicate)

Specified by:

count in interface RichIterable<T>

countWith

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

Specified by:

countWith in interface RichIterable<T>

injectInto

public <IV> IV injectInto(IV injectedValue,
                          Function2<? super IV,? super T,? extends IV> function)

Specified by:

injectInto in interface RichIterable<T>

injectInto

public int injectInto(int injectedValue,
                      IntObjectToIntFunction<? super T> function)

Specified by:

injectInto in interface RichIterable<T>

injectInto

public long injectInto(long injectedValue,
                       LongObjectToLongFunction<? super T> function)

Specified by:

injectInto in interface RichIterable<T>

injectInto

public double injectInto(double injectedValue,
                         DoubleObjectToDoubleFunction<? super T> function)

Specified by:

injectInto in interface RichIterable<T>

into

public <R extends Collection<T>> R into(R target)

Specified by:

into in interface RichIterable<T>

injectInto

public float injectInto(float injectedValue,
                        FloatObjectToFloatFunction<? super T> function)

Specified by:

injectInto in interface RichIterable<T>

sumOfInt

public long sumOfInt(IntFunction<? super T> function)

Specified by:

sumOfInt in interface RichIterable<T>

sumOfFloat

public double sumOfFloat(FloatFunction<? super T> function)

Specified by:

sumOfFloat in interface RichIterable<T>

sumOfLong

public long sumOfLong(LongFunction<? super T> function)

Specified by:

sumOfLong in interface RichIterable<T>

sumOfDouble

public double sumOfDouble(DoubleFunction<? super T> function)

Specified by:

sumOfDouble in interface RichIterable<T>

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)

Specified by:

forEachWithIndex in interface InternalIterable<T>

forEach

public final void forEach(Procedure<? super T> procedure)

Specified by:

forEach in interface InternalIterable<T>

Specified by:

forEach in interface RichIterable<T>

forEachWith

public <P> void forEachWith(Procedure2<? super T,? super P> procedure,
                            P parameter)

Specified by:

forEachWith in interface InternalIterable<T>

zip

public <S,R extends Collection<Pair<T,S>>> R zip(Iterable<S> that,
                                                             R target)

Specified by:

zip in interface RichIterable<T>

zipWithIndex

public <R extends Collection<Pair<T,Integer>>> R zipWithIndex(R target)

Specified by:

zipWithIndex in interface RichIterable<T>

toString

public String toString()

Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.

 Assert.assertEquals("[]", Lists.mutable.empty().toString());
 Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());
 

Specified by:

toString in interface RichIterable<T>

Overrides:

toString in class Object

Returns:

a string representation of this collection.

See Also:

AbstractCollection.toString()

appendString

public void appendString(Appendable appendable,
                         String separator)

Specified by:

appendString in interface RichIterable<T>

appendString

public void appendString(Appendable appendable,
                         String start,
                         String separator,
                         String end)

Specified by:

appendString in interface RichIterable<T>

containsAll

public boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface RichIterable<T>

countByEach

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

Specified by:

countByEach in interface RichIterable<T>

Since:

10.0.0

groupBy

public <V,R extends MutableMultimap<V,T>> R groupBy(Function<? super T,? extends V> function,
                                                                R target)

Specified by:

groupBy in interface RichIterable<T>

groupByEach

public <V,R extends MutableMultimap<V,T>> R groupByEach(Function<? super T,? extends Iterable<V>> function,
                                                                    R target)

Specified by:

groupByEach in interface RichIterable<T>

groupByUniqueKey

public <V,R extends MutableMapIterable<V,T>> R groupByUniqueKey(Function<? super T,? extends V> function,
                                                                            R target)

Specified by:

groupByUniqueKey in interface RichIterable<T>