Class UnmodifiableMutableList<T>
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<T>
,Collection<T>
,List<T>
,MutableCollection<T>
,InternalIterable<T>
,ListIterable<T>
,MutableList<T>
,OrderedIterable<T>
,ReversibleIterable<T>
,RichIterable<T>
public class UnmodifiableMutableList<T> extends AbstractUnmodifiableMutableCollection<T> implements MutableList<T>, Serializable
- See Also:
MutableList.asUnmodifiable()
, Serialized Form
-
Method Summary
Modifier and Type Method Description void
add(int index, T element)
boolean
addAll(int index, Collection<? extends T> collection)
ParallelListIterable<T>
asParallel(ExecutorService executorService, int batchSize)
Returns a parallel iterable of this ListIterable.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 this collection.UnmodifiableMutableList<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.MutableBooleanList
collectBoolean(BooleanFunction<? super T> booleanFunction)
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection.MutableByteList
collectByte(ByteFunction<? super T> byteFunction)
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection.MutableCharList
collectChar(CharFunction<? super T> charFunction)
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection.MutableDoubleList
collectDouble(DoubleFunction<? super T> doubleFunction)
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection.MutableFloatList
collectFloat(FloatFunction<? super T> floatFunction)
Returns a new primitivefloat
iterable 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.MutableIntList
collectInt(IntFunction<? super T> intFunction)
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection.MutableLongList
collectLong(LongFunction<? super T> longFunction)
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection.MutableShortList
collectShort(ShortFunction<? super T> shortFunction)
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection.<P, A> MutableList<A>
collectWith(Function2<? super T,? super P,? extends A> function, P parameter)
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.<S> boolean
corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)
Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
.int
detectIndex(Predicate<? super T> predicate)
Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true.int
detectLastIndex(Predicate<? super T> predicate)
Returns the index of the last element of theReversibleIterable
for which thepredicate
evaluates to true.MutableList<T>
distinct()
Returns a newListIterable
containing the distinct elements in this list.MutableList<T>
distinct(HashingStrategy<? super T> hashingStrategy)
Returns a newListIterable
containing the distinct elements in this list.<V> MutableList<T>
distinctBy(Function<? super T,? extends V> function)
Returns a newListIterable
containing the distinct elements in this list.MutableList<T>
drop(int count)
Returns an iterable after skipping the firstcount
elements or an empty iterable if thecount
is greater than the length of the iterable.MutableList<T>
dropWhile(Predicate<? super T> predicate)
Returns the final elements that do not satisfy the Predicate.boolean
equals(Object obj)
Follows the same general contract asList.equals(Object)
.<V> MutableList<V>
flatCollect(Function<? super T,? extends Iterable<V>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.void
forEach(int fromIndex, int toIndex, Procedure<? super T> procedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.void
forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.T
get(int index)
Returns the item at the specified position in this list iterable.<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 Iterable<V>> function)
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.int
hashCode()
Follows the same general contract asList.hashCode()
.int
indexOf(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.int
lastIndexOf(Object o)
Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.ListIterator<T>
listIterator()
ListIterator<T>
listIterator(int index)
MutableList<T>
newEmpty()
Creates a new empty mutable version of the same collection type.static <E, L extends List<E>>
UnmodifiableMutableList<E>of(L list)
This method will take a MutableList and wrap it directly in a UnmodifiableMutableList.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.MutableList<T>
reject(Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate.<P> MutableList<T>
rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.T
remove(int index)
void
replaceAll(UnaryOperator<T> operator)
void
reverseForEach(Procedure<? super T> procedure)
Evaluates the procedure for each element of the list iterating in reverse order.void
reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)
Evaluates the procedure for each element and it's index in reverse order.MutableList<T>
reverseThis()
Mutates this list by reversing its order and returns the current list as a result.MutableList<T>
select(Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate.<S> MutableList<S>
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Classclazz
.<P> MutableList<T>
selectWith(Predicate2<? super T,? super P> predicate, P parameter)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.T
set(int index, T element)
MutableList<T>
shuffleThis()
Mutates this list by shuffling its elements.MutableList<T>
shuffleThis(Random rnd)
Mutates this list by shuffling its elements using the specified random.void
sort(Comparator<? super T> comparator)
UnmodifiableMutableList<T>
sortThis()
Sorts the internal data structure of this list and returns the list itself as a convenience.UnmodifiableMutableList<T>
sortThis(Comparator<? super T> comparator)
Sorts the internal data structure of this list and returns the list itself as a convenience.<V extends Comparable<? super V>>
MutableList<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
.MutableList<T>
sortThisByBoolean(BooleanFunction<? super T> function)
MutableList<T>
sortThisByByte(ByteFunction<? super T> function)
MutableList<T>
sortThisByChar(CharFunction<? super T> function)
MutableList<T>
sortThisByDouble(DoubleFunction<? super T> function)
MutableList<T>
sortThisByFloat(FloatFunction<? super T> function)
MutableList<T>
sortThisByInt(IntFunction<? super T> function)
MutableList<T>
sortThisByLong(LongFunction<? super T> function)
MutableList<T>
sortThisByShort(ShortFunction<? super T> function)
UnmodifiableMutableList<T>
subList(int fromIndex, int toIndex)
MutableList<T>
take(int count)
Returns the firstcount
elements of the iterable or all the elements in the iterable ifcount
is greater than the length of the iterable.MutableList<T>
takeWhile(Predicate<? super T> predicate)
Returns the initial elements that satisfy the Predicate.MutableList<T>
tap(Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returnsthis
.ImmutableList<T>
toImmutable()
Converts thisMutableCollection
to anImmutableCollection
.MutableList<T>
toReversed()
Returns a new MutableList in reverse order.MutableStack<T>
toStack()
Converts the OrderedIterable to a mutable MutableStack implementation.MutableList<T>
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.MutableList<T>
withAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.MutableList<T>
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.MutableList<T>
withoutAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.<S> MutableList<Pair<T,S>>
zip(Iterable<S> that)
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs.MutableList<Pair<T,Integer>>
zipWithIndex()
Zips thisRichIterable
with its indices.Methods inherited from class org.eclipse.collections.impl.collection.mutable.AbstractUnmodifiableMutableCollection
add, addAll, addAllIterable, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, 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, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
Methods inherited from interface java.util.List
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray
Methods inherited from interface org.eclipse.collections.api.list.ListIterable
binarySearch, binarySearch, forEachInBoth, getFirst, getLast
Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong
Methods inherited from interface org.eclipse.collections.api.list.MutableList
collectWithIndex, flatCollectWith
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, max, min, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, 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, into, isEmpty, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString
-
Method Details
-
of
This method will take a MutableList and wrap it directly in a UnmodifiableMutableList. It will take any other non-Eclipse-Collections list and first adapt it will a ListAdapter, and then return a UnmodifiableMutableList that wraps the adapter. -
equals
Description copied from interface:ListIterable
Follows the same general contract asList.equals(Object)
. -
hashCode
public int hashCode()Description copied from interface:ListIterable
Follows the same general contract asList.hashCode()
. -
asUnmodifiable
Description copied from interface:MutableCollection
Returns an unmodifiable view of this collection. This is the equivalent of usingCollections.unmodifiableCollection(this)
with a return type that supports the full iteration protocols available onMutableCollection
. Methods which would mutate the underlying collection will throw UnsupportedOperationExceptions.- Specified by:
asUnmodifiable
in interfaceMutableCollection<T>
- Specified by:
asUnmodifiable
in interfaceMutableList<T>
- Overrides:
asUnmodifiable
in classAbstractUnmodifiableMutableCollection<T>
- Returns:
- an unmodifiable view of this collection.
- See Also:
Collections.unmodifiableCollection(Collection)
-
toImmutable
Description copied from interface:MutableCollection
Converts thisMutableCollection
to anImmutableCollection
.- Specified by:
toImmutable
in interfaceListIterable<T>
- Specified by:
toImmutable
in interfaceMutableCollection<T>
- Specified by:
toImmutable
in interfaceMutableList<T>
- Overrides:
toImmutable
in classAbstractUnmodifiableMutableCollection<T>
-
asSynchronized
Description copied from interface:MutableCollection
Returns 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:
asSynchronized
in interfaceMutableCollection<T>
- Specified by:
asSynchronized
in interfaceMutableList<T>
- Overrides:
asSynchronized
in classAbstractUnmodifiableMutableCollection<T>
- Returns:
- a synchronized view of this collection.
- See Also:
Collections.synchronizedCollection(Collection)
-
clone
- Specified by:
clone
in interfaceMutableList<T>
-
newEmpty
Description copied from interface:MutableCollection
Creates 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:
newEmpty
in interfaceMutableCollection<T>
- Specified by:
newEmpty
in interfaceMutableList<T>
- Overrides:
newEmpty
in classAbstractUnmodifiableMutableCollection<T>
-
tap
Description copied from interface:RichIterable
Executes the Procedure for each element in the iterable and returnsthis
.Example using a Java 8 lambda expression:
RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
RichIterable<Person> tapped = people.tap(new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
- Specified by:
tap
in interfaceListIterable<T>
- Specified by:
tap
in interfaceMutableCollection<T>
- Specified by:
tap
in interfaceMutableList<T>
- Specified by:
tap
in interfaceOrderedIterable<T>
- Specified by:
tap
in interfaceReversibleIterable<T>
- Specified by:
tap
in interfaceRichIterable<T>
- Overrides:
tap
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
RichIterable.each(Procedure)
,RichIterable.forEach(Procedure)
-
corresponds
public <S> boolean corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)Description copied from interface:OrderedIterable
Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
. Thepredicate
is evaluated for each element at the same position of eachOrderedIterable
in a forward iteration order. This is a short circuit pattern.- Specified by:
corresponds
in interfaceOrderedIterable<T>
-
forEach
Description copied from interface:OrderedIterable
Iterates 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.forEach(0, 1, new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
- Specified by:
forEach
in interfaceOrderedIterable<T>
-
reverseForEach
Description copied from interface:ReversibleIterable
Evaluates the procedure for each element of the list iterating in reverse order.e.g. people.reverseForEach(person -> LOGGER.info(person.getName()));
- Specified by:
reverseForEach
in interfaceReversibleIterable<T>
-
reverseForEachWithIndex
Description copied from interface:ReversibleIterable
Evaluates 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:
reverseForEachWithIndex
in interfaceReversibleIterable<T>
-
forEachWithIndex
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)Description copied from interface:OrderedIterable
Iterates 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, new ObjectIntProcedure<Person>() { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
- Specified by:
forEachWithIndex
in interfaceOrderedIterable<T>
-
sortThis
Description copied from interface:MutableList
Sorts the internal data structure of this list and returns the list itself as a convenience.- Specified by:
sortThis
in interfaceMutableList<T>
-
sortThis
Description copied from interface:MutableList
Sorts the internal data structure of this list and returns the list itself as a convenience.- Specified by:
sortThis
in interfaceMutableList<T>
-
toReversed
Description copied from interface:MutableList
Returns a new MutableList in reverse order.- Specified by:
toReversed
in interfaceListIterable<T>
- Specified by:
toReversed
in interfaceMutableList<T>
- Specified by:
toReversed
in interfaceReversibleIterable<T>
-
reverseThis
Description copied from interface:MutableList
Mutates this list by reversing its order and returns the current list as a result.- Specified by:
reverseThis
in interfaceMutableList<T>
-
shuffleThis
Description copied from interface:MutableList
Mutates this list by shuffling its elements.- Specified by:
shuffleThis
in interfaceMutableList<T>
-
shuffleThis
Description copied from interface:MutableList
Mutates this list by shuffling its elements using the specified random.- Specified by:
shuffleThis
in interfaceMutableList<T>
-
toStack
Description copied from interface:OrderedIterable
Converts the OrderedIterable to a mutable MutableStack implementation.- Specified by:
toStack
in interfaceOrderedIterable<T>
-
sortThisBy
public <V extends Comparable<? super V>> MutableList<T> sortThisBy(Function<? super T,? extends V> function)Description copied from interface:MutableList
Sorts the internal data structure of this list based on the natural order of the attribute returned byfunction
.- Specified by:
sortThisBy
in interfaceMutableList<T>
-
replaceAll
- Specified by:
replaceAll
in interfaceList<T>
- Since:
- 10.0 - Overridden for correctness
-
sort
-
sortThisByInt
- Specified by:
sortThisByInt
in interfaceMutableList<T>
-
sortThisByBoolean
- Specified by:
sortThisByBoolean
in interfaceMutableList<T>
-
sortThisByChar
- Specified by:
sortThisByChar
in interfaceMutableList<T>
-
sortThisByByte
- Specified by:
sortThisByByte
in interfaceMutableList<T>
-
sortThisByShort
- Specified by:
sortThisByShort
in interfaceMutableList<T>
-
sortThisByFloat
- Specified by:
sortThisByFloat
in interfaceMutableList<T>
-
sortThisByLong
- Specified by:
sortThisByLong
in interfaceMutableList<T>
-
sortThisByDouble
- Specified by:
sortThisByDouble
in interfaceMutableList<T>
-
addAll
-
get
Description copied from interface:ListIterable
Returns the item at the specified position in this list iterable. -
set
-
add
-
remove
-
indexOf
Description copied from interface:OrderedIterable
Returns 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:
indexOf
in interfaceList<T>
- Specified by:
indexOf
in interfaceOrderedIterable<T>
- See Also:
List.indexOf(Object)
-
lastIndexOf
Description copied from interface:ListIterable
Returns 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:
lastIndexOf
in interfaceList<T>
- Specified by:
lastIndexOf
in interfaceListIterable<T>
-
listIterator
- Specified by:
listIterator
in interfaceList<T>
- Specified by:
listIterator
in interfaceListIterable<T>
- See Also:
List.listIterator()
-
listIterator
- Specified by:
listIterator
in interfaceList<T>
- Specified by:
listIterator
in interfaceListIterable<T>
- See Also:
List.listIterator(int)
-
subList
- Specified by:
subList
in interfaceList<T>
- Specified by:
subList
in interfaceListIterable<T>
- Specified by:
subList
in interfaceMutableList<T>
- See Also:
List.subList(int, int)
-
collectWith
public <P, A> MutableList<A> collectWith(Function2<? super T,? super P,? extends A> function, P parameter)Description copied from interface:MutableCollection
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
Co-variant example for MutableCollection:MutableCollection<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
- Specified by:
collectWith
in interfaceListIterable<T>
- Specified by:
collectWith
in interfaceMutableCollection<T>
- Specified by:
collectWith
in interfaceMutableList<T>
- Specified by:
collectWith
in interfaceOrderedIterable<T>
- Specified by:
collectWith
in interfaceReversibleIterable<T>
- Specified by:
collectWith
in interfaceRichIterable<T>
- Overrides:
collectWith
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
collect
Description copied from interface:MutableCollection
Returns 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:
collect
in interfaceListIterable<T>
- Specified by:
collect
in interfaceMutableCollection<T>
- Specified by:
collect
in interfaceMutableList<T>
- Specified by:
collect
in interfaceOrderedIterable<T>
- Specified by:
collect
in interfaceReversibleIterable<T>
- Specified by:
collect
in interfaceRichIterable<T>
- Overrides:
collect
in classAbstractUnmodifiableMutableCollection<T>
-
collectBoolean
Description copied from interface:MutableCollection
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
Co-variant example for MutableCollection:MutableBooleanCollection licenses = people.collectBoolean(person -> person.hasDrivingLicense());
- Specified by:
collectBoolean
in interfaceListIterable<T>
- Specified by:
collectBoolean
in interfaceMutableCollection<T>
- Specified by:
collectBoolean
in interfaceMutableList<T>
- Specified by:
collectBoolean
in interfaceOrderedIterable<T>
- Specified by:
collectBoolean
in interfaceReversibleIterable<T>
- Specified by:
collectBoolean
in interfaceRichIterable<T>
- Overrides:
collectBoolean
in classAbstractUnmodifiableMutableCollection<T>
-
collectByte
Description copied from interface:MutableCollection
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
Co-variant example for MutableCollection:MutableByteCollection bytes = people.collectByte(person -> person.getCode());
- Specified by:
collectByte
in interfaceListIterable<T>
- Specified by:
collectByte
in interfaceMutableCollection<T>
- Specified by:
collectByte
in interfaceMutableList<T>
- Specified by:
collectByte
in interfaceOrderedIterable<T>
- Specified by:
collectByte
in interfaceReversibleIterable<T>
- Specified by:
collectByte
in interfaceRichIterable<T>
- Overrides:
collectByte
in classAbstractUnmodifiableMutableCollection<T>
-
collectChar
Description copied from interface:MutableCollection
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
Co-variant example for MutableCollection:MutableCharCollection chars = people.collectChar(person -> person.getMiddleInitial());
- Specified by:
collectChar
in interfaceListIterable<T>
- Specified by:
collectChar
in interfaceMutableCollection<T>
- Specified by:
collectChar
in interfaceMutableList<T>
- Specified by:
collectChar
in interfaceOrderedIterable<T>
- Specified by:
collectChar
in interfaceReversibleIterable<T>
- Specified by:
collectChar
in interfaceRichIterable<T>
- Overrides:
collectChar
in classAbstractUnmodifiableMutableCollection<T>
-
collectDouble
Description copied from interface:MutableCollection
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
Co-variant example for MutableCollection:MutableDoubleCollection doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
- Specified by:
collectDouble
in interfaceListIterable<T>
- Specified by:
collectDouble
in interfaceMutableCollection<T>
- Specified by:
collectDouble
in interfaceMutableList<T>
- Specified by:
collectDouble
in interfaceOrderedIterable<T>
- Specified by:
collectDouble
in interfaceReversibleIterable<T>
- Specified by:
collectDouble
in interfaceRichIterable<T>
- Overrides:
collectDouble
in classAbstractUnmodifiableMutableCollection<T>
-
collectFloat
Description copied from interface:MutableCollection
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
Co-variant example for MutableCollection:MutableFloatCollection floats = people.collectFloat(person -> person.getHeightInInches());
- Specified by:
collectFloat
in interfaceListIterable<T>
- Specified by:
collectFloat
in interfaceMutableCollection<T>
- Specified by:
collectFloat
in interfaceMutableList<T>
- Specified by:
collectFloat
in interfaceOrderedIterable<T>
- Specified by:
collectFloat
in interfaceReversibleIterable<T>
- Specified by:
collectFloat
in interfaceRichIterable<T>
- Overrides:
collectFloat
in classAbstractUnmodifiableMutableCollection<T>
-
collectInt
Description copied from interface:MutableCollection
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
Co-variant example for MutableCollection:MutableIntCollection ints = people.collectInt(person -> person.getAge());
- Specified by:
collectInt
in interfaceListIterable<T>
- Specified by:
collectInt
in interfaceMutableCollection<T>
- Specified by:
collectInt
in interfaceMutableList<T>
- Specified by:
collectInt
in interfaceOrderedIterable<T>
- Specified by:
collectInt
in interfaceReversibleIterable<T>
- Specified by:
collectInt
in interfaceRichIterable<T>
- Overrides:
collectInt
in classAbstractUnmodifiableMutableCollection<T>
-
collectLong
Description copied from interface:MutableCollection
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
Co-variant example for MutableCollection:MutableLongCollection longs = people.collectLong(person -> person.getGuid());
- Specified by:
collectLong
in interfaceListIterable<T>
- Specified by:
collectLong
in interfaceMutableCollection<T>
- Specified by:
collectLong
in interfaceMutableList<T>
- Specified by:
collectLong
in interfaceOrderedIterable<T>
- Specified by:
collectLong
in interfaceReversibleIterable<T>
- Specified by:
collectLong
in interfaceRichIterable<T>
- Overrides:
collectLong
in classAbstractUnmodifiableMutableCollection<T>
-
collectShort
Description copied from interface:MutableCollection
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
Co-variant example for MutableCollection:MutableShortCollection shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
- Specified by:
collectShort
in interfaceListIterable<T>
- Specified by:
collectShort
in interfaceMutableCollection<T>
- Specified by:
collectShort
in interfaceMutableList<T>
- Specified by:
collectShort
in interfaceOrderedIterable<T>
- Specified by:
collectShort
in interfaceReversibleIterable<T>
- Specified by:
collectShort
in interfaceRichIterable<T>
- Overrides:
collectShort
in classAbstractUnmodifiableMutableCollection<T>
-
flatCollect
Description copied from interface:MutableCollection
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
returns a collection, the result is a collection of collections.flatCollect
outputs a single "flattened" collection instead. This method is commonly called flatMap.Consider the following example where we have a
Person
class, and eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
returns 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:
flatCollect
in interfaceListIterable<T>
- Specified by:
flatCollect
in interfaceMutableCollection<T>
- Specified by:
flatCollect
in interfaceMutableList<T>
- Specified by:
flatCollect
in interfaceOrderedIterable<T>
- Specified by:
flatCollect
in interfaceReversibleIterable<T>
- Specified by:
flatCollect
in interfaceRichIterable<T>
- Overrides:
flatCollect
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
function
- TheFunction
to 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:MutableCollection
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.MutableCollection<String> collected = Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
- Specified by:
collectIf
in interfaceListIterable<T>
- Specified by:
collectIf
in interfaceMutableCollection<T>
- Specified by:
collectIf
in interfaceMutableList<T>
- Specified by:
collectIf
in interfaceOrderedIterable<T>
- Specified by:
collectIf
in interfaceReversibleIterable<T>
- Specified by:
collectIf
in interfaceRichIterable<T>
- Overrides:
collectIf
in classAbstractUnmodifiableMutableCollection<T>
-
detectIndex
Description copied from interface:OrderedIterable
Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectIndex
in interfaceOrderedIterable<T>
-
detectLastIndex
Description copied from interface:ReversibleIterable
Returns the index of the last element of theReversibleIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectLastIndex
in interfaceReversibleIterable<T>
-
groupBy
Description copied from interface:MutableCollection
For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.Example using a Java 8 method reference:
Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
Co-variant example for MutableCollection:MutableMultimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
- Specified by:
groupBy
in interfaceListIterable<T>
- Specified by:
groupBy
in interfaceMutableCollection<T>
- Specified by:
groupBy
in interfaceMutableList<T>
- Specified by:
groupBy
in interfaceOrderedIterable<T>
- Specified by:
groupBy
in interfaceReversibleIterable<T>
- Specified by:
groupBy
in interfaceRichIterable<T>
- Overrides:
groupBy
in classAbstractUnmodifiableMutableCollection<T>
-
groupByEach
public <V> MutableListMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceListIterable<T>
- Specified by:
groupByEach
in interfaceMutableCollection<T>
- Specified by:
groupByEach
in interfaceMutableList<T>
- Specified by:
groupByEach
in interfaceOrderedIterable<T>
- Specified by:
groupByEach
in interfaceReversibleIterable<T>
- Specified by:
groupByEach
in interfaceRichIterable<T>
- Overrides:
groupByEach
in classAbstractUnmodifiableMutableCollection<T>
-
reject
Description copied from interface:MutableCollection
Returns a MutableCollection with all elements that evaluate to false for the specified predicate.MutableCollection<Person> notSmiths = people.reject(person -> person.person.getLastName().equals("Smith"));
Using thePredicates
factory:MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
- Specified by:
reject
in interfaceListIterable<T>
- Specified by:
reject
in interfaceMutableCollection<T>
- Specified by:
reject
in interfaceMutableList<T>
- Specified by:
reject
in interfaceOrderedIterable<T>
- Specified by:
reject
in interfaceReversibleIterable<T>
- Specified by:
reject
in interfaceRichIterable<T>
- Overrides:
reject
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
rejectWith
Description copied from interface:MutableCollection
Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.e.g. MutableCollection<Integer> selected = integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));
- Specified by:
rejectWith
in interfaceListIterable<T>
- Specified by:
rejectWith
in interfaceMutableCollection<T>
- Specified by:
rejectWith
in interfaceMutableList<T>
- Specified by:
rejectWith
in interfaceOrderedIterable<T>
- Specified by:
rejectWith
in interfaceReversibleIterable<T>
- Specified by:
rejectWith
in interfaceRichIterable<T>
- Overrides:
rejectWith
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
select
Description copied from interface:MutableCollection
Returns a MutableCollection with all elements that evaluate to true for the specified predicate.MutableCollection<Integer> livesInLondon = people.select(person -> person.getAddress().getCity().equals("London"));
- Specified by:
select
in interfaceListIterable<T>
- Specified by:
select
in interfaceMutableCollection<T>
- Specified by:
select
in interfaceMutableList<T>
- Specified by:
select
in interfaceOrderedIterable<T>
- Specified by:
select
in interfaceReversibleIterable<T>
- Specified by:
select
in interfaceRichIterable<T>
- Overrides:
select
in classAbstractUnmodifiableMutableCollection<T>
-
selectWith
Description copied from interface:MutableCollection
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.MutableCollection<Integer> fives = integers.selectWith(Predicates2.equal(), Integer.valueOf(5));
- Specified by:
selectWith
in interfaceListIterable<T>
- Specified by:
selectWith
in interfaceMutableCollection<T>
- Specified by:
selectWith
in interfaceMutableList<T>
- Specified by:
selectWith
in interfaceOrderedIterable<T>
- Specified by:
selectWith
in interfaceReversibleIterable<T>
- Specified by:
selectWith
in interfaceRichIterable<T>
- Overrides:
selectWith
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
partition
Description copied from interface:MutableCollection
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
Co-variant example for MutableCollection:PartitionMutableCollection<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
- Specified by:
partition
in interfaceListIterable<T>
- Specified by:
partition
in interfaceMutableCollection<T>
- Specified by:
partition
in interfaceMutableList<T>
- Specified by:
partition
in interfaceOrderedIterable<T>
- Specified by:
partition
in interfaceReversibleIterable<T>
- Specified by:
partition
in interfaceRichIterable<T>
- Overrides:
partition
in classAbstractUnmodifiableMutableCollection<T>
-
partitionWith
public <P> PartitionMutableList<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)Description copied from interface:MutableCollection
Filters a collection into a PartitionIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
Co-variant example for MutableCollection:PartitionMutableCollection<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
- Specified by:
partitionWith
in interfaceListIterable<T>
- Specified by:
partitionWith
in interfaceMutableCollection<T>
- Specified by:
partitionWith
in interfaceMutableList<T>
- Specified by:
partitionWith
in interfaceOrderedIterable<T>
- Specified by:
partitionWith
in interfaceReversibleIterable<T>
- Specified by:
partitionWith
in interfaceRichIterable<T>
- Overrides:
partitionWith
in classAbstractUnmodifiableMutableCollection<T>
-
selectInstancesOf
Description copied from interface:MutableCollection
Returns 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:
selectInstancesOf
in interfaceListIterable<T>
- Specified by:
selectInstancesOf
in interfaceMutableCollection<T>
- Specified by:
selectInstancesOf
in interfaceMutableList<T>
- Specified by:
selectInstancesOf
in interfaceOrderedIterable<T>
- Specified by:
selectInstancesOf
in interfaceReversibleIterable<T>
- Specified by:
selectInstancesOf
in interfaceRichIterable<T>
- Overrides:
selectInstancesOf
in classAbstractUnmodifiableMutableCollection<T>
-
distinct
Description copied from interface:MutableList
Returns a newListIterable
containing the distinct elements in this list.- Specified by:
distinct
in interfaceListIterable<T>
- Specified by:
distinct
in interfaceMutableList<T>
- Specified by:
distinct
in interfaceOrderedIterable<T>
- Specified by:
distinct
in interfaceReversibleIterable<T>
- Returns:
ListIterable
of distinct elements
-
distinct
Description copied from interface:MutableList
Returns a newListIterable
containing the distinct elements in this list. Takes HashingStrategy.- Specified by:
distinct
in interfaceListIterable<T>
- Specified by:
distinct
in interfaceMutableList<T>
- Returns:
ListIterable
of distinct elements
-
distinctBy
Description copied from interface:ListIterable
Returns a newListIterable
containing the distinct elements in this list. The specified function will be used to create a HashingStrategy to unique the elements.- Specified by:
distinctBy
in interfaceListIterable<T>
- Specified by:
distinctBy
in interfaceMutableList<T>
- Since:
- 9.0.
- See Also:
ListIterable.distinct(HashingStrategy)
-
zip
Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceListIterable<T>
- Specified by:
zip
in interfaceMutableCollection<T>
- Specified by:
zip
in interfaceMutableList<T>
- Specified by:
zip
in interfaceOrderedIterable<T>
- Specified by:
zip
in interfaceReversibleIterable<T>
- Specified by:
zip
in interfaceRichIterable<T>
- Overrides:
zip
in classAbstractUnmodifiableMutableCollection<T>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceListIterable<T>
- Specified by:
zipWithIndex
in interfaceMutableCollection<T>
- Specified by:
zipWithIndex
in interfaceMutableList<T>
- Specified by:
zipWithIndex
in interfaceOrderedIterable<T>
- Specified by:
zipWithIndex
in interfaceReversibleIterable<T>
- Specified by:
zipWithIndex
in interfaceRichIterable<T>
- Overrides:
zipWithIndex
in classAbstractUnmodifiableMutableCollection<T>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
take
Description copied from interface:ReversibleIterable
Returns the firstcount
elements of the iterable or all the elements in the iterable ifcount
is greater than the length of the iterable.- Specified by:
take
in interfaceListIterable<T>
- Specified by:
take
in interfaceMutableList<T>
- Specified by:
take
in interfaceReversibleIterable<T>
- Parameters:
count
- the number of items to take.
-
takeWhile
Description copied from interface:ListIterable
Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
takeWhile
in interfaceListIterable<T>
- Specified by:
takeWhile
in interfaceMutableList<T>
- Specified by:
takeWhile
in interfaceOrderedIterable<T>
- Specified by:
takeWhile
in interfaceReversibleIterable<T>
-
drop
Description copied from interface:ReversibleIterable
Returns an iterable after skipping the firstcount
elements or an empty iterable if thecount
is greater than the length of the iterable.- Specified by:
drop
in interfaceListIterable<T>
- Specified by:
drop
in interfaceMutableList<T>
- Specified by:
drop
in interfaceReversibleIterable<T>
- Parameters:
count
- the number of items to drop.
-
dropWhile
Description copied from interface:ListIterable
Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
dropWhile
in interfaceListIterable<T>
- Specified by:
dropWhile
in interfaceMutableList<T>
- Specified by:
dropWhile
in interfaceOrderedIterable<T>
- Specified by:
dropWhile
in interfaceReversibleIterable<T>
-
partitionWhile
Description copied from interface:ListIterable
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.- Specified by:
partitionWhile
in interfaceListIterable<T>
- Specified by:
partitionWhile
in interfaceMutableList<T>
- Specified by:
partitionWhile
in interfaceOrderedIterable<T>
- Specified by:
partitionWhile
in interfaceReversibleIterable<T>
-
asReversed
Description copied from interface:ReversibleIterable
Returns a reversed view of this ReversibleIterable.- Specified by:
asReversed
in interfaceReversibleIterable<T>
-
asParallel
Description copied from interface:ListIterable
Returns a parallel iterable of this ListIterable.- Specified by:
asParallel
in interfaceListIterable<T>
-
with
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.with("1"); list = list.with("2"); return list;
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.- Specified by:
with
in interfaceMutableCollection<T>
- Specified by:
with
in interfaceMutableList<T>
- Overrides:
with
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.add(Object)
-
without
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.without("1"); list = list.without("2"); return list;
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.- Specified by:
without
in interfaceMutableCollection<T>
- Specified by:
without
in interfaceMutableList<T>
- Overrides:
without
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.remove(Object)
-
withAll
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.- Specified by:
withAll
in interfaceMutableCollection<T>
- Specified by:
withAll
in interfaceMutableList<T>
- Overrides:
withAll
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.addAll(Collection)
-
withoutAll
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.- Specified by:
withoutAll
in interfaceMutableCollection<T>
- Specified by:
withoutAll
in interfaceMutableList<T>
- Overrides:
withoutAll
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.removeAll(Collection)
-