java.lang.Cloneable
, java.util.Collection<T>
, InternalIterable<T>
, java.lang.Iterable<T>
, java.util.List<T>
, ListIterable<T>
, MutableCollection<T>
, OrderedIterable<T>
, ReversibleIterable<T>
, RichIterable<T>
FixedSizeList<T>
, MultiReaderList<T>
AbstractArrayAdapter
, AbstractListAdapter
, AbstractMemoryEfficientMutableList
, AbstractMutableList
, ArrayAdapter
, ArrayListAdapter
, CompositeFastList
, FastList
, ListAdapter
, MultiReaderFastList
, RandomAccessListAdapter
, SynchronizedMutableList
, UnmodifiableMutableList
public interface MutableList<T> extends MutableCollection<T>, java.util.List<T>, java.lang.Cloneable, ListIterable<T>
Modifier and Type | Method | Description |
---|---|---|
MutableList<T> |
asSynchronized() |
Returns a synchronized wrapper backed by this collection.
|
MutableList<T> |
asUnmodifiable() |
Returns an unmodifiable view of the list.
|
MutableList<T> |
clone() |
|
default <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 primitive
boolean 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 primitive
byte 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 primitive
char 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 primitive
double 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 primitive
float iterable with the results of applying the specified function on each element
of the source collection. |
default <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 primitive
int 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 primitive
long 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 primitive
short iterable with the results of applying the specified function on each element
of the source collection. |
default <P,V> MutableList<V> |
collectWith(Function2<? super T,? super P,? extends V> function,
P parameter) |
Same as
RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block. |
default <V> MutableList<V> |
collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function) |
Returns a new OrderedIterable using results obtained by applying the specified function to each element
and its corresponding index.
|
MutableList<T> |
distinct() |
Returns a new
ListIterable containing the distinct elements in this list. |
MutableList<T> |
distinct(HashingStrategy<? super T> hashingStrategy) |
Returns a new
ListIterable containing the distinct elements in this list. |
<V> MutableList<T> |
distinctBy(Function<? super T,? extends V> function) |
Returns a new
ListIterable containing the distinct elements in this list. |
MutableList<T> |
drop(int count) |
Returns an iterable after skipping the first
count elements
or an empty iterable if the count 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.
|
default <V> MutableList<V> |
flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function) |
flatCollect is a special case of RichIterable.collect(Function) . |
default <P,V> MutableList<V> |
flatCollectWith(Function2<? super T,? super P,? extends java.lang.Iterable<V>> function,
P parameter) |
|
<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 to
RichIterable.groupBy(Function) , except the result of evaluating function will return a collection of keys
for each value. |
MutableList<T> |
newEmpty() |
Creates a new empty mutable version of the same collection type.
|
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.
|
default MutableList<T> |
reject(Predicate<? super T> predicate) |
Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
|
default <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.
|
default MutableList<T> |
reverseThis() |
Mutates this list by reversing its order and returns the current list as a result.
|
default 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(java.lang.Class<S> clazz) |
Returns all elements of the source collection that are instances of the Class
clazz . |
default <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.
|
default MutableList<T> |
shuffleThis() |
Mutates this list by shuffling its elements.
|
default MutableList<T> |
shuffleThis(java.util.Random random) |
Mutates this list by shuffling its elements using the specified random.
|
default MutableList<T> |
sortThis() |
Sorts the internal data structure of this list and returns the list itself as a convenience.
|
default MutableList<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>> |
sortThisBy(Function<? super T,? extends V> function) |
Sorts the internal data structure of this list based on the natural order of the attribute returned by
function . |
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) |
|
MutableList<T> |
subList(int fromIndex,
int toIndex) |
|
MutableList<T> |
take(int count) |
Returns the first
count elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable. |
MutableList<T> |
takeWhile(Predicate<? super T> predicate) |
Returns the initial elements that satisfy the Predicate.
|
default MutableList<T> |
tap(Procedure<? super T> procedure) |
Executes the Procedure for each element in the iterable and returns
this . |
default ImmutableList<T> |
toImmutable() |
Returns an immutable copy of this list.
|
default MutableList<T> |
toReversed() |
Returns a new MutableList in reverse order.
|
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(java.lang.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(java.lang.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(java.lang.Iterable<S> that) |
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
MutableList<Pair<T,java.lang.Integer>> |
zipWithIndex() |
Zips this
RichIterable with its indices. |
forEachWith
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, toArray, toArray
asParallel, binarySearch, binarySearch, equals, get, getFirst, getLast, hashCode, lastIndexOf, listIterator, listIterator, toStack
addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong
collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, indexOf
asReversed, detectLastIndex, reverseForEach, reverseForEachWithIndex
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectWith, 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
MutableList<T> with(T element)
MutableCollection
MutableCollection<String> list = list.with("1"); list = list.with("2"); return list;In the case of
FixedSizeCollection
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.with
in interface MutableCollection<T>
Collection.add(Object)
MutableList<T> without(T element)
MutableCollection
MutableCollection<String> list = list.without("1"); list = list.without("2"); return list;In the case of
FixedSizeCollection
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.without
in interface MutableCollection<T>
Collection.remove(Object)
MutableList<T> withAll(java.lang.Iterable<? extends T> elements)
MutableCollection
MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));In the case of
FixedSizeCollection
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.withAll
in interface MutableCollection<T>
Collection.addAll(Collection)
MutableList<T> withoutAll(java.lang.Iterable<? extends T> elements)
MutableCollection
MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));In the case of
FixedSizeCollection
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.withoutAll
in interface MutableCollection<T>
Collection.removeAll(Collection)
MutableList<T> newEmpty()
MutableCollection
newEmpty
in interface MutableCollection<T>
MutableList<T> clone()
default MutableList<T> tap(Procedure<? super T> procedure)
RichIterable
this
.
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()); } });
tap
in interface ListIterable<T>
tap
in interface MutableCollection<T>
tap
in interface OrderedIterable<T>
tap
in interface ReversibleIterable<T>
tap
in interface RichIterable<T>
RichIterable.each(Procedure)
,
RichIterable.forEach(Procedure)
default MutableList<T> select(Predicate<? super T> predicate)
MutableCollection
MutableCollection<Integer> livesInLondon = people.select(person -> person.getAddress().getCity().equals("London"));
select
in interface ListIterable<T>
select
in interface MutableCollection<T>
select
in interface OrderedIterable<T>
select
in interface ReversibleIterable<T>
select
in interface RichIterable<T>
default <P> MutableList<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
MutableCollection<Integer> fives = integers.selectWith(Predicates2.equal(), Integer.valueOf(5));
selectWith
in interface ListIterable<T>
selectWith
in interface MutableCollection<T>
selectWith
in interface OrderedIterable<T>
selectWith
in interface ReversibleIterable<T>
selectWith
in interface RichIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
default MutableList<T> reject(Predicate<? super T> predicate)
MutableCollection
MutableCollection<Person> notSmiths = people.reject(person -> person.person.getLastName().equals("Smith"));Using the
Predicates
factory:
MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject
in interface ListIterable<T>
reject
in interface MutableCollection<T>
reject
in interface OrderedIterable<T>
reject
in interface ReversibleIterable<T>
reject
in interface RichIterable<T>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to falsedefault <P> MutableList<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
e.g. MutableCollection<Integer> selected = integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));
rejectWith
in interface ListIterable<T>
rejectWith
in interface MutableCollection<T>
rejectWith
in interface OrderedIterable<T>
rejectWith
in interface ReversibleIterable<T>
rejectWith
in interface RichIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
PartitionMutableList<T> partition(Predicate<? super T> predicate)
MutableCollection
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"));
partition
in interface ListIterable<T>
partition
in interface MutableCollection<T>
partition
in interface OrderedIterable<T>
partition
in interface ReversibleIterable<T>
partition
in interface RichIterable<T>
<P> PartitionMutableList<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
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");
partitionWith
in interface ListIterable<T>
partitionWith
in interface MutableCollection<T>
partitionWith
in interface OrderedIterable<T>
partitionWith
in interface ReversibleIterable<T>
partitionWith
in interface RichIterable<T>
<S> MutableList<S> selectInstancesOf(java.lang.Class<S> clazz)
MutableCollection
clazz
.
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);
selectInstancesOf
in interface ListIterable<T>
selectInstancesOf
in interface MutableCollection<T>
selectInstancesOf
in interface OrderedIterable<T>
selectInstancesOf
in interface ReversibleIterable<T>
selectInstancesOf
in interface RichIterable<T>
default <V> MutableList<V> collect(Function<? super T,? extends V> function)
MutableCollection
MutableCollection<String> names = people.collect(person -> person.getFirstName() + " " + person.getLastName());
collect
in interface ListIterable<T>
collect
in interface MutableCollection<T>
collect
in interface OrderedIterable<T>
collect
in interface ReversibleIterable<T>
collect
in interface RichIterable<T>
default <V> MutableList<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)
OrderedIterable
collectWithIndex
in interface ListIterable<T>
collectWithIndex
in interface OrderedIterable<T>
collectWithIndex
in interface ReversibleIterable<T>
MutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)
MutableCollection
boolean
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
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());
collectBoolean
in interface ListIterable<T>
collectBoolean
in interface MutableCollection<T>
collectBoolean
in interface OrderedIterable<T>
collectBoolean
in interface ReversibleIterable<T>
collectBoolean
in interface RichIterable<T>
MutableByteList collectByte(ByteFunction<? super T> byteFunction)
MutableCollection
byte
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
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());
collectByte
in interface ListIterable<T>
collectByte
in interface MutableCollection<T>
collectByte
in interface OrderedIterable<T>
collectByte
in interface ReversibleIterable<T>
collectByte
in interface RichIterable<T>
MutableCharList collectChar(CharFunction<? super T> charFunction)
MutableCollection
char
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
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());
collectChar
in interface ListIterable<T>
collectChar
in interface MutableCollection<T>
collectChar
in interface OrderedIterable<T>
collectChar
in interface ReversibleIterable<T>
collectChar
in interface RichIterable<T>
MutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)
MutableCollection
double
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
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());
collectDouble
in interface ListIterable<T>
collectDouble
in interface MutableCollection<T>
collectDouble
in interface OrderedIterable<T>
collectDouble
in interface ReversibleIterable<T>
collectDouble
in interface RichIterable<T>
MutableFloatList collectFloat(FloatFunction<? super T> floatFunction)
MutableCollection
float
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
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());
collectFloat
in interface ListIterable<T>
collectFloat
in interface MutableCollection<T>
collectFloat
in interface OrderedIterable<T>
collectFloat
in interface ReversibleIterable<T>
collectFloat
in interface RichIterable<T>
MutableIntList collectInt(IntFunction<? super T> intFunction)
MutableCollection
int
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
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());
collectInt
in interface ListIterable<T>
collectInt
in interface MutableCollection<T>
collectInt
in interface OrderedIterable<T>
collectInt
in interface ReversibleIterable<T>
collectInt
in interface RichIterable<T>
MutableLongList collectLong(LongFunction<? super T> longFunction)
MutableCollection
long
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
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());
collectLong
in interface ListIterable<T>
collectLong
in interface MutableCollection<T>
collectLong
in interface OrderedIterable<T>
collectLong
in interface ReversibleIterable<T>
collectLong
in interface RichIterable<T>
MutableShortList collectShort(ShortFunction<? super T> shortFunction)
MutableCollection
short
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
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());
collectShort
in interface ListIterable<T>
collectShort
in interface MutableCollection<T>
collectShort
in interface OrderedIterable<T>
collectShort
in interface ReversibleIterable<T>
collectShort
in interface RichIterable<T>
default <P,V> MutableList<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
MutableCollection
RichIterable.collect(Function)
with a Function2
and specified parameter which is passed to the block.
Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
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));
collectWith
in interface ListIterable<T>
collectWith
in interface MutableCollection<T>
collectWith
in interface OrderedIterable<T>
collectWith
in interface ReversibleIterable<T>
collectWith
in interface RichIterable<T>
function
- A Function2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argument P
in function
RichIterable
that contains the transformed elements returned by Function2.value(Object, Object)
RichIterable.collect(Function)
default <V> MutableList<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
MutableCollection
MutableCollection<String> collected = Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf
in interface ListIterable<T>
collectIf
in interface MutableCollection<T>
collectIf
in interface OrderedIterable<T>
collectIf
in interface ReversibleIterable<T>
collectIf
in interface RichIterable<T>
default <V> MutableList<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
MutableCollection
flatCollect
is a special case of RichIterable.collect(Function)
. With collect
, when the Function
returns
a collection, the result is a collection of collections. flatCollect
outputs a single "flattened" collection
instead. This method is commonly called flatMap.
Consider the following example where we have a Person
class, and each Person
has a list of Address
objects. Take the following Function
:
Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;Using
collect
returns a collection of collections of addresses.
RichIterable<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect
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);
flatCollect
in interface ListIterable<T>
flatCollect
in interface MutableCollection<T>
flatCollect
in interface OrderedIterable<T>
flatCollect
in interface ReversibleIterable<T>
flatCollect
in interface RichIterable<T>
function
- The Function
to applyfunction
default <P,V> MutableList<V> flatCollectWith(Function2<? super T,? super P,? extends java.lang.Iterable<V>> function, P parameter)
flatCollectWith
in interface ListIterable<T>
flatCollectWith
in interface MutableCollection<T>
flatCollectWith
in interface OrderedIterable<T>
flatCollectWith
in interface ReversibleIterable<T>
flatCollectWith
in interface RichIterable<T>
MutableList<T> distinct()
ListIterable
containing the distinct elements in this list.distinct
in interface ListIterable<T>
distinct
in interface OrderedIterable<T>
distinct
in interface ReversibleIterable<T>
ListIterable
of distinct elementsMutableList<T> distinct(HashingStrategy<? super T> hashingStrategy)
ListIterable
containing the distinct elements in this list. Takes HashingStrategy.distinct
in interface ListIterable<T>
ListIterable
of distinct elements<V> MutableList<T> distinctBy(Function<? super T,? extends V> function)
ListIterable
ListIterable
containing the distinct elements in this list.
The specified function will be used to create a HashingStrategy to unique the elements.distinctBy
in interface ListIterable<T>
ListIterable.distinct(HashingStrategy)
default MutableList<T> sortThis(java.util.Comparator<? super T> comparator)
default MutableList<T> sortThis()
<V extends java.lang.Comparable<? super V>> MutableList<T> sortThisBy(Function<? super T,? extends V> function)
function
.MutableList<T> sortThisByInt(IntFunction<? super T> function)
MutableList<T> sortThisByBoolean(BooleanFunction<? super T> function)
MutableList<T> sortThisByChar(CharFunction<? super T> function)
MutableList<T> sortThisByByte(ByteFunction<? super T> function)
MutableList<T> sortThisByShort(ShortFunction<? super T> function)
MutableList<T> sortThisByFloat(FloatFunction<? super T> function)
MutableList<T> sortThisByLong(LongFunction<? super T> function)
MutableList<T> sortThisByDouble(DoubleFunction<? super T> function)
MutableList<T> subList(int fromIndex, int toIndex)
subList
in interface java.util.List<T>
subList
in interface ListIterable<T>
List.subList(int, int)
MutableList<T> asUnmodifiable()
asUnmodifiable
in interface MutableCollection<T>
Collections.unmodifiableCollection(Collection)
MutableList<T> asSynchronized()
MutableCollection
Collections.synchronizedCollection(this)
only with a return type that supports the full
iteration protocols available on MutableCollection
.
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.
asSynchronized
in interface MutableCollection<T>
Collections.synchronizedCollection(Collection)
default ImmutableList<T> toImmutable()
toImmutable
in interface ListIterable<T>
toImmutable
in interface MutableCollection<T>
<V> MutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
MutableCollection
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);
groupBy
in interface ListIterable<T>
groupBy
in interface MutableCollection<T>
groupBy
in interface OrderedIterable<T>
groupBy
in interface ReversibleIterable<T>
groupBy
in interface RichIterable<T>
<V> MutableListMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface ListIterable<T>
groupByEach
in interface MutableCollection<T>
groupByEach
in interface OrderedIterable<T>
groupByEach
in interface ReversibleIterable<T>
groupByEach
in interface RichIterable<T>
<S> MutableList<Pair<T,S>> zip(java.lang.Iterable<S> that)
RichIterable
RichIterable
formed from this RichIterable
and another RichIterable
by
combining corresponding elements in pairs. If one of the two RichIterable
s is longer than the other, its
remaining elements are ignored.zip
in interface ListIterable<T>
zip
in interface MutableCollection<T>
zip
in interface OrderedIterable<T>
zip
in interface ReversibleIterable<T>
zip
in interface RichIterable<T>
S
- the type of the second half of the returned pairsthat
- The RichIterable
providing the second half of each result pairRichIterable
containing pairs consisting of corresponding elements of this
RichIterable
and that. The length of the returned RichIterable
is the minimum of the lengths of
this RichIterable
and that.MutableList<Pair<T,java.lang.Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface ListIterable<T>
zipWithIndex
in interface MutableCollection<T>
zipWithIndex
in interface OrderedIterable<T>
zipWithIndex
in interface ReversibleIterable<T>
zipWithIndex
in interface RichIterable<T>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
MutableList<T> take(int count)
ReversibleIterable
count
elements of the iterable
or all the elements in the iterable if count
is greater than the length of
the iterable.take
in interface ListIterable<T>
take
in interface ReversibleIterable<T>
count
- the number of items to take.MutableList<T> takeWhile(Predicate<? super T> predicate)
ListIterable
takeWhile
in interface ListIterable<T>
takeWhile
in interface OrderedIterable<T>
takeWhile
in interface ReversibleIterable<T>
MutableList<T> drop(int count)
ReversibleIterable
count
elements
or an empty iterable if the count
is greater than the length of the iterable.drop
in interface ListIterable<T>
drop
in interface ReversibleIterable<T>
count
- the number of items to drop.MutableList<T> dropWhile(Predicate<? super T> predicate)
ListIterable
dropWhile
in interface ListIterable<T>
dropWhile
in interface OrderedIterable<T>
dropWhile
in interface ReversibleIterable<T>
PartitionMutableList<T> partitionWhile(Predicate<? super T> predicate)
ListIterable
partitionWhile
in interface ListIterable<T>
partitionWhile
in interface OrderedIterable<T>
partitionWhile
in interface ReversibleIterable<T>
default MutableList<T> toReversed()
toReversed
in interface ListIterable<T>
toReversed
in interface ReversibleIterable<T>
default MutableList<T> reverseThis()
default MutableList<T> shuffleThis()
default MutableList<T> shuffleThis(java.util.Random random)
Copyright © 2004–2020. All rights reserved.