com.gs.collections.impl.list.mutable

Class RandomAccessListAdapter<T>

java.lang.Object

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

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

com.gs.collections.impl.list.mutable.RandomAccessListAdapter<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>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess

public final class RandomAccessListAdapter<T>
extends AbstractListAdapter<T>
implements java.util.RandomAccess, java.io.Serializable

This class provides a MutableList wrapper around a JDK Collections List interface instance. All of the MutableList interface methods are supported in addition to the JDK List interface methods.

To create a new wrapper around an existing List instance, use the adapt(List) factory method.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static <E> com.gs.collections.api.list.MutableList<E>	adapt(java.util.List<E> list)
boolean	allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
boolean	anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to true for any element of the iterable.
com.gs.collections.api.list.MutableList<T>	asSynchronized() Returns a synchronized (thread-safe) collection backed by this collection.
com.gs.collections.api.list.MutableList<T>	asUnmodifiable() Returns an unmodifable view of the list.
com.gs.collections.api.list.MutableList<T>	clone()
<V> com.gs.collections.api.list.MutableList<V>	collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.
com.gs.collections.api.list.primitive.MutableBooleanList	collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction) Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.list.primitive.MutableByteList	collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction) Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.list.primitive.MutableCharList	collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction) Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.list.primitive.MutableDoubleList	collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction) Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.list.primitive.MutableFloatList	collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction) Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> com.gs.collections.api.list.MutableList<V>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.
com.gs.collections.api.list.primitive.MutableIntList	collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction) Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.list.primitive.MutableLongList	collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction) Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.list.primitive.MutableShortList	collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction) Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P,V> com.gs.collections.api.list.MutableList<V>	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter) Same as collect with a Function2 and specified parameter which is passed to the block
int	count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Return the total number of elements that answer true to the specified predicate.
T	detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
T	detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function0<? extends T> function) Returns the first element of the iterable for which the predicate evaluates to true.
com.gs.collections.api.list.MutableList<T>	distinct() Returns a new ListIterable containing the distinct elements in this list.
com.gs.collections.api.list.MutableList<T>	dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the final elements that do not satisfy the Predicate.
<V> com.gs.collections.api.list.MutableList<V>	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) flatCollect is a special case of RichIterable.collect(Function).
void	forEach(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.Procedure<? super T> procedure) Iterates over the section of the list covered by the specified inclusive indexes.
void	forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) The procedure is executed for each element in the iterable.
void	forEachWithIndex(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the section of the list covered by the specified inclusive indexes.
void	forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
protected java.util.List<T>	getDelegate()
<V> FastListMultimap<V,T>	groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V> FastListMultimap<V,T>	groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<IV> IV	injectInto(IV injectedValue, com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function) Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
com.gs.collections.api.list.MutableList<T>	newEmpty() Deprecated. use FastList.newList() instead (inlineable)
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.
com.gs.collections.api.partition.list.PartitionMutableList<T>	partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
com.gs.collections.api.partition.list.PartitionMutableList<T>	partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> com.gs.collections.api.partition.list.PartitionMutableList<T>	partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.
com.gs.collections.api.list.MutableList<T>	reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
<P> com.gs.collections.api.list.MutableList<T>	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
void	reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) Evaluates the procedure for each element of the list iterating in reverse order.
com.gs.collections.api.list.MutableList<T>	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
<S> com.gs.collections.api.list.MutableList<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> com.gs.collections.api.list.MutableList<T>	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
RandomAccessListAdapter<T>	sortThis() Sorts the internal data structure of this list and returns the list itself as a convenience.
RandomAccessListAdapter<T>	sortThis(java.util.Comparator<? super T> comparator) Sorts the internal data structure of this list and returns the list itself as a convenience.
<V extends java.lang.Comparable<? super V>> com.gs.collections.api.list.MutableList<T>	sortThisBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Sorts the internal data structure of this list based on the natural order of the attribute returned by function.
com.gs.collections.api.list.MutableList<T>	takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the initial elements that satisfy the Predicate.
com.gs.collections.api.list.ImmutableList<T>	toImmutable() Returns an immutable copy of this list.
RandomAccessListAdapter<T>	with(T... elements)
RandomAccessListAdapter<T>	with(T element) This method allows mutable and fixed size collections the ability to add elements to their existing elements.
RandomAccessListAdapter<T>	with(T element1, T element2)
RandomAccessListAdapter<T>	with(T element1, T element2, T element3)
RandomAccessListAdapter<T>	withAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
RandomAccessListAdapter<T>	without(T element) This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
RandomAccessListAdapter<T>	withoutAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
<S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>>	zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

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

add, addAll, asReversed, binarySearch, binarySearch, equals, get, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, reverseThis, set, subList, swapElements, toReversed, toStack

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

add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfyWith, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, countWith, detectWith, detectWithIfNone, flatCollect, forEachWith, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectIntoWith, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, wrap, zip, 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, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith

