com.gs.collections.impl.list.mutable

Class AbstractMutableList<T>

java.lang.Object

java.util.AbstractCollection<T>

com.gs.collections.impl.collection.mutable.AbstractMutableCollection<T>

com.gs.collections.impl.list.mutable.AbstractMutableList<T>

All Implemented Interfaces:

com.gs.collections.api.collection.MutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.list.ListIterable<T>, com.gs.collections.api.list.MutableList<T>, com.gs.collections.api.RichIterable<T>, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

Direct Known Subclasses:

AbstractArrayAdapter, AbstractMemoryEfficientMutableList, AbstractMutableList.SubList, CompositeFastList, FastList

public abstract class AbstractMutableList<T>
extends AbstractMutableCollection<T>
implements com.gs.collections.api.list.MutableList<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractMutableList.SubList<T>

Constructor Summary

Constructors

Constructor and Description
AbstractMutableList()

Method Summary

Methods

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()
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 unmodifiable view of this collection.
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>> R	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>> 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) 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>> R	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)
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 collection 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>> R	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.
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>> T	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>> T	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.
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>> R	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>> R	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>> R	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>> R	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>> com.gs.collections.api.list.MutableList<T>	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.

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractMutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, appendString, appendString, asLazy, chunk, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, makeString, makeString, makeString, notEmpty, removeAllIterable, retainAllIterable, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, isEmpty, remove, size, toArray, toArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.api.collection.MutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, removeAllIterable, retainAllIterable

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, get, isEmpty, remove, remove, set, size, toArray, toArray

Methods inherited from interface com.gs.collections.api.list.ListIterable

get, size

Methods inherited from interface com.gs.collections.api.RichIterable

appendString, appendString, asLazy, chunk, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, isEmpty, makeString, makeString, makeString, notEmpty, toArray, toArray, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Constructor Detail

AbstractMutableList

public AbstractMutableList()

Method Detail

clone

public com.gs.collections.api.list.MutableList<T> clone()

Specified by:

clone in interface com.gs.collections.api.list.MutableList<T>

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Description copied from interface: com.gs.collections.api.list.ListIterable

Follows the same general contract as List.equals(Object).

Specified by:

equals in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.List<T>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: com.gs.collections.api.list.ListIterable

Follows the same general contract as List.hashCode().

Specified by:

hashCode in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.List<T>

Overrides:

hashCode in class java.lang.Object

forEach

public void forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

Description copied from interface: com.gs.collections.api.InternalIterable

The procedure is executed for each element in the iterable.

e.g.
 people.forEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

Specified by:

forEach in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEach in class AbstractMutableCollection<T>

reverseForEach

public void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

Description copied from interface: com.gs.collections.api.list.ListIterable

Evaluates the procedure for each element of the list iterating in reverse order.

e.g.
 people.reverseForEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

Specified by:

reverseForEach in interface com.gs.collections.api.list.ListIterable<T>

forEachWithIndex

public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: com.gs.collections.api.InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure

e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEachWithIndex in class AbstractMutableCollection<T>

forEachWith

public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
                   P parameter)

Description copied from interface: com.gs.collections.api.InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 

Specified by:

forEachWith in interface com.gs.collections.api.InternalIterable<T>

Overrides:

forEachWith in class AbstractMutableCollection<T>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
                    int toIndex,
                    com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: com.gs.collections.api.list.ListIterable

Iterates over the section of the list covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
 ListIterable people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEachWithIndex in interface com.gs.collections.api.list.ListIterable<T>

select

public com.gs.collections.api.list.MutableList<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

Specified by:

select in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

select in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

select in interface com.gs.collections.api.list.MutableList<T>

Specified by:

select in interface com.gs.collections.api.RichIterable<T>

Overrides:

select in class AbstractMutableCollection<T>

select

public <R extends java.util.Collection<T>> R select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                           R target)

Description copied from interface: com.gs.collections.api.RichIterable

Same as the select method with one parameter but uses the specified target collection for the results.

e.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());
 

Specified by:

