com.gs.collections.impl.list.mutable

Class FastList<T>

java.lang.Object

com.gs.collections.impl.AbstractRichIterable<T>

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

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

com.gs.collections.impl.list.mutable.FastList<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.ordered.ReversibleIterable<T>, com.gs.collections.api.RichIterable<T>, BatchIterable<T>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess

@NotThreadSafe
public class FastList<T>
extends AbstractMutableList<T>
implements java.io.Externalizable, java.util.RandomAccess, BatchIterable<T>

FastList is an attempt to provide the same functionality as ArrayList without the support for concurrent modification exceptions. It also attempts to correct the problem with subclassing ArrayList in that the data elements are protected, not private. It is this issue that caused this class to be created in the first place. The intent was to provide optimized internal iterators which use direct access against the array of items, which is currently not possible by subclassing ArrayList.

An empty FastList created by calling the default constructor starts with a shared reference to a static empty array (DEFAULT_SIZED_EMPTY_ARRAY). This makes empty FastLists very memory efficient. The first call to add will lazily create an array of size 10.

An empty FastList created by calling the pre-size constructor with a value of 0 (new FastList(0)) starts with a shared reference to a static empty array (ZERO_SIZED_ARRAY). This makes FastLists presized to 0 very memory efficient as well. The first call to add will lazily create an array of size 1.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gs.collections.impl.list.mutable.AbstractMutableList

AbstractMutableList.SubList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected T[]	items
protected int	size

Constructor Summary

Constructors

Modifier	Constructor and Description
	FastList()
	FastList(java.util.Collection<? extends T> source)
	FastList(int initialCapacity)
protected	FastList(int size, T[] array)
protected	FastList(T[] array)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	add(T newItem)
boolean	addAll(java.util.Collection<? extends T> source)
boolean	addAll(int index, java.util.Collection<? extends T> source)
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.
com.gs.collections.api.list.ParallelListIterable<T>	asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)
void	batchForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure, int sectionIndex, int sectionCount)
void	clear()
FastList<T>	clone()
<V> FastList<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.
<R extends com.gs.collections.api.collection.primitive.MutableBooleanCollection> R	collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction, R target) Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target 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.
<R extends com.gs.collections.api.collection.primitive.MutableByteCollection> R	collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction, R target) Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target 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.
<R extends com.gs.collections.api.collection.primitive.MutableCharCollection> R	collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction, R target) Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target 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.
<R extends com.gs.collections.api.collection.primitive.MutableDoubleCollection> R	collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction, R target) Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target 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.
<R extends com.gs.collections.api.collection.primitive.MutableFloatCollection> R	collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction, R target) Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.
<V> FastList<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.
<R extends com.gs.collections.api.collection.primitive.MutableIntCollection> R	collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction, R target) Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target 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.
<R extends com.gs.collections.api.collection.primitive.MutableLongCollection> R	collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction, R target) Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target 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.
<R extends com.gs.collections.api.collection.primitive.MutableShortCollection> R	collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction, R target) Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.
<P,V> FastList<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
<P,V,R extends java.util.Collection<V>> R	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection) Same as collectWith but with a targetCollection parameter to gather the results.
boolean	containsAll(java.util.Collection<?> source) Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(java.lang.Object... source) Returns true if all elements in the specified var arg array are contained in this collection.
int	count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns the total number of elements that evaluate to true for the specified predicate.
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> defaultValueBlock) 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> defaultValueBlock) Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
FastList<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.
void	ensureCapacity(int minCapacity)
boolean	equals(FastList<?> otherList) Deprecated. in 1.3
boolean	equals(java.lang.Object otherList) Follows the same general contract as List.equals(Object).
boolean	fastListEquals(FastList<?> otherFastList)
<V> FastList<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.
void	forEachIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
<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 from, int to, 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	get(int index) Returns the item at the specified position in this list iterable.
int	getBatchCount(int batchSize)
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,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R	groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target) Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
int	hashCode() Follows the same general contract as List.hashCode().
int	indexOf(java.lang.Object object) Returns the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the item.
double	injectInto(double injectedValue, com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super T> function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
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)
int	lastIndexOf(java.lang.Object object) Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
<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.
<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.
static <E> FastList<E>	newList()
static <E> FastList<E>	newList(int initialCapacity)
static <E> FastList<E>	newList(java.lang.Iterable<? extends E> source)
static <E> FastList<E>	newListWith(E... elements) Creates a new list using the passed elements argument as the backing store.
static <E> FastList<E>	newWithNValues(int size, com.gs.collections.api.block.function.Function0<E> factory) Creates a new FastList pre-sized to the specified size filled with default values generated by the specified function.
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>	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.
void	readExternal(java.io.ObjectInput in)
FastList<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> FastList<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 target) Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
T	remove(int index)
boolean	remove(java.lang.Object object)
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.
FastList<T>	reverseThis() Mutates the current list by reversing its order and returns the current list as a result
FastList<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> FastList<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> FastList<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.
T	set(int index, T element)
int	size() Returns the number of items in this iterable.
FastList<T>	sortThis() Sorts the internal data structure of this list and returns the list itself as a convenience.
FastList<T>	sortThis(java.util.Comparator<? super T> comparator) Sorts the internal data structure of this list and returns the list itself as a convenience.
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.
java.lang.Object[]	toArray() Converts this iterable to an array.
<E> E[]	toArray(E[] array) Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
<E> E[]	toArray(E[] array, int sourceFromIndex, int sourceToIndex, int destinationIndex)
<E> E[]	toArray(int sourceFromIndex, int sourceToIndex)
FastList<T>	toList() Converts the collection to a MutableList implementation.
FastList<T>	toSortedList() Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
FastList<T>	toSortedList(java.util.Comparator<? super T> comparator) Converts the collection to a MutableList implementation and sorts it using the specified comparator.
T[]	toTypedArray(java.lang.Class<T> clazz)
void	trimToSize()
boolean	trimToSizeIfGreaterThanPercent(double loadFactor) Express load factor as 0.25 to trim a collection with more than 25% excess capacity
FastList<T>	with(T... elements)
FastList<T>	with(T element1, T element2)
FastList<T>	with(T element1, T element2, T element3)
FastList<T>	withArrayCopy(T[] elements, int begin, int length)
static <E> FastList<E>	wrapCopy(E... array)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class com.gs.collections.impl.list.mutable.AbstractMutableList

