@Immutable public interface ImmutableList<T> extends ImmutableCollection<T>, ListIterable<T>
MutableList
. MutableList.toImmutable()
will give you an appropriately trimmed implementation of ImmutableList. All ImmutableList implementations must
implement the java.util.List interface so they can satisfy the equals() contract and be compared against other list
structures like FastList or ArrayList.Modifier and Type | Method and Description |
---|---|
List<T> |
castToList() |
<V> ImmutableList<V> |
collect(Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
ImmutableBooleanList |
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. |
ImmutableByteList |
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. |
ImmutableCharList |
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. |
ImmutableDoubleList |
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. |
ImmutableFloatList |
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. |
<V> ImmutableList<V> |
collectIf(Predicate<? super T> predicate,
Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection, but only for those elements which return true upon evaluation of the predicate.
|
ImmutableIntList |
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. |
ImmutableLongList |
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. |
ImmutableShortList |
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. |
<P,V> ImmutableList<V> |
collectWith(Function2<? super T,? super P,? extends V> function,
P parameter)
Same as collect with a
Function2 and specified parameter which is passed to the block
|
ImmutableList<T> |
distinct()
Returns a new
ListIterable containing the distinct elements in this list. |
ImmutableList<T> |
dropWhile(Predicate<? super T> predicate)
Returns the final elements that do not satisfy the Predicate.
|
<V> ImmutableList<V> |
flatCollect(Function<? super T,? extends Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function) . |
<V> ImmutableListMultimap<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> ImmutableListMultimap<V,T> |
groupByEach(Function<? super T,? extends Iterable<V>> function)
Similar to
RichIterable.groupBy(Function) , except the result of evaluating function will return a collection of keys
for each value. |
ImmutableList<T> |
newWith(T element) |
ImmutableList<T> |
newWithAll(Iterable<? extends T> elements) |
ImmutableList<T> |
newWithout(T element) |
ImmutableList<T> |
newWithoutAll(Iterable<? extends T> elements) |
PartitionImmutableList<T> |
partition(Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
PartitionImmutableList<T> |
partitionWhile(Predicate<? super T> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
<P> PartitionImmutableList<T> |
partitionWith(Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
ImmutableList<T> |
reject(Predicate<? super T> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
<P> ImmutableList<T> |
rejectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.reject(Predicate) , except with an evaluation parameter for the second generic argument in Predicate2 . |
ImmutableList<T> |
select(Predicate<? super T> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
<S> ImmutableList<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz . |
<P> ImmutableList<T> |
selectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.select(Predicate) , except with an evaluation parameter for the second generic argument in Predicate2 . |
ImmutableList<T> |
takeWhile(Predicate<? super T> predicate)
Returns the initial elements that satisfy the Predicate.
|
<S> ImmutableList<Pair<T,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ImmutableList<Pair<T,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
aggregateBy, aggregateInPlaceBy, groupByUniqueKey
asReversed, binarySearch, binarySearch, equals, forEach, forEachWithIndex, get, getFirst, getLast, hashCode, lastIndexOf, listIterator, listIterator, toImmutable, toStack
indexOf, reverseForEach
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, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
forEach, forEachWith, forEachWithIndex
forEach, iterator, spliterator
ImmutableList<T> newWith(T element)
newWith
in interface ImmutableCollection<T>
ImmutableList<T> newWithout(T element)
newWithout
in interface ImmutableCollection<T>
ImmutableList<T> newWithAll(Iterable<? extends T> elements)
newWithAll
in interface ImmutableCollection<T>
ImmutableList<T> newWithoutAll(Iterable<? extends T> elements)
newWithoutAll
in interface ImmutableCollection<T>
ImmutableList<T> select(Predicate<? super T> predicate)
RichIterable
e.g. return people.select(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getCity().equals("Metuchen"); } });
select
in interface ImmutableCollection<T>
select
in interface ListIterable<T>
select
in interface ReversibleIterable<T>
select
in interface RichIterable<T>
<P> ImmutableList<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
RichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument in Predicate2
.selectWith
in interface ImmutableCollection<T>
selectWith
in interface ListIterable<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)
ImmutableList<T> reject(Predicate<? super T> predicate)
RichIterable
e.g. return people.reject(new Predicate<Person>() { public boolean accept(Person person) { return person.person.getLastName().equals("Smith"); } });
e.g. return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject
in interface ImmutableCollection<T>
reject
in interface ListIterable<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 false<P> ImmutableList<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
RichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument in Predicate2
.rejectWith
in interface ImmutableCollection<T>
rejectWith
in interface ListIterable<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)
PartitionImmutableList<T> partition(Predicate<? super T> predicate)
RichIterable
e.g. return people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
partition
in interface ImmutableCollection<T>
partition
in interface ListIterable<T>
partition
in interface ReversibleIterable<T>
partition
in interface RichIterable<T>
<P> PartitionImmutableList<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
e.g. return people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
partitionWith
in interface ImmutableCollection<T>
partitionWith
in interface ListIterable<T>
partitionWith
in interface RichIterable<T>
<S> ImmutableList<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface ImmutableCollection<T>
selectInstancesOf
in interface ListIterable<T>
selectInstancesOf
in interface ReversibleIterable<T>
selectInstancesOf
in interface RichIterable<T>
<V> ImmutableList<V> collect(Function<? super T,? extends V> function)
RichIterable
e.g. return people.collect(new Function<Person, String>() { public String valueOf(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
collect
in interface ImmutableCollection<T>
collect
in interface ListIterable<T>
collect
in interface ReversibleIterable<T>
collect
in interface RichIterable<T>
ImmutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)
RichIterable
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.
e.g. return people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
collectBoolean
in interface ImmutableCollection<T>
collectBoolean
in interface ListIterable<T>
collectBoolean
in interface ReversibleIterable<T>
collectBoolean
in interface RichIterable<T>
ImmutableByteList collectByte(ByteFunction<? super T> byteFunction)
RichIterable
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.
e.g. return people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
collectByte
in interface ImmutableCollection<T>
collectByte
in interface ListIterable<T>
collectByte
in interface ReversibleIterable<T>
collectByte
in interface RichIterable<T>
ImmutableCharList collectChar(CharFunction<? super T> charFunction)
RichIterable
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.
e.g. return people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
collectChar
in interface ImmutableCollection<T>
collectChar
in interface ListIterable<T>
collectChar
in interface ReversibleIterable<T>
collectChar
in interface RichIterable<T>
ImmutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)
RichIterable
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.
e.g. return people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
collectDouble
in interface ImmutableCollection<T>
collectDouble
in interface ListIterable<T>
collectDouble
in interface ReversibleIterable<T>
collectDouble
in interface RichIterable<T>
ImmutableFloatList collectFloat(FloatFunction<? super T> floatFunction)
RichIterable
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.
e.g. return people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
collectFloat
in interface ImmutableCollection<T>
collectFloat
in interface ListIterable<T>
collectFloat
in interface ReversibleIterable<T>
collectFloat
in interface RichIterable<T>
ImmutableIntList collectInt(IntFunction<? super T> intFunction)
RichIterable
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.
e.g. return people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
collectInt
in interface ImmutableCollection<T>
collectInt
in interface ListIterable<T>
collectInt
in interface ReversibleIterable<T>
collectInt
in interface RichIterable<T>
ImmutableLongList collectLong(LongFunction<? super T> longFunction)
RichIterable
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.
e.g. return people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
collectLong
in interface ImmutableCollection<T>
collectLong
in interface ListIterable<T>
collectLong
in interface ReversibleIterable<T>
collectLong
in interface RichIterable<T>
ImmutableShortList collectShort(ShortFunction<? super T> shortFunction)
RichIterable
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.
e.g. return people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
collectShort
in interface ImmutableCollection<T>
collectShort
in interface ListIterable<T>
collectShort
in interface ReversibleIterable<T>
collectShort
in interface RichIterable<T>
<P,V> ImmutableList<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
RichIterable
Function2
and specified parameter which is passed to the block
e.g. Function2addParameterFunction = new Function2 () { public Integer value(final Integer each, final Integer parameter) { return each + parameter; } }; FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
collectWith
in interface ImmutableCollection<T>
collectWith
in interface ListIterable<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)
<V> ImmutableList<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
RichIterable
e.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf
in interface ImmutableCollection<T>
collectIf
in interface ListIterable<T>
collectIf
in interface ReversibleIterable<T>
collectIf
in interface RichIterable<T>
<V> ImmutableList<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
RichIterable
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 = new Function<Person, List<Address>>() { public List<Address> valueOf(Person person) { return person.getAddresses(); } }; MutableList<Person> people = ...;Using
collect
returns a collection of collections of addresses.
MutableList<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect
returns a single flattened list of addresses.
MutableList<Address> addresses = people.flatCollect(addressFunction);
flatCollect
in interface ImmutableCollection<T>
flatCollect
in interface ListIterable<T>
flatCollect
in interface ReversibleIterable<T>
flatCollect
in interface RichIterable<T>
function
- The Function
to applyfunction
<V> ImmutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
RichIterable
e.g. return people.groupBy(new Function<Person, String>() { public String value(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
groupBy
in interface ImmutableCollection<T>
groupBy
in interface ListIterable<T>
groupBy
in interface ReversibleIterable<T>
groupBy
in interface RichIterable<T>
<V> ImmutableListMultimap<V,T> groupByEach(Function<? super T,? extends 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 ImmutableCollection<T>
groupByEach
in interface ListIterable<T>
groupByEach
in interface ReversibleIterable<T>
groupByEach
in interface RichIterable<T>
ImmutableList<T> distinct()
ListIterable
ListIterable
containing the distinct elements in this list.
Conceptually similar to RichIterable.toSet()
.RichIterable.toList()
but retains the original order. If an element appears
multiple times in this list, the first one will be copied into the result.distinct
in interface ListIterable<T>
distinct
in interface ReversibleIterable<T>
ListIterable
of distinct elements<S> ImmutableList<Pair<T,S>> zip(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 ImmutableCollection<T>
zip
in interface ListIterable<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.ImmutableList<Pair<T,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface ImmutableCollection<T>
zipWithIndex
in interface ListIterable<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)
ImmutableList<T> takeWhile(Predicate<? super T> predicate)
ListIterable
takeWhile
in interface ListIterable<T>
takeWhile
in interface ReversibleIterable<T>
ImmutableList<T> dropWhile(Predicate<? super T> predicate)
ListIterable
dropWhile
in interface ListIterable<T>
dropWhile
in interface ReversibleIterable<T>
PartitionImmutableList<T> partitionWhile(Predicate<? super T> predicate)
ListIterable
partitionWhile
in interface ListIterable<T>
partitionWhile
in interface ReversibleIterable<T>
Copyright © 2004–2017. All rights reserved.