select in interface com.gs.collections.api.RichIterable<T>

Overrides:

select in class AbstractMutableCollection<T>

Parameters:

predicate - a Predicate to use as the select criteria

target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

target, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate)

selectWith

public <P> com.gs.collections.api.list.MutableList<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                        P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.

e.g.
 return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
 

Specified by:

selectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

selectWith in interface com.gs.collections.api.list.MutableList<T>

Overrides:

selectWith in class AbstractMutableCollection<T>

selectWith

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)

Description copied from interface: com.gs.collections.api.RichIterable

Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.

Specified by:

selectWith in interface com.gs.collections.api.RichIterable<T>

Overrides:

selectWith in class AbstractMutableCollection<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)

reject

public com.gs.collections.api.list.MutableList<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate.

e.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"));
 

Specified by:

reject in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

reject in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

reject in interface com.gs.collections.api.list.MutableList<T>

Specified by:

reject in interface com.gs.collections.api.RichIterable<T>

Overrides:

reject in class AbstractMutableCollection<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

reject

public <R extends java.util.Collection<T>> R reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                           R target)

Description copied from interface: com.gs.collections.api.RichIterable

Same as the reject method with one parameter but uses the specified target collection for the results.

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

Specified by:

reject in interface com.gs.collections.api.RichIterable<T>

Overrides:

reject in class AbstractMutableCollection<T>

Parameters:

predicate - a Predicate to use as the reject criteria

target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

target, which contains appended elements as a result of the reject criteria

rejectWith

public <P> com.gs.collections.api.list.MutableList<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                        P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.

e.g.
 return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
 

Specified by:

rejectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

rejectWith in interface com.gs.collections.api.list.MutableList<T>

Overrides:

rejectWith in class AbstractMutableCollection<T>

rejectWith

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)

Description copied from interface: com.gs.collections.api.RichIterable

Similar to RichIterable.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());
 

Specified by:

rejectWith in interface com.gs.collections.api.RichIterable<T>

Overrides:

rejectWith in class AbstractMutableCollection<T>

Parameters:

predicate - a Predicate2 to use as the reject criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

targetCollection, which contains appended elements as a result of the reject criteria

See Also:

RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)

selectAndRejectWith

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)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Filters a collection into two separate collections based on a predicate returned via a Pair.

e.g.
 return lastNames.selectAndRejectWith(PredicatesLite.lessThan(), "Mason");
 

Specified by:

selectAndRejectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

selectAndRejectWith in class AbstractMutableCollection<T>

partition

public com.gs.collections.api.partition.list.PartitionMutableList<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