appendString, asReversed, asSynchronized, asUnmodifiable, binarySearch, binarySearch, contains, defaultSort, groupByEach, groupByUniqueKey, iterator, listIterator, listIterator, max, max, min, min, newEmpty, partition, partitionWith, removeAll, retainAll, reverseForEach, sortThisBy, subList, toImmutable, toReversed, toSet, toStack, with, withAll, without, withoutAll, zip, zipWithIndex

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

addAllIterable, aggregateBy, aggregateInPlaceBy, chunk, removeAllIterable, retainAllIterable

Methods inherited from class com.gs.collections.impl.AbstractRichIterable

appendString, appendString, asLazy, containsAllIterable, groupByEach, isEmpty, makeString, makeString, makeString, notEmpty, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

isEmpty

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

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

Field Detail

size

protected int size

items

protected transient T[] items

Constructor Detail

FastList

public FastList()

FastList

public FastList(int initialCapacity)

FastList

protected FastList(T[] array)

FastList

protected FastList(int size,
        T[] array)

FastList

public FastList(java.util.Collection<? extends T> source)

Method Detail

newList

public static <E> FastList<E> newList()

wrapCopy

public static <E> FastList<E> wrapCopy(E... array)

newList

public static <E> FastList<E> newList(int initialCapacity)

newList

public static <E> FastList<E> newList(java.lang.Iterable<? extends E> source)

newListWith

public static <E> FastList<E> newListWith(E... elements)

Creates a new list using the passed elements argument as the backing store.

!!! WARNING: This method uses the passed in array, so can be very unsafe if the original array is held onto anywhere else. !!!

newWithNValues

public static <E> FastList<E> newWithNValues(int size,
                             com.gs.collections.api.block.function.Function0<E> factory)

Creates a new FastList pre-sized to the specified size filled with default values generated by the specified function.

Since:

3.0

clone

public FastList<T> clone()

Specified by:

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

Overrides:

clone in class AbstractMutableList<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.List<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>

Overrides:

forEach in class AbstractMutableList<T>

forEachWithIndex

public void forEachWithIndex(int from,
                    int to,
                    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>

Overrides:

forEachWithIndex in class AbstractMutableList<T>

batchForEach

public void batchForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure,
                int sectionIndex,
                int sectionCount)

Specified by:

batchForEach in interface BatchIterable<T>

getBatchCount

public int getBatchCount(int batchSize)

Specified by:

getBatchCount in interface BatchIterable<T>

toArray

public <E> E[] toArray(E[] array,
              int sourceFromIndex,
              int sourceToIndex,
              int destinationIndex)

toArray

public <E> E[] toArray(int sourceFromIndex,
              int sourceToIndex)

sortThis

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

Overrides:

sortThis in class AbstractMutableList<T>

sortThis

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

Overrides:

sortThis in class AbstractMutableList<T>

reverseThis

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

