public abstract class AbstractMutableList<T> extends AbstractMutableCollection<T> implements com.gs.collections.api.list.MutableList<T>
| Modifier and Type | Class and Description |
|---|---|
protected static class |
AbstractMutableList.SubList<T> |
| Constructor and Description |
|---|
AbstractMutableList() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
<P> boolean |
allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns true if the predicate evaluates to true for every element of the collection, or returns false.
|
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.
|
<P> boolean |
anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns true if the predicate evaluates to true for any element of the collection, or return false.
|
void |
appendString(java.lang.Appendable appendable,
java.lang.String start,
java.lang.String separator,
java.lang.String end)
Prints a string representation of this collection onto the given
Appendable. |
ReverseIterable<T> |
asReversed()
Returns a reversed view of this ListIterable.
|
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.
|
int |
binarySearch(T key)
Searches for the specified object using the binary search algorithm.
|
int |
binarySearch(T key,
java.util.Comparator<? super T> comparator)
Searches for the specified object using the binary search algorithm.
|
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.
|
<V,R extends java.util.Collection<V>> |
collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
R target)
Same as
RichIterable.collect(Function), except that the results are gathered into the specified target
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.
|
<V,R extends java.util.Collection<V>> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
com.gs.collections.api.block.function.Function<? super T,? extends V> function,
R target)
Same as the collectIf method with two parameters but uses the specified target collection for the results.
|
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,A,R extends java.util.Collection<A>> |
collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function,
P parameter,
R targetCollection)
Same as collectWith but with a targetCollection parameter to gather the results.
|
<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
|
boolean |
contains(java.lang.Object object)
Returns true if the iterable has an element which responds true to element.equals(object).
|
boolean |
containsAll(java.util.Collection<?> source)
Returns true if all elements in source are contained in this collection.
|
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.
|
<P> int |
countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns the total number of elements that evaluate to true for the specified predicate.
|
protected void |
defaultSort(java.util.Comparator<? super T> comparator)
Override in subclasses where it can be optimized.
|
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.
|
<P> T |
detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none
evaluate to true.
|
<P> T |
detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter,
com.gs.collections.api.block.function.Function0<? extends T> function)
Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or
returns the value of evaluating the specified function.
|
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.
|
boolean |
equals(java.lang.Object o)
Follows the same general contract as
List.equals(Object). |
<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). |
<V,R extends java.util.Collection<V>> |
flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
R target)
Same as flatCollect, only the results are collected into the target collection.
|
void |
forEach(int from,
int to,
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.
|
<P> void |
forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
P parameter)
The procedure2 is evaluated for each element in the iterable with the specified parameter provided
as the second argument.
|
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
|
T |
getFirst()
Returns the first element of an iterable.
|
T |
getLast()
Returns the last element of an iterable.
|
<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. |
<V> com.gs.collections.api.map.MutableMap<V,T> |
groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
For each element of the iterable, the function is evaluated and he results of these evaluations are collected
into a new map, where the transformed value is the key.
|
int |
hashCode()
Follows the same general contract as
List.hashCode(). |
int |
indexOf(java.lang.Object o)
Returns the index of the first occurrence of the specified item
in this list, or -1 if this list does not contain the item.
|
float |
injectInto(float injectedValue,
com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> function)
Returns the final float result of evaluating function using each element of the iterable and the previous evaluation
result as the parameters.
|
int |
injectInto(int injectedValue,
com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> function)
Returns the final int result of evaluating function using each element of the iterable and the previous evaluation
result as the parameters.
|
<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.
|
long |
injectInto(long injectedValue,
com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> function)
Returns the final long result of evaluating function using each element of the iterable and the previous evaluation
result as the parameters.
|
<IV,P> IV |
injectIntoWith(IV injectValue,
com.gs.collections.api.block.function.Function3<? super IV,? super T,? super P,? extends IV> function,
P parameter) |
java.util.Iterator<T> |
iterator() |
int |
lastIndexOf(java.lang.Object o)
Returns the index of the last occurrence of the specified item
in this list, or -1 if this list does not contain the item.
|
java.util.ListIterator<T> |
listIterator() |
java.util.ListIterator<T> |
listIterator(int index) |
T |
max()
Returns the maximum element out of this container based on the natural order.
|
T |
max(java.util.Comparator<? super T> comparator)
Returns the maximum element out of this container based on the comparator.
|
<V extends java.lang.Comparable<? super V>> |
maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
|
T |
min()
Returns the minimum element out of this container based on the natural order.
|
T |
min(java.util.Comparator<? super T> comparator)
Returns the minimum element out of this container based on the comparator.
|
<V extends java.lang.Comparable<? super V>> |
minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
|
com.gs.collections.api.list.MutableList<T> |
newEmpty()
Creates a new empty mutable version of the same collection type.
|
boolean |
noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
|
<P> boolean |
noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Returns true if the predicate evaluates to false for every element of the collection, or return false.
|
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.
|
<P> com.gs.collections.api.partition.list.PartitionMutableList<T> |
partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
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.
|
<R extends java.util.Collection<T>> |
reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
R target)
Same as the reject method with one parameter but uses the specified target collection for the results.
|
<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.
|
<P,R extends java.util.Collection<T>> |
rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter,
R targetCollection)
Similar to
RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2. |
boolean |
removeAll(java.util.Collection<?> collection) |
void |
removeIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Removes all elements in the collection that evaluate to true for the specified predicate.
|
<P> void |
removeIfWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.
|
boolean |
retainAll(java.util.Collection<?> collection) |
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> |
reverseThis()
Mutates the current list by reversing its order and returns the current list as a result
|
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.
|
<R extends java.util.Collection<T>> |
select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
R target)
Same as the select method with one parameter but uses the specified target collection for the results.
|
<P> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>> |
selectAndRejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into two separate collections based on a predicate returned via a Pair.
|
<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.
|
<P,R extends java.util.Collection<T>> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter,
R targetCollection)
Similar to
RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2. |
com.gs.collections.api.list.MutableList<T> |
sortThis()
Sorts the internal data structure of this list and returns the list itself as a convenience.
|
com.gs.collections.api.list.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(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> |
subList(int fromIndex,
int toIndex) |
double |
sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> function)
Returns the final double result of evaluating function for each element of the iterable and adding the results
together.
|
double |
sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> function)
Returns the final double result of evaluating function for each element of the iterable and adding the results
together.
|
long |
sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> function)
Returns the final long result of evaluating function for each element of the iterable and adding the results
together.
|
long |
sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> function)
Returns the final long result of evaluating function for each element of the iterable and adding the results
together.
|
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.list.MutableList<T> |
toList()
Converts the collection to a MutableList implementation.
|
com.gs.collections.api.list.MutableList<T> |
toReversed()
Returns a new MutableList in reverse order
|
com.gs.collections.api.set.MutableSet<T> |
toSet()
Converts the collection to a MutableSet implementation.
|
com.gs.collections.api.list.MutableList<T> |
toSortedList()
Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
|
com.gs.collections.api.list.MutableList<T> |
toSortedList(java.util.Comparator<? super T> comparator)
Converts the collection to a MutableList implementation and sorts it using the specified comparator.
|
com.gs.collections.api.stack.MutableStack<T> |
toStack()
Converts the list to a mutable MutableStack implementation.
|
com.gs.collections.api.list.MutableList<T> |
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.
|
com.gs.collections.api.list.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.
|
com.gs.collections.api.list.MutableList<T> |
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
|
com.gs.collections.api.list.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> 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, addAllIterable, aggregateBy, aggregateInPlaceBy, chunk, remove, removeAllIterable, retainAllIterableappendString, appendString, asLazy, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, isEmpty, makeString, makeString, makeString, notEmpty, toArray, toArray, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexfinalize, getClass, notify, notifyAll, wait, wait, waitaddAllIterable, aggregateBy, aggregateInPlaceBy, removeAllIterable, retainAllIterableadd, add, addAll, addAll, clear, get, isEmpty, remove, remove, set, size, toArray, toArrayappendString, appendString, asLazy, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, isEmpty, makeString, makeString, makeString, notEmpty, size, toArray, toArray, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexpublic com.gs.collections.api.list.MutableList<T> clone()
clone in interface com.gs.collections.api.list.MutableList<T>clone in class java.lang.Objectpublic boolean equals(java.lang.Object o)
com.gs.collections.api.list.ListIterableList.equals(Object).public int hashCode()
com.gs.collections.api.list.ListIterableList.hashCode().public 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>public void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.ordered.ReversibleIterablee.g. people.reverseForEach(new Procedure() { public void value(Person person) { LOGGER.info(person.getName()); } });
reverseForEach in interface com.gs.collections.api.ordered.ReversibleIterable<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 AbstractRichIterable<T>public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter)
com.gs.collections.api.InternalIterablee.g. people.forEachWith(new Procedure2() { public void value(Person person, Person other) { if (person.isRelatedTo(other)) { LOGGER.info(person.getName()); } } }, fred);
forEachWith in interface com.gs.collections.api.InternalIterable<T>forEachWith in class AbstractRichIterable<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 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.ordered.ReversibleIterable<T>select in interface com.gs.collections.api.RichIterable<T>public <R extends java.util.Collection<T>> R select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target)
com.gs.collections.api.RichIterablee.g.
return people.select(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.person.getLastName().equals("Smith");
}
}, Lists.mutable.of());
e.g.
return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
select in interface com.gs.collections.api.RichIterable<T>select in class AbstractRichIterable<T>predicate - a Predicate to use as the select criteriatarget - the Collection to append to for all elements in this RichIterable that meet select criteria predicatetarget, which contains appended elements as a result of the select criteriaRichIterable.select(Predicate)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.ListIterable<T>selectWith in interface com.gs.collections.api.list.MutableList<T>selectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>selectWith in interface com.gs.collections.api.RichIterable<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)public <P,R extends java.util.Collection<T>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)
com.gs.collections.api.RichIterableRichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.selectWith in interface com.gs.collections.api.RichIterable<T>selectWith in class AbstractRichIterable<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicatetargetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicatetargetCollection, which contains appended elements as a result of the select criteriaRichIterable.select(Predicate),
RichIterable.select(Predicate, Collection)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.ordered.ReversibleIterable<T>reject in interface com.gs.collections.api.RichIterable<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic <R extends java.util.Collection<T>> R reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target)
com.gs.collections.api.RichIterablee.g.
return people.reject(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.person.getLastName().equals("Smith");
}
}, Lists.mutable.of());
reject in interface com.gs.collections.api.RichIterable<T>reject in class AbstractRichIterable<T>predicate - a Predicate to use as the reject criteriatarget - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to falsetarget, which contains appended elements as a result of the reject criteriapublic <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.ListIterable<T>rejectWith in interface com.gs.collections.api.list.MutableList<T>rejectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>rejectWith in interface com.gs.collections.api.RichIterable<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)public <P,R extends java.util.Collection<T>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)
com.gs.collections.api.RichIterableRichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has a height greater than 100cm
return people.reject(new Predicate2<Person, Integer>()
{
public boolean accept(Person p, Integer i)
{
return p.getHeightInCm() < i.intValue();
}
}, Integer.valueOf(100), FastList.newList());
rejectWith in interface com.gs.collections.api.RichIterable<T>rejectWith in class AbstractRichIterable<T>predicate - a Predicate2 to use as the reject criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicatetargetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to falsetargetCollection, which contains appended elements as a result of the reject criteriaRichIterable.reject(Predicate),
RichIterable.reject(Predicate, Collection)public <P> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>> selectAndRejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.collection.MutableCollectione.g. return lastNames.selectAndRejectWith(PredicatesLite.lessThan(), "Mason");
selectAndRejectWith in interface com.gs.collections.api.collection.MutableCollection<T>selectAndRejectWith in class AbstractMutableCollection<T>public 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.ordered.ReversibleIterable<T>partition in interface com.gs.collections.api.RichIterable<T>public <P> com.gs.collections.api.partition.list.PartitionMutableList<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterablee.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 com.gs.collections.api.collection.MutableCollection<T>partitionWith in interface com.gs.collections.api.list.ListIterable<T>partitionWith in interface com.gs.collections.api.list.MutableList<T>partitionWith in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>selectInstancesOf in interface com.gs.collections.api.RichIterable<T>public void removeIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.collection.MutableCollectione.g. return lastNames.removeIf(Predicates.isNull());
removeIf in interface com.gs.collections.api.collection.MutableCollection<T>removeIf in class AbstractMutableCollection<T>public <P> void removeIfWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.collection.MutableCollectione.g. return lastNames.removeIfWith(PredicatesLite.isNull(), null);
removeIfWith in interface com.gs.collections.api.collection.MutableCollection<T>removeIfWith in class AbstractMutableCollection<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.ordered.ReversibleIterable<T>collect in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectBoolean in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectByte in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectChar in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectDouble in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectFloat in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectInt in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectLong in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>collectShort in interface com.gs.collections.api.RichIterable<T>public <V,R extends java.util.Collection<V>> R collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)
com.gs.collections.api.RichIterableRichIterable.collect(Function), except that the results are gathered into the specified target
collection.
e.g.
return people.collect(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
}, Lists.mutable.of());
collect in interface com.gs.collections.api.RichIterable<T>collect in class AbstractRichIterable<T>function - a Function to use as the collect transformation functiontarget - the Collection to append to for all elements in this RichIterable that meet select criteria functiontarget, which contains appended elements as a result of the collect transformationRichIterable.collect(Function)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.ordered.ReversibleIterable<T>flatCollect in interface com.gs.collections.api.RichIterable<T>function - The Function to applyfunctionpublic <V,R extends java.util.Collection<V>> R flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target)
com.gs.collections.api.RichIterableflatCollect in interface com.gs.collections.api.RichIterable<T>flatCollect in class AbstractRichIterable<T>function - The Function to applytarget - The collection into which results should be added.target, which will contain a flattened collection of results produced by applying the given functionRichIterable.flatCollect(Function)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.RichIterableFunction2 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 com.gs.collections.api.collection.MutableCollection<T>collectWith in interface com.gs.collections.api.list.ListIterable<T>collectWith in interface com.gs.collections.api.list.MutableList<T>collectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectWith in interface com.gs.collections.api.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 functionRichIterable that contains the transformed elements returned by Function2.value(Object, Object)RichIterable.collect(Function)public <P,A,R extends java.util.Collection<A>> R collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function, P parameter, R targetCollection)
com.gs.collections.api.RichIterablee.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), UnifiedSet.newSet());
collectWith in interface com.gs.collections.api.RichIterable<T>collectWith in class AbstractRichIterable<T>function - a Function2 to use as the collect transformation functionparameter - a parameter to pass in for evaluation of the second argument P in functiontargetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria functiontargetCollection, which contains appended elements as a result of the collect transformationpublic <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.ordered.ReversibleIterable<T>collectIf in interface com.gs.collections.api.RichIterable<T>public <V,R extends java.util.Collection<V>> R collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)
com.gs.collections.api.RichIterablecollectIf in interface com.gs.collections.api.RichIterable<T>collectIf in class AbstractRichIterable<T>predicate - a Predicate to use as the select criteriafunction - a Function to use as the collect transformation functiontarget - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicatetargetCollection, which contains appended elements as a result of the collect criteria and transformationRichIterable.collectIf(Predicate, Function)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 AbstractRichIterable<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 AbstractRichIterable<T>public T min(java.util.Comparator<? super T> comparator)
com.gs.collections.api.RichIterablemin in interface com.gs.collections.api.RichIterable<T>min in class AbstractRichIterable<T>public T max(java.util.Comparator<? super T> comparator)
com.gs.collections.api.RichIterablemax in interface com.gs.collections.api.RichIterable<T>max in class AbstractRichIterable<T>public T min()
com.gs.collections.api.RichIterablemin in interface com.gs.collections.api.RichIterable<T>min in class AbstractRichIterable<T>public T max()
com.gs.collections.api.RichIterablemax in interface com.gs.collections.api.RichIterable<T>max in class AbstractRichIterable<T>public <V extends java.lang.Comparable<? super V>> T minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterableminBy in interface com.gs.collections.api.RichIterable<T>minBy in class AbstractRichIterable<T>public <V extends java.lang.Comparable<? super V>> T maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterablemaxBy in interface com.gs.collections.api.RichIterable<T>maxBy in class AbstractRichIterable<T>public <P> T detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterablee.g.
people.detectWith(new Predicate2<Person, String>()
{
public boolean value(Person person, String fullName)
{
return person.getFullName().equals(fullName);
}
}, "John Smith");
detectWith in interface com.gs.collections.api.RichIterable<T>detectWith in class AbstractRichIterable<T>public <P> T detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, com.gs.collections.api.block.function.Function0<? extends T> function)
com.gs.collections.api.RichIterabledetectWithIfNone in interface com.gs.collections.api.RichIterable<T>detectWithIfNone in class AbstractRichIterable<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 AbstractRichIterable<T>public <P> int countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterablee.g. return lastNames.countWith(PredicatesLite.equal(), "Smith");
countWith in interface com.gs.collections.api.RichIterable<T>countWith in class AbstractRichIterable<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 AbstractRichIterable<T>public <P> boolean anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableanySatisfyWith in interface com.gs.collections.api.RichIterable<T>anySatisfyWith in class AbstractRichIterable<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 AbstractRichIterable<T>public <P> boolean allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableallSatisfyWith in interface com.gs.collections.api.RichIterable<T>allSatisfyWith in class AbstractRichIterable<T>public boolean noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterablenoneSatisfy in interface com.gs.collections.api.RichIterable<T>noneSatisfy in class AbstractRichIterable<T>public <P> boolean noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterablenoneSatisfyWith in interface com.gs.collections.api.RichIterable<T>noneSatisfyWith in class AbstractRichIterable<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 AbstractRichIterable<T>public int injectInto(int injectedValue,
com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> function)
com.gs.collections.api.RichIterableinjectInto in interface com.gs.collections.api.RichIterable<T>injectInto in class AbstractRichIterable<T>public float injectInto(float injectedValue,
com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> function)
com.gs.collections.api.RichIterableinjectInto in interface com.gs.collections.api.RichIterable<T>injectInto in class AbstractRichIterable<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 long sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> function)
com.gs.collections.api.RichIterablesumOfInt in interface com.gs.collections.api.RichIterable<T>sumOfInt in class AbstractRichIterable<T>public long sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> function)
com.gs.collections.api.RichIterablesumOfLong in interface com.gs.collections.api.RichIterable<T>sumOfLong in class AbstractRichIterable<T>public double sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> function)
com.gs.collections.api.RichIterablesumOfFloat in interface com.gs.collections.api.RichIterable<T>sumOfFloat in class AbstractRichIterable<T>public double sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> function)
com.gs.collections.api.RichIterablesumOfDouble in interface com.gs.collections.api.RichIterable<T>sumOfDouble in class AbstractRichIterable<T>public long injectInto(long injectedValue,
com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> function)
com.gs.collections.api.RichIterableinjectInto in interface com.gs.collections.api.RichIterable<T>injectInto in class AbstractRichIterable<T>public <IV,P> IV injectIntoWith(IV injectValue,
com.gs.collections.api.block.function.Function3<? super IV,? super T,? super P,? extends IV> function,
P parameter)
injectIntoWith in interface com.gs.collections.api.collection.MutableCollection<T>injectIntoWith in class AbstractMutableCollection<T>public com.gs.collections.api.list.MutableList<T> toList()
com.gs.collections.api.RichIterabletoList in interface com.gs.collections.api.RichIterable<T>toList in class AbstractRichIterable<T>public com.gs.collections.api.list.MutableList<T> toSortedList()
com.gs.collections.api.RichIterabletoSortedList in interface com.gs.collections.api.RichIterable<T>toSortedList in class AbstractRichIterable<T>public com.gs.collections.api.list.MutableList<T> toSortedList(java.util.Comparator<? super T> comparator)
com.gs.collections.api.RichIterabletoSortedList in interface com.gs.collections.api.RichIterable<T>toSortedList in class AbstractRichIterable<T>public com.gs.collections.api.set.MutableSet<T> toSet()
com.gs.collections.api.RichIterabletoSet in interface com.gs.collections.api.RichIterable<T>toSet in class AbstractRichIterable<T>public com.gs.collections.api.stack.MutableStack<T> toStack()
com.gs.collections.api.list.ListIterablepublic com.gs.collections.api.list.MutableList<T> asUnmodifiable()
com.gs.collections.api.list.MutableListpublic com.gs.collections.api.list.ImmutableList<T> toImmutable()
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> sortThis(java.util.Comparator<? super T> comparator)
com.gs.collections.api.list.MutableListsortThis in interface com.gs.collections.api.list.MutableList<T>protected void defaultSort(java.util.Comparator<? super T> comparator)
public com.gs.collections.api.list.MutableList<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 com.gs.collections.api.list.MutableList<T> newEmpty()
com.gs.collections.api.collection.MutableCollectionpublic void forEach(int from,
int to,
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 int indexOf(java.lang.Object o)
com.gs.collections.api.ordered.ReversibleIterablepublic int lastIndexOf(java.lang.Object o)
com.gs.collections.api.list.ListIterablepublic java.util.Iterator<T> iterator()
public java.util.ListIterator<T> listIterator()
public java.util.ListIterator<T> listIterator(int index)
public com.gs.collections.api.list.MutableList<T> toReversed()
com.gs.collections.api.list.MutableListtoReversed in interface com.gs.collections.api.list.MutableList<T>public com.gs.collections.api.list.MutableList<T> reverseThis()
com.gs.collections.api.list.MutableListreverseThis in interface com.gs.collections.api.list.MutableList<T>public com.gs.collections.api.list.MutableList<T> subList(int fromIndex, int toIndex)
public boolean contains(java.lang.Object object)
com.gs.collections.api.RichIterablepublic boolean containsAll(java.util.Collection<?> source)
com.gs.collections.api.RichIterablecontainsAll in interface com.gs.collections.api.RichIterable<T>containsAll in interface java.util.Collection<T>containsAll in interface java.util.List<T>containsAll in class AbstractRichIterable<T>Collection.containsAll(Collection)public boolean removeAll(java.util.Collection<?> collection)
removeAll in interface java.util.Collection<T>removeAll in interface java.util.List<T>removeAll in class AbstractMutableCollection<T>public boolean retainAll(java.util.Collection<?> collection)
retainAll in interface java.util.Collection<T>retainAll in interface java.util.List<T>retainAll in class AbstractMutableCollection<T>public T getFirst()
com.gs.collections.api.RichIterablepublic T getLast()
com.gs.collections.api.RichIterablepublic void appendString(java.lang.Appendable appendable,
java.lang.String start,
java.lang.String separator,
java.lang.String end)
com.gs.collections.api.RichIterableAppendable. Prints the string returned
by RichIterable.makeString(String, String, String).appendString in interface com.gs.collections.api.RichIterable<T>appendString in class AbstractRichIterable<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.ordered.ReversibleIterable<T>groupBy in interface com.gs.collections.api.RichIterable<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.ordered.ReversibleIterable<T>groupByEach in interface com.gs.collections.api.RichIterable<T>public <V> com.gs.collections.api.map.MutableMap<V,T> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterablepublic <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.ordered.ReversibleIterable<T>zip in interface com.gs.collections.api.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.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.ordered.ReversibleIterable<T>zipWithIndex in interface com.gs.collections.api.RichIterable<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> 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 com.gs.collections.api.list.MutableList<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 com.gs.collections.api.list.MutableList<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 com.gs.collections.api.list.MutableList<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 ReverseIterable<T> asReversed()
com.gs.collections.api.list.ListIterablepublic int binarySearch(T key, java.util.Comparator<? super T> comparator)
com.gs.collections.api.list.ListIterablebinarySearch in interface com.gs.collections.api.list.ListIterable<T>Collections.binarySearch(java.util.List, Object, java.util.Comparator)public int binarySearch(T key)
com.gs.collections.api.list.ListIterablebinarySearch in interface com.gs.collections.api.list.ListIterable<T>Collections.binarySearch(java.util.List, Object)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.ListIterable