e.g.
 return people.partition(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

Specified by:

partition in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

partition in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

partition in interface com.gs.collections.api.list.MutableList<T>

Specified by:

partition in interface com.gs.collections.api.RichIterable<T>

selectInstancesOf

public <S> com.gs.collections.api.list.MutableList<S> selectInstancesOf(java.lang.Class<S> clazz)

Description copied from interface: com.gs.collections.api.RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

Specified by:

selectInstancesOf in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.list.MutableList<T>

Specified by:

selectInstancesOf in interface com.gs.collections.api.RichIterable<T>

removeIf

public void removeIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Removes all elements in the collection that evaluate to true for the specified predicate.

e.g.
 return lastNames.removeIf(Predicates.isNull());
 

Specified by:

removeIf in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

removeIf in class AbstractMutableCollection<T>

removeIfWith

public <P> void removeIfWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                    P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.

e.g.
 return lastNames.removeIfWith(PredicatesLite.isNull(), null);
 

Specified by:

removeIfWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

removeIfWith in class AbstractMutableCollection<T>

collect

public <V> com.gs.collections.api.list.MutableList<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

collect in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collect in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collect in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collect in interface com.gs.collections.api.RichIterable<T>

Overrides:

collect in class AbstractMutableCollection<T>

collectBoolean

public com.gs.collections.api.list.primitive.MutableBooleanList collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 

Specified by:

collectBoolean in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectBoolean in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectBoolean in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectBoolean in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectBoolean in class AbstractMutableCollection<T>

collectByte

public com.gs.collections.api.list.primitive.MutableByteList collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 

Specified by:

collectByte in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectByte in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectByte in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectByte in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectByte in class AbstractMutableCollection<T>

collectChar

public com.gs.collections.api.list.primitive.MutableCharList collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 

Specified by:

collectChar in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectChar in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectChar in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectChar in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectChar in class AbstractMutableCollection<T>

collectDouble

public com.gs.collections.api.list.primitive.MutableDoubleList collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 

Specified by:

collectDouble in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectDouble in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectDouble in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectDouble in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectDouble in class AbstractMutableCollection<T>

collectFloat

public com.gs.collections.api.list.primitive.MutableFloatList collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 

Specified by:

collectFloat in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectFloat in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectFloat in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectFloat in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectFloat in class AbstractMutableCollection<T>

collectInt

public com.gs.collections.api.list.primitive.MutableIntList collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

Specified by:

collectInt in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectInt in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectInt in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectInt in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectInt in class AbstractMutableCollection<T>

collectLong

public com.gs.collections.api.list.primitive.MutableLongList collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 

Specified by:

collectLong in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectLong in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectLong in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectLong in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectLong in class AbstractMutableCollection<T>

collectShort

public com.gs.collections.api.list.primitive.MutableShortList collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 

Specified by:

collectShort in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectShort in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectShort in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectShort in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectShort in class AbstractMutableCollection<T>

collect

public <V,R extends java.util.Collection<V>> R collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                              R target)

Description copied from interface: com.gs.collections.api.RichIterable

Same as RichIterable.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());
 

Specified by:

collect in interface com.gs.collections.api.RichIterable<T>

Overrides:

collect in class AbstractMutableCollection<T>

Parameters:

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

target, which contains appended elements as a result of the collect transformation

See Also:

RichIterable.collect(Function)

flatCollect

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)

Description copied from interface: com.gs.collections.api.RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>() {
     public List<Address> valueOf(Person person) {
         return person.getAddresses();
     }
 };
 MutableList<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 MutableList<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 MutableList<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

flatCollect in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

flatCollect in interface com.gs.collections.api.list.MutableList<T>

Specified by:

flatCollect in interface com.gs.collections.api.RichIterable<T>

Overrides:

flatCollect in class AbstractMutableCollection<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollect

public <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)

Description copied from interface: com.gs.collections.api.RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollect in interface com.gs.collections.api.RichIterable<T>

Overrides:

flatCollect in class AbstractMutableCollection<T>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

RichIterable.flatCollect(Function)

collectWith

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)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Same as collect with a Function2 and specified parameter which is passed to the block

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectWith in interface com.gs.collections.api.list.MutableList<T>

Overrides:

collectWith in class AbstractMutableCollection<T>

collectWith

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)

Description copied from interface: com.gs.collections.api.RichIterable

Same as collectWith but with a targetCollection parameter to gather the results.

e.g.
 Function2 addParameterFunction =
 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());
 

Specified by:

collectWith in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectWith in class AbstractMutableCollection<T>

Parameters:

function - a Function2 to use as the collect transformation function

parameter - a parameter to pass in for evaluation of the second argument P in function

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

targetCollection, which contains appended elements as a result of the collect transformation

collectIf

public <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)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.

e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 

Specified by:

collectIf in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

collectIf in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

collectIf in interface com.gs.collections.api.list.MutableList<T>

Specified by:

collectIf in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectIf in class AbstractMutableCollection<T>

collectIf

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)

Description copied from interface: com.gs.collections.api.RichIterable

Same as the collectIf method with two parameters but uses the specified target collection for the results.

Specified by:

collectIf in interface com.gs.collections.api.RichIterable<T>

Overrides:

collectIf in class AbstractMutableCollection<T>

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the collect criteria and transformation

See Also:

RichIterable.collectIf(Predicate, Function)