Overrides:

reverseThis in class AbstractMutableList<T>

addAll

public boolean addAll(java.util.Collection<? extends T> source)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class AbstractMutableCollection<T>

containsAll

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

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

Returns true if all elements in source are contained in this collection.

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 AbstractMutableList<T>

See Also:

Collection.containsAll(Collection)

containsAllArguments

public boolean containsAllArguments(java.lang.Object... source)

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

Returns true if all elements in the specified var arg array are contained in this collection.

Specified by:

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

Overrides:

containsAllArguments in class AbstractRichIterable<T>

toArray

public <E> E[] toArray(E[] array)

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

Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Specified by:

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

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray(Object[])

toArray

public java.lang.Object[] toArray()

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

Converts this iterable to an array.

Specified by:

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

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray()

toTypedArray

public T[] toTypedArray(java.lang.Class<T> clazz)

set

public T set(int index,
    T element)

Specified by:

set in interface java.util.List<T>

indexOf

public int indexOf(java.lang.Object object)

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

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.ordered.ReversibleIterable<T>

Specified by:

indexOf in interface java.util.List<T>

Overrides:

indexOf in class AbstractMutableList<T>

lastIndexOf

public int lastIndexOf(java.lang.Object object)

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>

Overrides:

lastIndexOf in class AbstractMutableList<T>

trimToSize

public void trimToSize()

trimToSizeIfGreaterThanPercent

public boolean trimToSizeIfGreaterThanPercent(double loadFactor)

Express load factor as 0.25 to trim a collection with more than 25% excess capacity

ensureCapacity

public void ensureCapacity(int minCapacity)

with

public FastList<T> with(T element1,
               T element2)

with

public FastList<T> with(T element1,
               T element2,
               T element3)

with

public FastList<T> with(T... elements)

withArrayCopy

public FastList<T> withArrayCopy(T[] elements,
                        int begin,
                        int length)

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 AbstractMutableList<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 AbstractMutableList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

groupBy in class AbstractMutableList<T>

groupBy

public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupBy(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.groupBy(Function), except that the results are gathered into the specified target multimap.

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

Specified by:

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

Overrides:

groupBy in class AbstractRichIterable<T>

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>

Specified by:

forEach in interface BatchIterable<T>

Overrides:

forEach in class AbstractMutableList<T>

forEachIf

public void forEachIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
             com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

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 AbstractMutableList<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 AbstractMutableList<T>

select

public FastList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

select in class AbstractMutableList<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 AbstractMutableList<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> FastList<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.ListIterable<T>

Specified by:

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

Specified by:

selectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

selectWith in class AbstractMutableList<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

See Also:

RichIterable.select(Predicate)

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 AbstractMutableList<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 FastList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

reject in class AbstractMutableList<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 AbstractMutableList<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> FastList<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.ListIterable<T>

Specified by:

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

Specified by:

rejectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

rejectWith in class AbstractMutableList<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

See Also:

RichIterable.select(Predicate)

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

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 AbstractMutableList<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

target - 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 AbstractMutableList<T>

selectInstancesOf

public <S> FastList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

selectInstancesOf in class AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<T>

collect

public <V> FastList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collect in class AbstractMutableList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectBoolean in class AbstractMutableList<T>

collectBoolean

public <R extends com.gs.collections.api.collection.primitive.MutableBooleanCollection> R collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction,
                                                                                                R target)

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

Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectBoolean in class AbstractRichIterable<T>

Parameters:

booleanFunction - a BooleanFunction to use as the collect transformation function

target - the MutableBooleanCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectByte in class AbstractMutableList<T>

collectByte

public <R extends com.gs.collections.api.collection.primitive.MutableByteCollection> R collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction,
                                                                                          R target)

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

Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectByte in class AbstractRichIterable<T>

Parameters:

byteFunction - a ByteFunction to use as the collect transformation function

target - the MutableByteCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectChar in class AbstractMutableList<T>

collectChar

public <R extends com.gs.collections.api.collection.primitive.MutableCharCollection> R collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction,
                                                                                          R target)

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

Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectChar in class AbstractRichIterable<T>

Parameters:

charFunction - a CharFunction to use as the collect transformation function

target - the MutableCharCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectDouble in class AbstractMutableList<T>

collectDouble

public <R extends com.gs.collections.api.collection.primitive.MutableDoubleCollection> R collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction,
                                                                                              R target)

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

Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectDouble in class AbstractRichIterable<T>

Parameters:

doubleFunction - a DoubleFunction to use as the collect transformation function

target - the MutableDoubleCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectFloat in class AbstractMutableList<T>

collectFloat

