Class MultiReaderFastList<T>
- java.lang.Object
-
- org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection<T>
-
- org.eclipse.collections.impl.list.mutable.MultiReaderFastList<T>
-
- All Implemented Interfaces:
java.io.Externalizable,java.io.Serializable,java.lang.Cloneable,java.lang.Iterable<T>,java.util.Collection<T>,java.util.List<T>,java.util.RandomAccess,MutableCollection<T>,InternalIterable<T>,ListIterable<T>,MultiReaderList<T>,MutableList<T>,OrderedIterable<T>,ReversibleIterable<T>,RichIterable<T>
public final class MultiReaderFastList<T> extends AbstractMultiReaderMutableCollection<T> implements java.util.RandomAccess, java.io.Externalizable, MultiReaderList<T>
MultiReadFastList provides a thread-safe wrapper around a FastList, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderFastList does not implementiterator(),listIterator(),listIterator(int), orget(int), as all these methods require an external lock to be taken to provide thread-safe iteration. All of these methods are available however, if you use thewithReadLockAndDelegate()orwithWriteLockAndDelegate()methods. Both of these methods take a parameter of typeProcedure<MutableList>, and a wrapped version of the underlying FastList is returned. This wrapper guarantees that no external pointer can ever reference the underlying FastList outside a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static classMultiReaderFastList.UntouchableListIterator<T>(package private) static classMultiReaderFastList.UntouchableMutableList<T>-
Nested classes/interfaces inherited from class org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection
AbstractMultiReaderMutableCollection.LockWrapper, AbstractMultiReaderMutableCollection.ReadWriteLockWrapper, AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>
-
-
Field Summary
Fields Modifier and Type Field Description private MutableList<T>delegateprivate static longserialVersionUID-
Fields inherited from class org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection
lock, lockWrapper
-
-
Constructor Summary
Constructors Modifier Constructor Description MultiReaderFastList()Deprecated.Empty default constructor used for serialization.privateMultiReaderFastList(MutableList<T> newDelegate)privateMultiReaderFastList(MutableList<T> newDelegate, java.util.concurrent.locks.ReadWriteLock newLock)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(int index, T element)booleanaddAll(int index, java.util.Collection<? extends T> collection)ParallelListIterable<T>asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)Returns a parallel iterable of this ListIterable.(package private) MultiReaderFastList.UntouchableMutableList<T>asReadUntouchable()LazyIterable<T>asReversed()Returns a reversed view of this ReversibleIterable.MutableList<T>asSynchronized()Returns a synchronized wrapper backed by this collection.MutableList<T>asUnmodifiable()Returns an unmodifiable view of the list.(package private) MultiReaderFastList.UntouchableMutableList<T>asWriteUntouchable()intbinarySearch(T key)Searches for the specified object using the binary search algorithm.intbinarySearch(T key, java.util.Comparator<? super T> comparator)Searches for the specified object using the binary search algorithm.RichIterable<RichIterable<T>>chunk(int size)Partitions elements in fixed size chunks.MultiReaderList<T>clone()<V> MutableList<V>collect(Function<? super T,? extends V> function)Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.MutableBooleanListcollectBoolean(BooleanFunction<? super T> booleanFunction)Returns a new primitivebooleaniterable with the results of applying the specified function on each element of the source collection.MutableByteListcollectByte(ByteFunction<? super T> byteFunction)Returns a new primitivebyteiterable with the results of applying the specified function on each element of the source collection.MutableCharListcollectChar(CharFunction<? super T> charFunction)Returns a new primitivechariterable with the results of applying the specified function on each element of the source collection.MutableDoubleListcollectDouble(DoubleFunction<? super T> doubleFunction)Returns a new primitivedoubleiterable with the results of applying the specified function on each element of the source collection.MutableFloatListcollectFloat(FloatFunction<? super T> floatFunction)Returns a new primitivefloatiterable with the results of applying the specified function on each element of the source collection.<V> MutableList<V>collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.MutableIntListcollectInt(IntFunction<? super T> intFunction)Returns a new primitiveintiterable with the results of applying the specified function on each element of the source collection.MutableLongListcollectLong(LongFunction<? super T> longFunction)Returns a new primitivelongiterable with the results of applying the specified function on each element of the source collection.MutableShortListcollectShort(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>
MutableList<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.<S> booleancorresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)Returns true if both OrderedIterables have the same length andpredicatereturns true for all corresponding elements e1 of thisOrderedIterableand e2 ofother.intdetectIndex(Predicate<? super T> predicate)Returns the index of the first element of theOrderedIterablefor which thepredicateevaluates to true.intdetectLastIndex(Predicate<? super T> predicate)Returns the index of the last element of theReversibleIterablefor which thepredicateevaluates to true.MutableList<T>distinct()Returns a newListIterablecontaining the distinct elements in this list.MutableList<T>distinct(HashingStrategy<? super T> hashingStrategy)Returns a newListIterablecontaining the distinct elements in this list.<V> MutableList<T>distinctBy(Function<? super T,? extends V> function)Returns a newListIterablecontaining the distinct elements in this list.MutableList<T>drop(int count)Returns an iterable after skipping the firstcountelements or an empty iterable if thecountis greater than the length of the iterable.MutableList<T>dropWhile(Predicate<? super T> predicate)Returns the final elements that do not satisfy the Predicate.booleanequals(java.lang.Object o)Follows the same general contract asList.equals(Object).<V> MutableList<V>flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)flatCollectis a special case ofRichIterable.collect(Function).voidforEach(int startIndex, int endIndex, Procedure<? super T> procedure)Iterates over the section of the iterable covered by the specified inclusive indexes.<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.voidforEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)Iterates over the section of the iterable covered by the specified inclusive indexes.Tget(int index)Returns the item at the specified position in this list iterable.protected MutableList<T>getDelegate()java.util.Optional<T>getFirstOptional()Returns the first element of an iterable as an Optional.java.util.Optional<T>getLastOptional()Returns the last element of an iterable as an Optional.<V> MutableListMultimap<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> MutableListMultimap<V,T>groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)Similar toRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.<V> MutableMap<V,T>groupByUniqueKey(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 map, where the transformed value is the key.inthashCode()Follows the same general contract asList.hashCode().intindexOf(java.lang.Object o)Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.intlastIndexOf(java.lang.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.java.util.ListIterator<T>listIterator()This method is not supported directly on a MultiReaderFastList.java.util.ListIterator<T>listIterator(int index)This method is not supported directly on a MultiReaderFastList.MultiReaderList<T>newEmpty()Creates a new empty mutable version of the same collection type.static <T> MultiReaderFastList<T>newList()static <T> MultiReaderFastList<T>newList(int capacity)static <T> MultiReaderFastList<T>newList(java.lang.Iterable<? extends T> iterable)static <T> MultiReaderFastList<T>newListWith(T... elements)PartitionMutableList<T>partition(Predicate<? super T> predicate)Filters a collection into a PartitionedIterable based on the evaluation of the predicate.PartitionMutableList<T>partitionWhile(Predicate<? super T> predicate)Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.<P> PartitionMutableList<T>partitionWith(Predicate2<? super T,? super P> predicate, P parameter)Filters a collection into a PartitionIterable based on the evaluation of the predicate.voidreadExternal(java.io.ObjectInput in)Tremove(int index)voidreplaceAll(java.util.function.UnaryOperator<T> operator)voidreverseForEach(Procedure<? super T> procedure)Evaluates the procedure for each element of the list iterating in reverse order.voidreverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)Evaluates the procedure for each element and it's index in reverse order.MultiReaderList<T>reverseThis()Mutates this list by reversing its order and returns the current list as a result.<S> MutableList<S>selectInstancesOf(java.lang.Class<S> clazz)Returns all elements of the source collection that are instances of the Classclazz.Tset(int index, T element)MultiReaderList<T>shuffleThis()Mutates this list by shuffling its elements.MultiReaderList<T>shuffleThis(java.util.Random rnd)Mutates this list by shuffling its elements using the specified random.voidsort(java.util.Comparator<? super T> comparator)MultiReaderList<T>sortThis()Sorts the internal data structure of this list and returns the list itself as a convenience.MultiReaderList<T>sortThis(java.util.Comparator<? super T> comparator)Sorts the internal data structure of this list and returns the list itself as a convenience.<V extends java.lang.Comparable<? super V>>
MultiReaderList<T>sortThisBy(Function<? super T,? extends V> function)Sorts the internal data structure of this list based on the natural order of the attribute returned byfunction.MultiReaderList<T>sortThisByBoolean(BooleanFunction<? super T> function)MultiReaderList<T>sortThisByByte(ByteFunction<? super T> function)MultiReaderList<T>sortThisByChar(CharFunction<? super T> function)MultiReaderList<T>sortThisByDouble(DoubleFunction<? super T> function)MultiReaderList<T>sortThisByFloat(FloatFunction<? super T> function)MultiReaderList<T>sortThisByInt(IntFunction<? super T> function)MultiReaderList<T>sortThisByLong(LongFunction<? super T> function)MultiReaderList<T>sortThisByShort(ShortFunction<? super T> function)MultiReaderList<T>subList(int fromIndex, int toIndex)MutableList<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.MutableList<T>takeWhile(Predicate<? super T> predicate)Returns the initial elements that satisfy the Predicate.MultiReaderList<T>tap(Procedure<? super T> procedure)Executes the Procedure for each element in the iterable and returnsthis.ImmutableList<T>toImmutable()Returns an immutable copy of this list.MutableList<T>toReversed()Returns a new MutableList in reverse order.MutableStack<T>toStack()Converts the OrderedIterable to a mutable MutableStack implementation.voidwithReadLockAndDelegate(Procedure<? super MutableList<T>> procedure)voidwithWriteLockAndDelegate(Procedure<? super MutableList<T>> procedure)voidwriteExternal(java.io.ObjectOutput out)<S> MutableList<Pair<T,S>>zip(java.lang.Iterable<S> that)Returns aRichIterableformed from thisRichIterableand anotherRichIterableby combining corresponding elements in pairs.MutableList<Pair<T,java.lang.Integer>>zipWithIndex()Zips thisRichIterablewith its indices.-
Methods inherited from class org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection
add, addAll, addAllIterable, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, parallelStream, reduceBy, reduceBy, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableList, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith
-
Methods inherited from interface java.util.List
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator
-
Methods inherited from interface org.eclipse.collections.api.list.MultiReaderList
with, withAll, without, withoutAll
-
Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong
-
Methods inherited from interface org.eclipse.collections.api.list.MutableList
collectWithIndex, flatCollectWith, getFirst, getLast, reject, rejectWith, rejectWithIndex, select, selectWith, selectWithIndex, toArray, toArray, toImmutableList
-
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, forEachWithIndex, max, min, rejectWithIndex, selectWithIndex, zip, zipWithIndex
-
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
delegate
private MutableList<T> delegate
-
-
Constructor Detail
-
MultiReaderFastList
@Deprecated public MultiReaderFastList()
Deprecated.Empty default constructor used for serialization.
-
MultiReaderFastList
private MultiReaderFastList(MutableList<T> newDelegate)
-
MultiReaderFastList
private MultiReaderFastList(MutableList<T> newDelegate, java.util.concurrent.locks.ReadWriteLock newLock)
-
-
Method Detail
-
newList
public static <T> MultiReaderFastList<T> newList()
-
newList
public static <T> MultiReaderFastList<T> newList(int capacity)
-
newList
public static <T> MultiReaderFastList<T> newList(java.lang.Iterable<? extends T> iterable)
-
newListWith
public static <T> MultiReaderFastList<T> newListWith(T... elements)
-
getDelegate
protected MutableList<T> getDelegate()
- Specified by:
getDelegatein classAbstractMultiReaderMutableCollection<T>
-
asReadUntouchable
MultiReaderFastList.UntouchableMutableList<T> asReadUntouchable()
-
asWriteUntouchable
MultiReaderFastList.UntouchableMutableList<T> asWriteUntouchable()
-
withReadLockAndDelegate
public void withReadLockAndDelegate(Procedure<? super MutableList<T>> procedure)
- Specified by:
withReadLockAndDelegatein interfaceMultiReaderList<T>
-
withWriteLockAndDelegate
public void withWriteLockAndDelegate(Procedure<? super MutableList<T>> procedure)
- Specified by:
withWriteLockAndDelegatein interfaceMultiReaderList<T>
-
asSynchronized
public MutableList<T> asSynchronized()
Description copied from interface:MutableCollectionReturns a synchronized wrapper backed by this collection. This is the equivalent of usingCollections.synchronizedCollection(this)only with a return type that supports the full iteration protocols available onMutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.MutableCollection synchedCollection = collection.asSynchronized(); ... synchedCollection.forEach(each -> ... ); synchedCollection.select(each -> ... ); synchedCollection.collect(each -> ... );If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.- Specified by:
asSynchronizedin interfaceMutableCollection<T>- Specified by:
asSynchronizedin interfaceMutableList<T>- Returns:
- a synchronized view of this collection.
- See Also:
Collections.synchronizedCollection(Collection)
-
asUnmodifiable
public MutableList<T> asUnmodifiable()
Description copied from interface:MutableListReturns an unmodifiable view of the list.- Specified by:
asUnmodifiablein interfaceMutableCollection<T>- Specified by:
asUnmodifiablein interfaceMutableList<T>- Returns:
- an unmodifiable view of this list
- See Also:
Collections.unmodifiableCollection(Collection)
-
toImmutable
public ImmutableList<T> toImmutable()
Description copied from interface:MutableListReturns an immutable copy of this list. If the list is immutable, it returns itself.- Specified by:
toImmutablein interfaceListIterable<T>- Specified by:
toImmutablein interfaceMutableCollection<T>- Specified by:
toImmutablein interfaceMutableList<T>
-
clone
public MultiReaderList<T> clone()
- Specified by:
clonein interfaceMultiReaderList<T>- Specified by:
clonein interfaceMutableList<T>- Overrides:
clonein classjava.lang.Object
-
collect
public <V> MutableList<V> collect(Function<? super T,? extends V> function)
Description copied from interface:MutableCollectionReturns a new MutableCollection with the results of applying the specified function to each element of the source collection.MutableCollection<String> names = people.collect(person -> person.getFirstName() + " " + person.getLastName());- Specified by:
collectin interfaceListIterable<T>- Specified by:
collectin interfaceMutableCollection<T>- Specified by:
collectin interfaceMutableList<T>- Specified by:
collectin interfaceOrderedIterable<T>- Specified by:
collectin interfaceReversibleIterable<T>- Specified by:
collectin interfaceRichIterable<T>
-
collectBoolean
public MutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableBooleanCollection licenses = people.collectBoolean(person -> person.hasDrivingLicense());- Specified by:
collectBooleanin interfaceListIterable<T>- Specified by:
collectBooleanin interfaceMutableCollection<T>- Specified by:
collectBooleanin interfaceMutableList<T>- Specified by:
collectBooleanin interfaceOrderedIterable<T>- Specified by:
collectBooleanin interfaceReversibleIterable<T>- Specified by:
collectBooleanin interfaceRichIterable<T>
-
collectByte
public MutableByteList collectByte(ByteFunction<? super T> byteFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableByteCollection bytes = people.collectByte(person -> person.getCode());- Specified by:
collectBytein interfaceListIterable<T>- Specified by:
collectBytein interfaceMutableCollection<T>- Specified by:
collectBytein interfaceMutableList<T>- Specified by:
collectBytein interfaceOrderedIterable<T>- Specified by:
collectBytein interfaceReversibleIterable<T>- Specified by:
collectBytein interfaceRichIterable<T>
-
collectChar
public MutableCharList collectChar(CharFunction<? super T> charFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableCharCollection chars = people.collectChar(person -> person.getMiddleInitial());- Specified by:
collectCharin interfaceListIterable<T>- Specified by:
collectCharin interfaceMutableCollection<T>- Specified by:
collectCharin interfaceMutableList<T>- Specified by:
collectCharin interfaceOrderedIterable<T>- Specified by:
collectCharin interfaceReversibleIterable<T>- Specified by:
collectCharin interfaceRichIterable<T>
-
collectDouble
public MutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableDoubleCollection doubles = people.collectDouble(person -> person.getMilesFromNorthPole());- Specified by:
collectDoublein interfaceListIterable<T>- Specified by:
collectDoublein interfaceMutableCollection<T>- Specified by:
collectDoublein interfaceMutableList<T>- Specified by:
collectDoublein interfaceOrderedIterable<T>- Specified by:
collectDoublein interfaceReversibleIterable<T>- Specified by:
collectDoublein interfaceRichIterable<T>
-
collectFloat
public MutableFloatList collectFloat(FloatFunction<? super T> floatFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableFloatCollection floats = people.collectFloat(person -> person.getHeightInInches());- Specified by:
collectFloatin interfaceListIterable<T>- Specified by:
collectFloatin interfaceMutableCollection<T>- Specified by:
collectFloatin interfaceMutableList<T>- Specified by:
collectFloatin interfaceOrderedIterable<T>- Specified by:
collectFloatin interfaceReversibleIterable<T>- Specified by:
collectFloatin interfaceRichIterable<T>
-
collectInt
public MutableIntList collectInt(IntFunction<? super T> intFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableIntCollection ints = people.collectInt(person -> person.getAge());- Specified by:
collectIntin interfaceListIterable<T>- Specified by:
collectIntin interfaceMutableCollection<T>- Specified by:
collectIntin interfaceMutableList<T>- Specified by:
collectIntin interfaceOrderedIterable<T>- Specified by:
collectIntin interfaceReversibleIterable<T>- Specified by:
collectIntin interfaceRichIterable<T>
-
collectLong
public MutableLongList collectLong(LongFunction<? super T> longFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableLongCollection longs = people.collectLong(person -> person.getGuid());- Specified by:
collectLongin interfaceListIterable<T>- Specified by:
collectLongin interfaceMutableCollection<T>- Specified by:
collectLongin interfaceMutableList<T>- Specified by:
collectLongin interfaceOrderedIterable<T>- Specified by:
collectLongin interfaceReversibleIterable<T>- Specified by:
collectLongin interfaceRichIterable<T>
-
collectShort
public MutableShortList collectShort(ShortFunction<? super T> shortFunction)
Description copied from interface:MutableCollectionReturns 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());Co-variant example for MutableCollection:MutableShortCollection shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());- Specified by:
collectShortin interfaceListIterable<T>- Specified by:
collectShortin interfaceMutableCollection<T>- Specified by:
collectShortin interfaceMutableList<T>- Specified by:
collectShortin interfaceOrderedIterable<T>- Specified by:
collectShortin interfaceReversibleIterable<T>- Specified by:
collectShortin interfaceRichIterable<T>
-
flatCollect
public <V> MutableList<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
Description copied from interface:MutableCollectionflatCollectis 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);
Co-variant example for MutableCollection:Function<Person, List<Address>> addressFunction = Person::getAddresses; MutableCollection<Person> people = ...; MutableCollection<List<Address>> addresses = people.collect(addressFunction); MutableCollection<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollectin interfaceListIterable<T>- Specified by:
flatCollectin interfaceMutableCollection<T>- Specified by:
flatCollectin interfaceMutableList<T>- Specified by:
flatCollectin interfaceOrderedIterable<T>- Specified by:
flatCollectin interfaceReversibleIterable<T>- Specified by:
flatCollectin interfaceRichIterable<T>- Parameters:
function- TheFunctionto apply- Returns:
- a new flattened collection produced by applying the given
function
-
collectIf
public <V> MutableList<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
Description copied from interface:MutableCollectionReturns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.MutableCollection<String> collected = Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())- Specified by:
collectIfin interfaceListIterable<T>- Specified by:
collectIfin interfaceMutableCollection<T>- Specified by:
collectIfin interfaceMutableList<T>- Specified by:
collectIfin interfaceOrderedIterable<T>- Specified by:
collectIfin interfaceReversibleIterable<T>- Specified by:
collectIfin interfaceRichIterable<T>
-
collectWith
public <P,V> MutableList<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
Description copied from interface:MutableCollectionSame 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));Co-variant example for MutableCollection:MutableCollection<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));- Specified by:
collectWithin interfaceListIterable<T>- Specified by:
collectWithin interfaceMutableCollection<T>- Specified by:
collectWithin interfaceMutableList<T>- Specified by:
collectWithin interfaceOrderedIterable<T>- Specified by:
collectWithin interfaceReversibleIterable<T>- Specified by:
collectWithin interfaceRichIterable<T>- Parameters:
function- AFunction2to use as the collect transformation functionparameter- A parameter to pass in for evaluation of the second argumentPinfunction- Returns:
- A new
RichIterablethat contains the transformed elements returned byFunction2.value(Object, Object) - See Also:
RichIterable.collect(Function)
-
newEmpty
public MultiReaderList<T> newEmpty()
Description copied from interface:MutableCollectionCreates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.- Specified by:
newEmptyin interfaceMultiReaderList<T>- Specified by:
newEmptyin interfaceMutableCollection<T>- Specified by:
newEmptyin interfaceMutableList<T>
-
tap
public MultiReaderList<T> tap(Procedure<? super T> procedure)
Description 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()));- Specified by:
tapin interfaceListIterable<T>- Specified by:
tapin interfaceMultiReaderList<T>- Specified by:
tapin interfaceMutableCollection<T>- Specified by:
tapin interfaceMutableList<T>- Specified by:
tapin interfaceOrderedIterable<T>- Specified by:
tapin interfaceReversibleIterable<T>- Specified by:
tapin interfaceRichIterable<T>- See Also:
RichIterable.each(Procedure),RichIterable.forEach(Procedure)
-
partition
public PartitionMutableList<T> partition(Predicate<? super T> predicate)
Description copied from interface:MutableCollectionFilters 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"));Co-variant example for MutableCollection:PartitionMutableCollection<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));- Specified by:
partitionin interfaceListIterable<T>- Specified by:
partitionin interfaceMutableCollection<T>- Specified by:
partitionin interfaceMutableList<T>- Specified by:
partitionin interfaceOrderedIterable<T>- Specified by:
partitionin interfaceReversibleIterable<T>- Specified by:
partitionin interfaceRichIterable<T>
-
partitionWith
public <P> PartitionMutableList<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
Description copied from interface:MutableCollectionFilters 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");Co-variant example for MutableCollection:PartitionMutableCollection<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");- Specified by:
partitionWithin interfaceListIterable<T>- Specified by:
partitionWithin interfaceMutableCollection<T>- Specified by:
partitionWithin interfaceMutableList<T>- Specified by:
partitionWithin interfaceOrderedIterable<T>- Specified by:
partitionWithin interfaceReversibleIterable<T>- Specified by:
partitionWithin interfaceRichIterable<T>
-
selectInstancesOf
public <S> MutableList<S> selectInstancesOf(java.lang.Class<S> clazz)
Description copied from interface:MutableCollectionReturns 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);Co-variant example for MutableCollection:MutableCollection<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);- Specified by:
selectInstancesOfin interfaceListIterable<T>- Specified by:
selectInstancesOfin interfaceMutableCollection<T>- Specified by:
selectInstancesOfin interfaceMutableList<T>- Specified by:
selectInstancesOfin interfaceOrderedIterable<T>- Specified by:
selectInstancesOfin interfaceReversibleIterable<T>- Specified by:
selectInstancesOfin interfaceRichIterable<T>
-
distinct
public MutableList<T> distinct()
Description copied from interface:MutableListReturns a newListIterablecontaining the distinct elements in this list.- Specified by:
distinctin interfaceListIterable<T>- Specified by:
distinctin interfaceMutableList<T>- Specified by:
distinctin interfaceOrderedIterable<T>- Specified by:
distinctin interfaceReversibleIterable<T>- Returns:
ListIterableof distinct elements
-
distinct
public MutableList<T> distinct(HashingStrategy<? super T> hashingStrategy)
Description copied from interface:MutableListReturns a newListIterablecontaining the distinct elements in this list. Takes HashingStrategy.- Specified by:
distinctin interfaceListIterable<T>- Specified by:
distinctin interfaceMutableList<T>- Returns:
ListIterableof distinct elements
-
distinctBy
public <V> MutableList<T> distinctBy(Function<? super T,? extends V> function)
Description copied from interface:ListIterableReturns a newListIterablecontaining the distinct elements in this list. The specified function will be used to create a HashingStrategy to unique the elements.- Specified by:
distinctByin interfaceListIterable<T>- Specified by:
distinctByin interfaceMutableList<T>- Since:
- 9.0.
- See Also:
ListIterable.distinct(HashingStrategy)
-
sortThis
public MultiReaderList<T> sortThis()
Description copied from interface:MutableListSorts the internal data structure of this list and returns the list itself as a convenience.- Specified by:
sortThisin interfaceMultiReaderList<T>- Specified by:
sortThisin interfaceMutableList<T>
-
sortThis
public MultiReaderList<T> sortThis(java.util.Comparator<? super T> comparator)
Description copied from interface:MutableListSorts the internal data structure of this list and returns the list itself as a convenience.- Specified by:
sortThisin interfaceMultiReaderList<T>- Specified by:
sortThisin interfaceMutableList<T>
-
sortThisBy
public <V extends java.lang.Comparable<? super V>> MultiReaderList<T> sortThisBy(Function<? super T,? extends V> function)
Description copied from interface:MutableListSorts the internal data structure of this list based on the natural order of the attribute returned byfunction.- Specified by:
sortThisByin interfaceMultiReaderList<T>- Specified by:
sortThisByin interfaceMutableList<T>
-
sortThisByInt
public MultiReaderList<T> sortThisByInt(IntFunction<? super T> function)
- Specified by:
sortThisByIntin interfaceMultiReaderList<T>- Specified by:
sortThisByIntin interfaceMutableList<T>
-
sortThisByBoolean
public MultiReaderList<T> sortThisByBoolean(BooleanFunction<? super T> function)
- Specified by:
sortThisByBooleanin interfaceMultiReaderList<T>- Specified by:
sortThisByBooleanin interfaceMutableList<T>
-
sortThisByChar
public MultiReaderList<T> sortThisByChar(CharFunction<? super T> function)
- Specified by:
sortThisByCharin interfaceMultiReaderList<T>- Specified by:
sortThisByCharin interfaceMutableList<T>
-
sortThisByByte
public MultiReaderList<T> sortThisByByte(ByteFunction<? super T> function)
- Specified by:
sortThisByBytein interfaceMultiReaderList<T>- Specified by:
sortThisByBytein interfaceMutableList<T>
-
sortThisByShort
public MultiReaderList<T> sortThisByShort(ShortFunction<? super T> function)
- Specified by:
sortThisByShortin interfaceMultiReaderList<T>- Specified by:
sortThisByShortin interfaceMutableList<T>
-
sortThisByFloat
public MultiReaderList<T> sortThisByFloat(FloatFunction<? super T> function)
- Specified by:
sortThisByFloatin interfaceMultiReaderList<T>- Specified by:
sortThisByFloatin interfaceMutableList<T>
-
sortThisByLong
public MultiReaderList<T> sortThisByLong(LongFunction<? super T> function)
- Specified by:
sortThisByLongin interfaceMultiReaderList<T>- Specified by:
sortThisByLongin interfaceMutableList<T>
-
sortThisByDouble
public MultiReaderList<T> sortThisByDouble(DoubleFunction<? super T> function)
- Specified by:
sortThisByDoublein interfaceMultiReaderList<T>- Specified by:
sortThisByDoublein interfaceMutableList<T>
-
subList
public MultiReaderList<T> subList(int fromIndex, int toIndex)
- Specified by:
subListin interfacejava.util.List<T>- Specified by:
subListin interfaceListIterable<T>- Specified by:
subListin interfaceMultiReaderList<T>- Specified by:
subListin interfaceMutableList<T>- See Also:
List.subList(int, int)
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:ListIterableFollows the same general contract asList.equals(Object).- Specified by:
equalsin interfacejava.util.Collection<T>- Specified by:
equalsin interfacejava.util.List<T>- Specified by:
equalsin interfaceListIterable<T>- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
Description copied from interface:ListIterableFollows the same general contract asList.hashCode().- Specified by:
hashCodein interfacejava.util.Collection<T>- Specified by:
hashCodein interfacejava.util.List<T>- Specified by:
hashCodein interfaceListIterable<T>- Overrides:
hashCodein classjava.lang.Object
-
get
public T get(int index)
Description copied from interface:ListIterableReturns the item at the specified position in this list iterable.- Specified by:
getin interfacejava.util.List<T>- Specified by:
getin interfaceListIterable<T>
-
getFirstOptional
public java.util.Optional<T> getFirstOptional()
Description copied from interface:OrderedIterableReturns the first element of an iterable as an Optional. 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,Optional.empty()is returned.- Specified by:
getFirstOptionalin interfaceOrderedIterable<T>
-
getLastOptional
public java.util.Optional<T> getLastOptional()
Description copied from interface:OrderedIterableReturns the last element of an iterable as an Optional. 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,Optional.empty()is returned.- Specified by:
getLastOptionalin interfaceOrderedIterable<T>
-
indexOf
public int indexOf(java.lang.Object o)
Description copied from interface:OrderedIterableReturns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.- Specified by:
indexOfin interfacejava.util.List<T>- Specified by:
indexOfin interfaceMutableList<T>- Specified by:
indexOfin interfaceOrderedIterable<T>- See Also:
List.indexOf(Object)
-
lastIndexOf
public int lastIndexOf(java.lang.Object o)
Description copied from interface:ListIterableReturns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.- Specified by:
lastIndexOfin interfacejava.util.List<T>- Specified by:
lastIndexOfin interfaceListIterable<T>
-
listIterator
public java.util.ListIterator<T> listIterator()
This method is not supported directly on a MultiReaderFastList. If you would like to use a ListIterator with MultiReaderFastList, then you must do the following:multiReaderList.withReadLockAndDelegate(new Procedure<MutableList<Person>>() { public void value(MutableList<Person> people) { Iterator it = people.listIterator(); .... } });- Specified by:
listIteratorin interfacejava.util.List<T>- Specified by:
listIteratorin interfaceListIterable<T>- See Also:
List.listIterator()
-
replaceAll
public void replaceAll(java.util.function.UnaryOperator<T> operator)
- Specified by:
replaceAllin interfacejava.util.List<T>- Since:
- 10.0 - Overridden for correctness
-
sort
public void sort(java.util.Comparator<? super T> comparator)
- Specified by:
sortin interfacejava.util.List<T>- Since:
- 10.0 - Overridden for correctness
-
listIterator
public java.util.ListIterator<T> listIterator(int index)
This method is not supported directly on a MultiReaderFastList. If you would like to use a ListIterator with MultiReaderFastList, then you must do the following:multiReaderList.withReadLockAndDelegate(new Procedure<MutableList<Person>>() { public void value(MutableList<Person> people) { Iterator it = people.listIterator(0); .... } });- Specified by:
listIteratorin interfacejava.util.List<T>- Specified by:
listIteratorin interfaceListIterable<T>- See Also:
List.listIterator(int)
-
addAll
public boolean addAll(int index, java.util.Collection<? extends T> collection)- Specified by:
addAllin interfacejava.util.List<T>
-
corresponds
public <S> boolean corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)
Description copied from interface:OrderedIterableReturns true if both OrderedIterables have the same length andpredicatereturns true for all corresponding elements e1 of thisOrderedIterableand e2 ofother. Thepredicateis evaluated for each element at the same position of eachOrderedIterablein a forward iteration order. This is a short circuit pattern.- Specified by:
correspondsin interfaceOrderedIterable<T>
-
forEach
public void forEach(int startIndex, int endIndex, Procedure<? super T> procedure)Description copied from interface:OrderedIterableIterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.e.g. OrderedIterable<Person> people = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, person -> LOGGER.info(person.getName()));
This code would output ted and mary's names.
- Specified by:
forEachin interfaceOrderedIterable<T>
-
forEachInBoth
public <T2> void forEachInBoth(ListIterable<T2> other, Procedure2<? super T,? super T2> procedure)
Description copied from interface:ListIterableIterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.- Specified by:
forEachInBothin interfaceListIterable<T>
-
binarySearch
public int binarySearch(T key, java.util.Comparator<? super T> comparator)
Description copied from interface:ListIterableSearches for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator.- Specified by:
binarySearchin interfaceListIterable<T>- See Also:
Collections.binarySearch(List, Object, Comparator)
-
binarySearch
public int binarySearch(T key)
Description copied from interface:ListIterableSearches 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.- Specified by:
binarySearchin interfaceListIterable<T>- See Also:
Collections.binarySearch(List, Object)
-
reverseForEach
public void reverseForEach(Procedure<? super T> procedure)
Description copied from interface:ReversibleIterableEvaluates the procedure for each element of the list iterating in reverse order.e.g. people.reverseForEach(person -> LOGGER.info(person.getName()));
- Specified by:
reverseForEachin interfaceReversibleIterable<T>
-
reverseForEachWithIndex
public void reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)
Description copied from interface:ReversibleIterableEvaluates the procedure for each element and it's index in reverse order.e.g. people.reverseForEachWithIndex((person, index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));- Specified by:
reverseForEachWithIndexin interfaceReversibleIterable<T>
-
forEachWithIndex
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)Description copied from interface:OrderedIterableIterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, (person, index) -> LOGGER.info(person.getName()));
This code would output ted and mary's names.
- Specified by:
forEachWithIndexin interfaceOrderedIterable<T>
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException- Specified by:
writeExternalin interfacejava.io.Externalizable- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException- Specified by:
readExternalin interfacejava.io.Externalizable- Throws:
java.io.IOExceptionjava.lang.ClassNotFoundException
-
detectIndex
public int detectIndex(Predicate<? super T> predicate)
Description copied from interface:OrderedIterableReturns the index of the first element of theOrderedIterablefor which thepredicateevaluates to true. Returns -1 if no element evaluates true for thepredicate.- Specified by:
detectIndexin interfaceOrderedIterable<T>
-
detectLastIndex
public int detectLastIndex(Predicate<? super T> predicate)
Description copied from interface:ReversibleIterableReturns the index of the last element of theReversibleIterablefor which thepredicateevaluates to true. Returns -1 if no element evaluates true for thepredicate.- Specified by:
detectLastIndexin interfaceReversibleIterable<T>
-
groupBy
public <V> MutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
Description copied from interface:MutableCollectionFor 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);Co-variant example for MutableCollection:MutableMultimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);- Specified by:
groupByin interfaceListIterable<T>- Specified by:
groupByin interfaceMutableCollection<T>- Specified by:
groupByin interfaceMutableList<T>- Specified by:
groupByin interfaceOrderedIterable<T>- Specified by:
groupByin interfaceReversibleIterable<T>- Specified by:
groupByin interfaceRichIterable<T>
-
groupByEach
public <V> MutableListMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
Description 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 interfaceListIterable<T>- Specified by:
groupByEachin interfaceMutableCollection<T>- Specified by:
groupByEachin interfaceMutableList<T>- Specified by:
groupByEachin interfaceOrderedIterable<T>- Specified by:
groupByEachin interfaceReversibleIterable<T>- Specified by:
groupByEachin interfaceRichIterable<T>
-
groupByUniqueKey
public <V> MutableMap<V,T> groupByUniqueKey(Function<? super T,? extends V> function)
Description copied from interface:RichIterableFor 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.- Specified by:
groupByUniqueKeyin interfaceMutableCollection<T>- Specified by:
groupByUniqueKeyin interfaceRichIterable<T>- See Also:
RichIterable.groupBy(Function)
-
zip
public <S> MutableList<Pair<T,S>> zip(java.lang.Iterable<S> that)
Description copied from interface:RichIterableReturns aRichIterableformed from thisRichIterableand anotherRichIterableby combining corresponding elements in pairs. If one of the twoRichIterables is longer than the other, its remaining elements are ignored.- Specified by:
zipin interfaceListIterable<T>- Specified by:
zipin interfaceMutableCollection<T>- Specified by:
zipin interfaceMutableList<T>- Specified by:
zipin interfaceOrderedIterable<T>- Specified by:
zipin interfaceReversibleIterable<T>- Specified by:
zipin interfaceRichIterable<T>- Type Parameters:
S- the type of the second half of the returned pairs- Parameters:
that- TheRichIterableproviding the second half of each result pair- Returns:
- A new
RichIterablecontaining pairs consisting of corresponding elements of thisRichIterableand that. The length of the returnedRichIterableis the minimum of the lengths of thisRichIterableand that.
-
zipWithIndex
public MutableList<Pair<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:RichIterableZips thisRichIterablewith its indices.- Specified by:
zipWithIndexin interfaceListIterable<T>- Specified by:
zipWithIndexin interfaceMutableCollection<T>- Specified by:
zipWithIndexin interfaceMutableList<T>- Specified by:
zipWithIndexin interfaceOrderedIterable<T>- Specified by:
zipWithIndexin interfaceReversibleIterable<T>- Specified by:
zipWithIndexin interfaceRichIterable<T>- Returns:
- A new
RichIterablecontaining pairs consisting of all elements of thisRichIterablepaired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
toReversed
public MutableList<T> toReversed()
Description copied from interface:MutableListReturns a new MutableList in reverse order.- Specified by:
toReversedin interfaceListIterable<T>- Specified by:
toReversedin interfaceMutableList<T>- Specified by:
toReversedin interfaceReversibleIterable<T>
-
reverseThis
public MultiReaderList<T> reverseThis()
Description copied from interface:MutableListMutates this list by reversing its order and returns the current list as a result.- Specified by:
reverseThisin interfaceMultiReaderList<T>- Specified by:
reverseThisin interfaceMutableList<T>
-
shuffleThis
public MultiReaderList<T> shuffleThis()
Description copied from interface:MutableListMutates this list by shuffling its elements.- Specified by:
shuffleThisin interfaceMultiReaderList<T>- Specified by:
shuffleThisin interfaceMutableList<T>
-
shuffleThis
public MultiReaderList<T> shuffleThis(java.util.Random rnd)
Description copied from interface:MutableListMutates this list by shuffling its elements using the specified random.- Specified by:
shuffleThisin interfaceMultiReaderList<T>- Specified by:
shuffleThisin interfaceMutableList<T>
-
toStack
public MutableStack<T> toStack()
Description copied from interface:OrderedIterableConverts the OrderedIterable to a mutable MutableStack implementation.- Specified by:
toStackin interfaceOrderedIterable<T>
-
chunk
public RichIterable<RichIterable<T>> chunk(int size)
Description copied from interface:RichIterablePartitions elements in fixed size chunks.- Specified by:
chunkin interfaceRichIterable<T>- Parameters:
size- the number of elements per chunk- Returns:
- A
RichIterablecontainingRichIterables of sizesize, except the last will be truncated if the elements don't divide evenly.
-
take
public MutableList<T> take(int count)
Description 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 interfaceListIterable<T>- Specified by:
takein interfaceMutableList<T>- Specified by:
takein interfaceReversibleIterable<T>- Parameters:
count- the number of items to take.
-
takeWhile
public MutableList<T> takeWhile(Predicate<? super T> predicate)
Description copied from interface:ListIterableReturns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
takeWhilein interfaceListIterable<T>- Specified by:
takeWhilein interfaceMutableList<T>- Specified by:
takeWhilein interfaceOrderedIterable<T>- Specified by:
takeWhilein interfaceReversibleIterable<T>
-
drop
public MutableList<T> drop(int count)
Description 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 interfaceListIterable<T>- Specified by:
dropin interfaceMutableList<T>- Specified by:
dropin interfaceReversibleIterable<T>- Parameters:
count- the number of items to drop.
-
dropWhile
public MutableList<T> dropWhile(Predicate<? super T> predicate)
Description copied from interface:ListIterableReturns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
dropWhilein interfaceListIterable<T>- Specified by:
dropWhilein interfaceMutableList<T>- Specified by:
dropWhilein interfaceOrderedIterable<T>- Specified by:
dropWhilein interfaceReversibleIterable<T>
-
partitionWhile
public PartitionMutableList<T> partitionWhile(Predicate<? super T> predicate)
Description copied from interface:ListIterableReturns 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 interfaceListIterable<T>- Specified by:
partitionWhilein interfaceMutableList<T>- Specified by:
partitionWhilein interfaceOrderedIterable<T>- Specified by:
partitionWhilein interfaceReversibleIterable<T>
-
asReversed
public LazyIterable<T> asReversed()
Description copied from interface:ReversibleIterableReturns a reversed view of this ReversibleIterable.- Specified by:
asReversedin interfaceReversibleIterable<T>
-
asParallel
public ParallelListIterable<T> asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)
Description copied from interface:ListIterableReturns a parallel iterable of this ListIterable.- Specified by:
asParallelin interfaceListIterable<T>
-
-