detect

public T detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

e.g.
 return people.detect(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

detect in interface com.gs.collections.api.RichIterable<T>

Overrides:

detect in class AbstractMutableCollection<T>

detectIfNone

public T detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
             com.gs.collections.api.block.function.Function0<? extends T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Specified by:

detectIfNone in interface com.gs.collections.api.RichIterable<T>

Overrides:

detectIfNone in class AbstractMutableCollection<T>

min

public T min(java.util.Comparator<? super T> comparator)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the minimum element out of this container based on the comparator.

Specified by:

min in interface com.gs.collections.api.RichIterable<T>

Overrides:

min in class AbstractMutableCollection<T>

max

public T max(java.util.Comparator<? super T> comparator)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the maximum element out of this container based on the comparator.

Specified by:

max in interface com.gs.collections.api.RichIterable<T>

Overrides:

max in class AbstractMutableCollection<T>

min

public T min()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the minimum element out of this container based on the natural order.

Specified by:

min in interface com.gs.collections.api.RichIterable<T>

Overrides:

min in class AbstractMutableCollection<T>

max

public T max()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the maximum element out of this container based on the natural order.

Specified by:

max in interface com.gs.collections.api.RichIterable<T>

Overrides:

max in class AbstractMutableCollection<T>

minBy

public <V extends java.lang.Comparable<? super V>> T minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

minBy in interface com.gs.collections.api.RichIterable<T>

Overrides:

minBy in class AbstractMutableCollection<T>

maxBy

public <V extends java.lang.Comparable<? super V>> T maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

maxBy in interface com.gs.collections.api.RichIterable<T>

Overrides:

maxBy in class AbstractMutableCollection<T>

detectWith

public <P> T detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
               P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

e.g.
 people.detectWith(new Predicate2<Person, String>()
 {
     public boolean value(Person person, String fullName)
     {
         return person.getFullName().equals(fullName);
     }
 }, "John Smith");
 

Specified by:

detectWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

detectWith in class AbstractMutableCollection<T>

detectWithIfNone

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)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns the first element of the collection that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.

Specified by:

detectWithIfNone in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

detectWithIfNone in class AbstractMutableCollection<T>

count

public int count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Return the total number of elements that answer true to the specified predicate.

e.g.
 return people.count(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

Specified by:

count in interface com.gs.collections.api.RichIterable<T>

Overrides:

count in class AbstractMutableCollection<T>

countWith

public <P> int countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns the total number of elements that evaluate to true for the specified predicate.

e.g.
 return lastNames.countWith(PredicatesLite.equal(), "Smith");
 

Specified by:

countWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

countWith in class AbstractMutableCollection<T>

anySatisfy

public boolean anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.

Specified by:

anySatisfy in interface com.gs.collections.api.RichIterable<T>

Overrides:

anySatisfy in class AbstractMutableCollection<T>

anySatisfyWith

public <P> boolean anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                         P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.

Specified by:

anySatisfyWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

anySatisfyWith in class AbstractMutableCollection<T>

allSatisfy

public boolean allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

allSatisfy in interface com.gs.collections.api.RichIterable<T>

Overrides:

allSatisfy in class AbstractMutableCollection<T>

allSatisfyWith

public <P> boolean allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                         P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns true if the predicate evaluates to true for every element of the collection, or returns false.

Specified by:

allSatisfyWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

allSatisfyWith in class AbstractMutableCollection<T>

noneSatisfy

public boolean noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.RichIterable

Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

noneSatisfy in interface com.gs.collections.api.RichIterable<T>

Overrides:

noneSatisfy in class AbstractMutableCollection<T>

noneSatisfyWith

public <P> boolean noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                          P parameter)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.

Specified by:

noneSatisfyWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

noneSatisfyWith in class AbstractMutableCollection<T>

injectInto