public <R extends com.gs.collections.api.collection.primitive.MutableFloatCollection> R collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction,
                                                                                            R target)

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

Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectFloat in class AbstractRichIterable<T>

Parameters:

floatFunction - a FloatFunction to use as the collect transformation function

target - the MutableFloatCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectInt in class AbstractMutableList<T>

collectInt

public <R extends com.gs.collections.api.collection.primitive.MutableIntCollection> R collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction,
                                                                                        R target)

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

Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectInt in class AbstractRichIterable<T>

Parameters:

intFunction - a IntFunction to use as the collect transformation function

target - the MutableIntCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectLong in class AbstractMutableList<T>

collectLong

public <R extends com.gs.collections.api.collection.primitive.MutableLongCollection> R collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction,
                                                                                          R target)

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

Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectLong in class AbstractRichIterable<T>

Parameters:

longFunction - a LongFunction to use as the collect transformation function

target - the MutableLongCollection to append to for all elements in this RichIterable

Returns:

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

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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectShort in class AbstractMutableList<T>

collectShort

public <R extends com.gs.collections.api.collection.primitive.MutableShortCollection> R collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction,
                                                                                            R target)

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

Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

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

Specified by:

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

Overrides:

collectShort in class AbstractRichIterable<T>

Parameters:

shortFunction - a ShortFunction to use as the collect transformation function

target - the MutableShortCollection to append to for all elements in this RichIterable

Returns:

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

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 AbstractMutableList<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> FastList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

flatCollect in class AbstractMutableList<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 AbstractMutableList<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> FastList<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.RichIterable

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.ListIterable<T>

Specified by:

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

Specified by:

collectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectWith in class AbstractMutableList<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

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

RichIterable.collect(Function)

collectWith

public <P,V,R extends java.util.Collection<V>> R collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> 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 AbstractMutableList<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> FastList<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.ordered.ReversibleIterable<T>

Specified by:

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

Overrides:

collectIf in class AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<T>

detectIfNone

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

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 AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<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.RichIterable

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.RichIterable<T>

Overrides:

detectWith in class AbstractMutableList<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> defaultValueBlock)

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

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

Specified by:

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

Overrides:

detectWithIfNone in class AbstractMutableList<T>

get

public T get(int index)

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

Returns the item at the specified position in this list iterable.

Specified by:

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

Specified by:

get in interface java.util.List<T>

add

public boolean add(T newItem)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.List<T>

Overrides:

add in class AbstractMutableCollection<T>

add

public void add(int index,
       T element)

Specified by:

add in interface java.util.List<T>

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class AbstractMutableCollection<T>

addAll

public boolean addAll(int index,
             java.util.Collection<? extends T> source)

Specified by:

addAll in interface java.util.List<T>

size

public int size()

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

Returns the number of items in this iterable.

Specified by:

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

Specified by:

size in interface BatchIterable<T>

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<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 AbstractMutableList<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.RichIterable

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.RichIterable<T>

Overrides:

countWith in class AbstractMutableList<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 AbstractMutableList<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.RichIterable

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.RichIterable<T>

Overrides:

anySatisfyWith in class AbstractMutableList<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 AbstractMutableList<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.RichIterable

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.RichIterable<T>

Overrides:

allSatisfyWith in class AbstractMutableList<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 AbstractMutableList<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.RichIterable

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.RichIterable<T>

Overrides:

noneSatisfyWith in class AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<T>

injectInto

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

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

Returns the final double 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 AbstractRichIterable<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 AbstractMutableList<T>

distinct

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

Specified by:

distinct in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Overrides:

distinct in class AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<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 AbstractMutableList<T>

toList

public FastList<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 AbstractMutableList<T>

toSortedList

public FastList<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 AbstractMutableList<T>

toSortedList

public FastList<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 AbstractMutableList<T>

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>

Specified by:

takeWhile in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Overrides:

takeWhile in class AbstractMutableList<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>

Specified by:

dropWhile in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Overrides:

dropWhile in class AbstractMutableList<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>

Specified by:

partitionWhile in interface com.gs.collections.api.ordered.ReversibleIterable<T>

Overrides:

partitionWhile in class AbstractMutableList<T>

equals

public boolean equals(java.lang.Object otherList)

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 AbstractMutableList<T>

fastListEquals

public boolean fastListEquals(FastList<?> otherFastList)

equals

@Deprecated
public boolean equals(FastList<?> otherList)

Deprecated. in 1.3

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 AbstractMutableList<T>

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

asParallel

public com.gs.collections.api.list.ParallelListIterable<T> asParallel(java.util.concurrent.ExecutorService executorService,
                                                             int batchSize)