public final class ListAdapter<T> extends AbstractListAdapter<T> implements java.io.Serializable
adapt(List) factory method.| Modifier and Type | Method and Description |
|---|---|
static <E> com.gs.collections.api.list.MutableList<E> |
adapt(java.util.List<E> list) |
boolean |
allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
|
boolean |
anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns true if the predicate evaluates to true for any element of the iterable.
|
com.gs.collections.api.list.MutableList<T> |
asSynchronized()
Returns a synchronized (thread-safe) collection backed by this collection.
|
com.gs.collections.api.list.MutableList<T> |
asUnmodifiable()
Returns an unmodifable view of the list.
|
com.gs.collections.api.list.MutableList<T> |
clone() |
<V> com.gs.collections.api.list.MutableList<V> |
collect(com.gs.collections.api.block.function.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.
|
com.gs.collections.api.list.primitive.MutableBooleanList |
collectBoolean(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableByteList |
collectByte(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableCharList |
collectChar(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableDoubleList |
collectDouble(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableFloatList |
collectFloat(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.list.MutableList<V> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
com.gs.collections.api.block.function.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.
|
com.gs.collections.api.list.primitive.MutableIntList |
collectInt(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableLongList |
collectLong(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableShortList |
collectShort(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.list.MutableList<V> |
collectWith(com.gs.collections.api.block.function.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
|
int |
count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Return the total number of elements that answer true to the specified predicate.
|
T |
detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no
element returns true.
|
T |
detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
com.gs.collections.api.block.function.Function0<? extends T> function)
Returns the first element of the iterable for which the predicate evaluates to true.
|
com.gs.collections.api.list.MutableList<T> |
distinct()
Returns a new
ListIterable containing the distinct elements in this list. |
com.gs.collections.api.list.MutableList<T> |
dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the final elements that do not satisfy the Predicate.
|
<V> com.gs.collections.api.list.MutableList<V> |
flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function). |
void |
forEach(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
Iterates over the section of the list covered by the specified inclusive indexes.
|
void |
forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
The procedure is executed for each element in the iterable.
|
void |
forEachWithIndex(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
Iterates over the section of the list covered by the specified inclusive indexes.
|
void |
forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
Iterates over the iterable passing each element and the current relative int index to the specified instance of
ObjectIntProcedure
|
protected java.util.List<T> |
getDelegate() |
<V> FastListMultimap<V,T> |
groupBy(com.gs.collections.api.block.function.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> FastListMultimap<V,T> |
groupByEach(com.gs.collections.api.block.function.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. |
<IV> IV |
injectInto(IV injectedValue,
com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)
Returns the final result of evaluating function using each element of the iterable and the previous evaluation
result as the parameters.
|
com.gs.collections.api.list.MutableList<T> |
newEmpty()
Deprecated.
use
FastList.newList() instead (inlineable) |
com.gs.collections.api.partition.list.PartitionMutableList<T> |
partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
com.gs.collections.api.partition.list.PartitionMutableList<T> |
partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
com.gs.collections.api.list.MutableList<T> |
reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
|
<P> com.gs.collections.api.list.MutableList<T> |
rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
|
void |
reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
Evaluates the procedure for each element of the list iterating in reverse order.
|
com.gs.collections.api.list.MutableList<T> |
select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
|
<S> com.gs.collections.api.list.MutableList<S> |
selectInstancesOf(java.lang.Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> com.gs.collections.api.list.MutableList<T> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
|
ListAdapter<T> |
sortThis()
Sorts the internal data structure of this list and returns the list itself as a convenience.
|
ListAdapter<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(com.gs.collections.api.block.function.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. |
com.gs.collections.api.list.MutableList<T> |
takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the initial elements that satisfy the Predicate.
|
com.gs.collections.api.list.ImmutableList<T> |
toImmutable()
Returns an immutable copy of this list.
|
com.gs.collections.api.stack.MutableStack<T> |
toStack()
Converts the list to a mutable MutableStack implementation.
|
ListAdapter<T> |
with(T... elements) |
ListAdapter<T> |
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.
|
ListAdapter<T> |
with(T element1,
T element2) |
ListAdapter<T> |
with(T element1,
T element2,
T element3) |
ListAdapter<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.
|
ListAdapter<T> |
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
|
ListAdapter<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> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.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. |
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
add, addAll, equals, get, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, reverseThis, set, subList, swapElements, toReversedadd, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfyWith, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, clear, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, countWith, detectWith, detectWithIfNone, flatCollect, forEachWith, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectIntoWith, 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, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, wrap, zip, zipWithIndexfinalize, getClass, notify, notifyAll, wait, wait, waitaddAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfyWith, anySatisfyWith, countWith, detectWith, detectWithIfNone, injectIntoWith, noneSatisfyWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWithadd, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArrayappendString, appendString, appendString, asLazy, chunk, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexprotected java.util.List<T> getDelegate()
getDelegate in class AbstractListAdapter<T>public static <E> com.gs.collections.api.list.MutableList<E> adapt(java.util.List<E> list)
public com.gs.collections.api.list.ImmutableList<T> toImmutable()
com.gs.collections.api.list.MutableListpublic com.gs.collections.api.list.MutableList<T> asUnmodifiable()
com.gs.collections.api.list.MutableListpublic com.gs.collections.api.list.MutableList<T> asSynchronized()
com.gs.collections.api.collection.MutableCollection
MutableCollection collection = myCollection.asSynchronized();
...
synchronized(collection)
{
Iterator i = c.iterator(); // Must be in the synchronized block
while (i.hasNext())
foo(i.next());
}
Failure to follow this advice may result in non-deterministic behavior.
The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is
properly synchronized internally.
MutableCollection collection = myCollection.asSynchronized();
...
collection.forEach(new Procedure()
{
public void value(Object each)
{
...
}
});
The returned collection does not pass the hashCode and equals operations through to the
backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve
the contracts of these operations in the case that the backing collection is a set or a list.
The returned collection will be serializable if this collection is serializable.public com.gs.collections.api.list.MutableList<T> clone()
clone in interface com.gs.collections.api.list.MutableList<T>clone in class AbstractListAdapter<T>@Deprecated public com.gs.collections.api.list.MutableList<T> newEmpty()
FastList.newList() instead (inlineable)com.gs.collections.api.collection.MutableCollectionpublic void forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.InternalIterablee.g. people.forEach(new Procedure() { public void value(Person person) { LOGGER.info(person.getName()); } });
forEach in interface com.gs.collections.api.InternalIterable<T>forEach in class AbstractCollectionAdapter<T>public void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.list.ListIterablee.g. people.reverseForEach(new Procedure() { public void value(Person person) { LOGGER.info(person.getName()); } });
reverseForEach in interface com.gs.collections.api.list.ListIterable<T>public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
com.gs.collections.api.InternalIterablee.g. people.forEachWithIndex(new ObjectIntProcedure() { public void value(Person person, int index) { LOGGER.info("Index: " + index + " person: " + person.getName()); } });
forEachWithIndex in interface com.gs.collections.api.InternalIterable<T>forEachWithIndex in class AbstractCollectionAdapter<T>public void forEachWithIndex(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
com.gs.collections.api.list.ListIterablee.g. ListIterableThis code would output ted and mary's names.people = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, new ObjectIntProcedure () { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
forEachWithIndex in interface com.gs.collections.api.list.ListIterable<T>public T detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterablee.g.
return people.detect(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
}
});
detect in interface com.gs.collections.api.RichIterable<T>detect in class AbstractCollectionAdapter<T>public T detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function0<? extends T> function)
com.gs.collections.api.RichIterabledetectIfNone in interface com.gs.collections.api.RichIterable<T>detectIfNone in class AbstractCollectionAdapter<T>public int count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterablee.g.
return people.count(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.getAddress().getState().getName().equals("New York");
}
});
count in interface com.gs.collections.api.RichIterable<T>count in class AbstractCollectionAdapter<T>public boolean anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableanySatisfy in interface com.gs.collections.api.RichIterable<T>anySatisfy in class AbstractCollectionAdapter<T>public boolean allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableallSatisfy in interface com.gs.collections.api.RichIterable<T>allSatisfy in class AbstractCollectionAdapter<T>public <IV> IV injectInto(IV injectedValue,
com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)
com.gs.collections.api.RichIterableinjectInto in interface com.gs.collections.api.RichIterable<T>injectInto in class AbstractCollectionAdapter<T>public void forEach(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.list.ListIterablee.g. ListIterableThis code would output ted and mary's names.people = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, new Procedure () { public void value(Person person) { LOGGER.info(person.getName()); } });
forEach in interface com.gs.collections.api.list.ListIterable<T>public ListAdapter<T> sortThis(java.util.Comparator<? super T> comparator)
com.gs.collections.api.list.MutableListsortThis in interface com.gs.collections.api.list.MutableList<T>public ListAdapter<T> sortThis()
com.gs.collections.api.list.MutableListsortThis in interface com.gs.collections.api.list.MutableList<T>public <V extends java.lang.Comparable<? super V>> com.gs.collections.api.list.MutableList<T> sortThisBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.list.MutableListfunction.sortThisBy in interface com.gs.collections.api.list.MutableList<T>public ListAdapter<T> with(T element)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.with("1"); list = list.with("2"); return list;
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.public ListAdapter<T> with(T element1, T element2)
public ListAdapter<T> with(T element1, T element2, T element3)
public ListAdapter<T> with(T... elements)
public ListAdapter<T> without(T element)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.without("1"); list = list.without("2"); return list;
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.public ListAdapter<T> withAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.withAll(FastList.newListWith("1", "2")); return list;
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.public ListAdapter<T> withoutAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.collection.MutableCollectionMutableCollectionIn the case oflist; list = list.withoutAll(FastList.newListWith("1", "2")); return list;
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.public com.gs.collections.api.list.MutableList<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.collection.MutableCollectione.g.
return people.select(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.getAddress().getCity().equals("Metuchen");
}
});
select in interface com.gs.collections.api.collection.MutableCollection<T>select in interface com.gs.collections.api.list.ListIterable<T>select in interface com.gs.collections.api.list.MutableList<T>select in interface com.gs.collections.api.RichIterable<T>select in class AbstractListAdapter<T>public com.gs.collections.api.list.MutableList<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.collection.MutableCollectione.g.
return people.reject(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.person.getLastName().equals("Smith");
}
});
e.g.
return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject in interface com.gs.collections.api.collection.MutableCollection<T>reject in interface com.gs.collections.api.list.ListIterable<T>reject in interface com.gs.collections.api.list.MutableList<T>reject in interface com.gs.collections.api.RichIterable<T>reject in class AbstractListAdapter<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic com.gs.collections.api.partition.list.PartitionMutableList<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterablee.g.
return people.partition(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getState().getName().equals("New York");
}
});
partition in interface com.gs.collections.api.collection.MutableCollection<T>partition in interface com.gs.collections.api.list.ListIterable<T>partition in interface com.gs.collections.api.list.MutableList<T>partition in interface com.gs.collections.api.RichIterable<T>partition in class AbstractListAdapter<T>public <S> com.gs.collections.api.list.MutableList<S> selectInstancesOf(java.lang.Class<S> clazz)
com.gs.collections.api.RichIterableclazz.selectInstancesOf in interface com.gs.collections.api.collection.MutableCollection<T>selectInstancesOf in interface com.gs.collections.api.list.ListIterable<T>selectInstancesOf in interface com.gs.collections.api.list.MutableList<T>selectInstancesOf in interface com.gs.collections.api.RichIterable<T>selectInstancesOf in class AbstractListAdapter<T>public <V> com.gs.collections.api.list.MutableList<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.collection.MutableCollectione.g.
return people.collect(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface com.gs.collections.api.collection.MutableCollection<T>collect in interface com.gs.collections.api.list.ListIterable<T>collect in interface com.gs.collections.api.list.MutableList<T>collect in interface com.gs.collections.api.RichIterable<T>collect in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableBooleanList collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
com.gs.collections.api.RichIterableboolean 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 com.gs.collections.api.collection.MutableCollection<T>collectBoolean in interface com.gs.collections.api.list.ListIterable<T>collectBoolean in interface com.gs.collections.api.list.MutableList<T>collectBoolean in interface com.gs.collections.api.RichIterable<T>collectBoolean in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableByteList collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
com.gs.collections.api.RichIterablebyte 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 com.gs.collections.api.collection.MutableCollection<T>collectByte in interface com.gs.collections.api.list.ListIterable<T>collectByte in interface com.gs.collections.api.list.MutableList<T>collectByte in interface com.gs.collections.api.RichIterable<T>collectByte in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableCharList collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
com.gs.collections.api.RichIterablechar 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 com.gs.collections.api.collection.MutableCollection<T>collectChar in interface com.gs.collections.api.list.ListIterable<T>collectChar in interface com.gs.collections.api.list.MutableList<T>collectChar in interface com.gs.collections.api.RichIterable<T>collectChar in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableDoubleList collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
com.gs.collections.api.RichIterabledouble 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 com.gs.collections.api.collection.MutableCollection<T>collectDouble in interface com.gs.collections.api.list.ListIterable<T>collectDouble in interface com.gs.collections.api.list.MutableList<T>collectDouble in interface com.gs.collections.api.RichIterable<T>collectDouble in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableFloatList collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
com.gs.collections.api.RichIterablefloat 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 com.gs.collections.api.collection.MutableCollection<T>collectFloat in interface com.gs.collections.api.list.ListIterable<T>collectFloat in interface com.gs.collections.api.list.MutableList<T>collectFloat in interface com.gs.collections.api.RichIterable<T>collectFloat in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableIntList collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
com.gs.collections.api.RichIterableint 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 com.gs.collections.api.collection.MutableCollection<T>collectInt in interface com.gs.collections.api.list.ListIterable<T>collectInt in interface com.gs.collections.api.list.MutableList<T>collectInt in interface com.gs.collections.api.RichIterable<T>collectInt in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableLongList collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
com.gs.collections.api.RichIterablelong 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 com.gs.collections.api.collection.MutableCollection<T>collectLong in interface com.gs.collections.api.list.ListIterable<T>collectLong in interface com.gs.collections.api.list.MutableList<T>collectLong in interface com.gs.collections.api.RichIterable<T>collectLong in class AbstractListAdapter<T>public com.gs.collections.api.list.primitive.MutableShortList collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
com.gs.collections.api.RichIterableshort 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 com.gs.collections.api.collection.MutableCollection<T>collectShort in interface com.gs.collections.api.list.ListIterable<T>collectShort in interface com.gs.collections.api.list.MutableList<T>collectShort in interface com.gs.collections.api.RichIterable<T>collectShort in class AbstractListAdapter<T>public <V> com.gs.collections.api.list.MutableList<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.RichIterableflatCollect 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 com.gs.collections.api.collection.MutableCollection<T>flatCollect in interface com.gs.collections.api.list.ListIterable<T>flatCollect in interface com.gs.collections.api.list.MutableList<T>flatCollect in interface com.gs.collections.api.RichIterable<T>flatCollect in class AbstractListAdapter<T>function - The Function to applyfunctionpublic <V> com.gs.collections.api.list.MutableList<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.collection.MutableCollectione.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf in interface com.gs.collections.api.collection.MutableCollection<T>collectIf in interface com.gs.collections.api.list.ListIterable<T>collectIf in interface com.gs.collections.api.list.MutableList<T>collectIf in interface com.gs.collections.api.RichIterable<T>collectIf in class AbstractListAdapter<T>public <V> FastListMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterablee.g.
return people.groupBy(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
groupBy in interface com.gs.collections.api.collection.MutableCollection<T>groupBy in interface com.gs.collections.api.list.ListIterable<T>groupBy in interface com.gs.collections.api.list.MutableList<T>groupBy in interface com.gs.collections.api.RichIterable<T>groupBy in class AbstractListAdapter<T>public <V> FastListMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.RichIterableRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value.groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>groupByEach in interface com.gs.collections.api.list.ListIterable<T>groupByEach in interface com.gs.collections.api.list.MutableList<T>groupByEach in interface com.gs.collections.api.RichIterable<T>groupByEach in class AbstractListAdapter<T>public <P> com.gs.collections.api.list.MutableList<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.collection.MutableCollectione.g. return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
selectWith in interface com.gs.collections.api.collection.MutableCollection<T>selectWith in interface com.gs.collections.api.list.MutableList<T>selectWith in class AbstractListAdapter<T>public <P> com.gs.collections.api.list.MutableList<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.collection.MutableCollectione.g. return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
rejectWith in interface com.gs.collections.api.collection.MutableCollection<T>rejectWith in interface com.gs.collections.api.list.MutableList<T>rejectWith in class AbstractListAdapter<T>public <P,V> com.gs.collections.api.list.MutableList<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)
com.gs.collections.api.collection.MutableCollectione.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 com.gs.collections.api.collection.MutableCollection<T>collectWith in interface com.gs.collections.api.list.MutableList<T>collectWith in class AbstractListAdapter<T>public com.gs.collections.api.list.MutableList<T> distinct()
com.gs.collections.api.list.ListIterableListIterable 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.public <S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)
com.gs.collections.api.RichIterableRichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its
remaining elements are ignored.zip in interface com.gs.collections.api.collection.MutableCollection<T>zip in interface com.gs.collections.api.list.ListIterable<T>zip in interface com.gs.collections.api.list.MutableList<T>zip in interface com.gs.collections.api.RichIterable<T>zip in class AbstractListAdapter<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.public com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()
com.gs.collections.api.RichIterableRichIterable with its indices.zipWithIndex in interface com.gs.collections.api.collection.MutableCollection<T>zipWithIndex in interface com.gs.collections.api.list.ListIterable<T>zipWithIndex in interface com.gs.collections.api.list.MutableList<T>zipWithIndex in interface com.gs.collections.api.RichIterable<T>zipWithIndex in class AbstractListAdapter<T>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)public com.gs.collections.api.list.MutableList<T> takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.list.ListIterablepublic com.gs.collections.api.list.MutableList<T> dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.list.ListIterablepublic com.gs.collections.api.partition.list.PartitionMutableList<T> partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.list.ListIterablepublic com.gs.collections.api.stack.MutableStack<T> toStack()
com.gs.collections.api.list.ListIterabletoStack in interface com.gs.collections.api.list.ListIterable<T>toStack in class AbstractListAdapter<T>