public <IV> IV injectInto(IV injectedValue,
                 com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.

Specified by:

injectInto in interface com.gs.collections.api.RichIterable<T>

Overrides:

injectInto in class AbstractMutableCollection<T>

injectInto

public int injectInto(int injectedValue,
             com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface com.gs.collections.api.RichIterable<T>

Overrides:

injectInto in class AbstractMutableCollection<T>

injectInto

public float injectInto(float injectedValue,
               com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface com.gs.collections.api.RichIterable<T>

Overrides:

injectInto in class AbstractMutableCollection<T>

distinct

public com.gs.collections.api.list.MutableList<T> distinct()

Description copied from interface: com.gs.collections.api.list.ListIterable

Returns a new ListIterable containing the distinct elements in this list.

Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears multiple times in this list, the first one will be copied into the result.

Specified by:

distinct in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

distinct in interface com.gs.collections.api.list.MutableList<T>

Returns:

ListIterable of distinct elements

sumOfInt

public long sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfInt in interface com.gs.collections.api.RichIterable<T>

Overrides:

sumOfInt in class AbstractMutableCollection<T>

sumOfLong

public long sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfLong in interface com.gs.collections.api.RichIterable<T>

Overrides:

sumOfLong in class AbstractMutableCollection<T>

sumOfFloat

public double sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfFloat in interface com.gs.collections.api.RichIterable<T>

Overrides:

sumOfFloat in class AbstractMutableCollection<T>

sumOfDouble

public double sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfDouble in interface com.gs.collections.api.RichIterable<T>

Overrides:

sumOfDouble in class AbstractMutableCollection<T>

injectInto

public long injectInto(long injectedValue,
              com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> function)

Description copied from interface: com.gs.collections.api.RichIterable

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface com.gs.collections.api.RichIterable<T>

Overrides:

injectInto in class AbstractMutableCollection<T>

injectIntoWith

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)

Specified by:

injectIntoWith in interface com.gs.collections.api.collection.MutableCollection<T>

Overrides:

injectIntoWith in class AbstractMutableCollection<T>

toList

public com.gs.collections.api.list.MutableList<T> toList()

Description copied from interface: com.gs.collections.api.RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface com.gs.collections.api.RichIterable<T>

Overrides:

toList in class AbstractMutableCollection<T>

toSortedList

public com.gs.collections.api.list.MutableList<T> toSortedList()

Description copied from interface: com.gs.collections.api.RichIterable

Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.

Specified by:

toSortedList in interface com.gs.collections.api.RichIterable<T>

Overrides:

toSortedList in class AbstractMutableCollection<T>

toSortedList

public com.gs.collections.api.list.MutableList<T> toSortedList(java.util.Comparator<? super T> comparator)

Description copied from interface: com.gs.collections.api.RichIterable

Converts the collection to a MutableList implementation and sorts it using the specified comparator.

Specified by:

toSortedList in interface com.gs.collections.api.RichIterable<T>

Overrides:

toSortedList in class AbstractMutableCollection<T>

toSet

public com.gs.collections.api.set.MutableSet<T> toSet()

Description copied from interface: com.gs.collections.api.RichIterable

Converts the collection to a MutableSet implementation.

Specified by:

toSet in interface com.gs.collections.api.RichIterable<T>

Overrides:

toSet in class AbstractMutableCollection<T>

toStack

public com.gs.collections.api.stack.MutableStack<T> toStack()

Description copied from interface: com.gs.collections.api.list.ListIterable

Converts the list to a mutable MutableStack implementation.

Specified by:

toStack in interface com.gs.collections.api.list.ListIterable<T>

asUnmodifiable

public com.gs.collections.api.list.MutableList<T> asUnmodifiable()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns an unmodifiable view of this collection. This method allows modules to provide users with "read-only" access to internal collections. Query operations on the returned collection "read through" to this collection, and attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

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.

Specified by:

asUnmodifiable in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

asUnmodifiable in interface com.gs.collections.api.list.MutableList<T>

Overrides:

asUnmodifiable in class AbstractMutableCollection<T>

Returns:

an unmodifiable view of this collection.

toImmutable

public com.gs.collections.api.list.ImmutableList<T> toImmutable()

Description copied from interface: com.gs.collections.api.list.MutableList

Returns an immutable copy of this list. If the list is immutable, it returns itself. The returned list will be Serializable if this list is Serializable.

Specified by:

toImmutable in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

toImmutable in interface com.gs.collections.api.list.MutableList<T>

asSynchronized

public com.gs.collections.api.list.MutableList<T> asSynchronized()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.

It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.

  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.

Specified by:

asSynchronized in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

asSynchronized in interface com.gs.collections.api.list.MutableList<T>

Overrides:

asSynchronized in class AbstractMutableCollection<T>

Returns:

a synchronized view of this collection.

sortThis

public com.gs.collections.api.list.MutableList<T> sortThis(java.util.Comparator<? super T> comparator)

Description copied from interface: com.gs.collections.api.list.MutableList

Sorts the internal data structure of this list and returns the list itself as a convenience.

Specified by:

sortThis in interface com.gs.collections.api.list.MutableList<T>

defaultSort

protected void defaultSort(java.util.Comparator<? super T> comparator)

Override in subclasses where it can be optimized.

sortThis

public com.gs.collections.api.list.MutableList<T> sortThis()

Description copied from interface: com.gs.collections.api.list.MutableList

Sorts the internal data structure of this list and returns the list itself as a convenience.

Specified by:

sortThis in interface com.gs.collections.api.list.MutableList<T>

sortThisBy

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)

Description copied from interface: com.gs.collections.api.list.MutableList

Sorts the internal data structure of this list based on the natural order of the attribute returned by function.

Specified by:

sortThisBy in interface com.gs.collections.api.list.MutableList<T>

newEmpty

public com.gs.collections.api.list.MutableList<T> newEmpty()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.

Specified by:

newEmpty in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

newEmpty in interface com.gs.collections.api.list.MutableList<T>

Overrides:

newEmpty in class AbstractMutableCollection<T>

forEach

public void forEach(int from,
           int to,
           com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

Description copied from interface: com.gs.collections.api.list.ListIterable

Iterates over the section of the list covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
 ListIterable people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEach in interface com.gs.collections.api.list.ListIterable<T>

indexOf

public int indexOf(java.lang.Object o)

Description copied from interface: com.gs.collections.api.list.ListIterable

Returns the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the item.

Specified by:

indexOf in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

indexOf in interface java.util.List<T>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Description copied from interface: com.gs.collections.api.list.ListIterable

Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.

Specified by:

lastIndexOf in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

lastIndexOf in interface java.util.List<T>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.List<T>

Specified by:

iterator in class java.util.AbstractCollection<T>

listIterator

public java.util.ListIterator<T> listIterator()

Specified by:

listIterator in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

listIterator in interface java.util.List<T>

See Also:

List.listIterator()

listIterator

public java.util.ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

listIterator in interface java.util.List<T>

See Also:

List.listIterator(int)

toReversed

public com.gs.collections.api.list.MutableList<T> toReversed()

Description copied from interface: com.gs.collections.api.list.MutableList

Returns a new MutableList in reverse order

Specified by:

toReversed in interface com.gs.collections.api.list.MutableList<T>

reverseThis

public com.gs.collections.api.list.MutableList<T> reverseThis()

Description copied from interface: com.gs.collections.api.list.MutableList

Mutates the current list by reversing its order and returns the current list as a result

Specified by:

reverseThis in interface com.gs.collections.api.list.MutableList<T>

subList

public com.gs.collections.api.list.MutableList<T> subList(int fromIndex,
                                                 int toIndex)

Specified by:

subList in interface com.gs.collections.api.list.MutableList<T>

Specified by:

subList in interface java.util.List<T>

contains

public boolean contains(java.lang.Object object)

Description copied from interface: com.gs.collections.api.RichIterable

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

contains in interface com.gs.collections.api.RichIterable<T>

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.List<T>

Overrides:

contains in class java.util.AbstractCollection<T>

containsAll

public boolean containsAll(java.util.Collection<?> source)

Specified by:

containsAll in interface com.gs.collections.api.RichIterable<T>

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.List<T>

Overrides:

containsAll in class java.util.AbstractCollection<T>

See Also:

Collection.containsAll(Collection)

removeAll

public boolean removeAll(java.util.Collection<?> collection)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

Overrides:

removeAll in class java.util.AbstractCollection<T>

retainAll

public boolean retainAll(java.util.Collection<?> collection)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

Overrides:

retainAll in class java.util.AbstractCollection<T>

getFirst

public T getFirst()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Specified by:

getFirst in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

getFirst in interface com.gs.collections.api.RichIterable<T>

Overrides:

getFirst in class AbstractMutableCollection<T>

getLast

public T getLast()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Specified by:

getLast in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

getLast in interface com.gs.collections.api.RichIterable<T>

Overrides:

getLast in class AbstractMutableCollection<T>

appendString

public void appendString(java.lang.Appendable appendable,
                java.lang.String start,
                java.lang.String separator,
                java.lang.String end)

Description copied from interface: com.gs.collections.api.RichIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).

Specified by:

appendString in interface com.gs.collections.api.RichIterable<T>

Overrides:

appendString in class AbstractMutableCollection<T>

groupBy

public <V> FastListMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Description copied from interface: com.gs.collections.api.RichIterable

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.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

groupBy in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

groupBy in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

groupBy in interface com.gs.collections.api.list.MutableList<T>

Specified by:

groupBy in interface com.gs.collections.api.RichIterable<T>

groupByEach

public <V> FastListMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)