Methods inherited from interface java.util.List

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

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

getFirst, getLast

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

allSatisfyWith, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, countWith, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

forEachWith

Method Detail

getDelegate

protected java.util.List<T> getDelegate()

Specified by:

getDelegate in class AbstractListAdapter<T>

adapt

public static <E> com.gs.collections.api.list.MutableList<E> adapt(java.util.List<E> list)

toImmutable

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

asUnmodifiable

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

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

Returns an unmodifable view of the list. The returned list will be Serializable if this list is Serializable.

Specified by:

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

Specified by:

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

Returns:

an unmodifiable view of this list

asSynchronized

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

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

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

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

  MutableCollection collection = myCollection.asSynchronized();
     ...
  synchronized(collection)
  {
      Iterator i = c.iterator(); // Must be in the synchronized block
      while (i.hasNext())
         foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableCollection collection = myCollection.asSynchronized();
     ...
  collection.forEach(new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if this collection is serializable.

Specified by:

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

Specified by:

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

Returns:

a synchronized view of this collection.

clone

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

Specified by:

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

Overrides:

clone in class AbstractListAdapter<T>

newEmpty

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

Deprecated. use FastList.newList() instead (inlineable)

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

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

Specified by:

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

Specified by:

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

forEach

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

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

The procedure is executed for each element in the iterable.

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

Specified by:

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

Overrides:

forEach in class AbstractCollectionAdapter<T>

reverseForEach

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

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

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

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

Specified by:

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

forEachWithIndex

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

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

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

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

Specified by:

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

Overrides:

forEachWithIndex in class AbstractCollectionAdapter<T>

forEachWithIndex

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

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

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

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

This code would output ted and mary's names.

Specified by:

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

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

detectIfNone

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

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

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

Specified by:

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

Overrides:

detectIfNone in class AbstractCollectionAdapter<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 AbstractCollectionAdapter<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 AbstractCollectionAdapter<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 AbstractCollectionAdapter<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 AbstractCollectionAdapter<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 AbstractCollectionAdapter<T>

forEach

public void forEach(int fromIndex,
           int toIndex,
           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>

sortThis

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

sortThis

public RandomAccessListAdapter<T> sortThis()

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

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

Specified by:

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

sortThisBy

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

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

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

Specified by:

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

with

public RandomAccessListAdapter<T> with(T element)

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.add(Object)

with

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

with

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

with

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

without

public RandomAccessListAdapter<T> without(T element)

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.remove(Object)

withAll

public RandomAccessListAdapter<T> withAll(java.lang.Iterable<? extends T> elements)

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.addAll(Collection)

withoutAll

public RandomAccessListAdapter<T> withoutAll(java.lang.Iterable<? extends T> elements)

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.removeAll(Collection)

select

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

select in class AbstractListAdapter<T>

reject

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

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

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

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

e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

reject in class AbstractListAdapter<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

partition

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

partition in class AbstractListAdapter<T>

partitionWith

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

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

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

e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
     public boolean accept(Person person, String state)
     {
         return person.getAddress().getState().getName().equals(state);
     }
 }, "New York");
 

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

partitionWith in class AbstractListAdapter<T>

selectInstancesOf

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

selectInstancesOf in class AbstractListAdapter<T>

collect

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collect in class AbstractListAdapter<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 AbstractListAdapter<T>

collectByte

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectByte in class AbstractListAdapter<T>

collectChar

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectChar in class AbstractListAdapter<T>

collectDouble

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectDouble in class AbstractListAdapter<T>

collectFloat

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectFloat in class AbstractListAdapter<T>

collectInt

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectInt in class AbstractListAdapter<T>

collectLong

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectLong in class AbstractListAdapter<T>

collectShort

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

collectShort in class AbstractListAdapter<T>

flatCollect

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

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

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

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

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

Using collect returns a collection of collections of addresses.

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

Using flatCollect returns a single flattened list of addresses.

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

flatCollect in class AbstractListAdapter<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectIf

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

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

groupByEach

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

groupByEach in class AbstractListAdapter<T>

selectWith

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

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

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

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

Specified by:

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

Specified by:

selectWith in interface com.gs.collections.api.list.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 AbstractListAdapter<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> com.gs.collections.api.list.MutableList<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                        P parameter)

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

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

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

Specified by:

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

Specified by:

rejectWith in interface com.gs.collections.api.list.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 AbstractListAdapter<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)

collectWith

public <P,V> com.gs.collections.api.list.MutableList<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
                                                           P parameter)

Description copied from interface: com.gs.collections.api.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 AbstractListAdapter<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)

distinct

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

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

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

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

ListIterable of distinct elements

zip

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

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

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

zip in class AbstractListAdapter<T>

Type Parameters:

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

Parameters:

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

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

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

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

Zips this RichIterable with its indices.

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

zipWithIndex in class AbstractListAdapter<T>

Returns:

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

See Also:

RichIterable.zip(Iterable)

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>

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>

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>