Description copied from interface: com.gs.collections.api.RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

groupByEach in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

groupByEach in interface com.gs.collections.api.list.MutableList<T>

Specified by:

groupByEach in interface com.gs.collections.api.RichIterable<T>

zip

public <S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)

Description copied from interface: com.gs.collections.api.RichIterable

Returns a RichIterable 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.

Specified by:

zip in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

zip in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

zip in interface com.gs.collections.api.list.MutableList<T>

Specified by:

zip in interface com.gs.collections.api.RichIterable<T>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable 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.

zipWithIndex

public com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()

Description copied from interface: com.gs.collections.api.RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.list.MutableList<T>

Specified by:

zipWithIndex in interface com.gs.collections.api.RichIterable<T>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

with

public com.gs.collections.api.list.MutableList<T> with(T element)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.with("1");
 list = list.with("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.

Specified by:

with in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

with in interface com.gs.collections.api.list.MutableList<T>

See Also:

Collection.add(Object)

without

public com.gs.collections.api.list.MutableList<T> without(T element)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.without("1");
 list = list.without("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.

Specified by:

without in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

without in interface com.gs.collections.api.list.MutableList<T>

See Also:

Collection.remove(Object)

withAll

public com.gs.collections.api.list.MutableList<T> withAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.

Specified by:

withAll in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

withAll in interface com.gs.collections.api.list.MutableList<T>

See Also:

Collection.addAll(Collection)

withoutAll

public com.gs.collections.api.list.MutableList<T> withoutAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.

Specified by:

withoutAll in interface com.gs.collections.api.collection.MutableCollection<T>

Specified by:

withoutAll in interface com.gs.collections.api.list.MutableList<T>

See Also:

Collection.removeAll(Collection)

asReversed

public ReverseIterable<T> asReversed()

takeWhile

public com.gs.collections.api.list.MutableList<T> takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.list.ListIterable

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Specified by:

takeWhile in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

takeWhile in interface com.gs.collections.api.list.MutableList<T>

dropWhile

public com.gs.collections.api.list.MutableList<T> dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.list.ListIterable

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Specified by:

dropWhile in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

dropWhile in interface com.gs.collections.api.list.MutableList<T>

partitionWhile

public com.gs.collections.api.partition.list.PartitionMutableList<T> partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Description copied from interface: com.gs.collections.api.list.ListIterable

Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.

Specified by:

partitionWhile in interface com.gs.collections.api.list.ListIterable<T>

Specified by:

partitionWhile in interface com.gs.collections.api.list.MutableList<T>