com.gs.collections.impl.list.mutable

Class MultiReaderFastList<T>

java.lang.Object

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

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

public final class MultiReaderFastList<T>
extends AbstractMultiReaderMutableCollection<T>
implements java.util.RandomAccess, java.io.Externalizable, com.gs.collections.api.list.MutableList<T>

MultiReadFastList provides a thread-safe wrapper around a FastList, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderFastList does not implement iterator(), listIterator(), listIterator(int), or get(int), as all of these methods require an external lock to be taken to provide thread-safe iteration. All of these methods are available however, if you use the withReadLockAndDelegate() or withWriteLockAndDelegate() methods. Both of these methods take a parameter of type Procedure, and a wrapped version of the underlying FastList is returned. This wrapper guarantees that no external pointer can ever reference the underlying FastList outside of a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gs.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection

AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>

Constructor Summary

Constructors

Constructor and Description
MultiReaderFastList()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	addAll(int index, java.util.Collection<? extends T> collection)
com.gs.collections.api.LazyIterable<T>	asReversed() Returns a reversed view of this ListIterable.
com.gs.collections.api.list.MutableList<T>	asSynchronized() Returns a synchronized (thread-safe) collection backed by this collection.
com.gs.collections.api.list.MutableList<T>	asUnmodifiable() Returns an unmodifable view of the list.
int	binarySearch(T key) Searches for the specified object using the binary search algorithm.
int	binarySearch(T key, java.util.Comparator<? super T> comparator) Searches for the specified object using the binary search algorithm.
com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>>	chunk(int size) Partitions elements in fixed size chunks.
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
com.gs.collections.api.list.MutableList<T>	distinct() Returns a new ListIterable containing the distinct elements in this list.
com.gs.collections.api.list.MutableList<T>	dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the final elements that do not satisfy the Predicate.
boolean	equals(java.lang.Object o) Follows the same general contract as List.equals(Object).
<V> com.gs.collections.api.list.MutableList<V>	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) flatCollect is a special case of RichIterable.collect(Function).
void	forEach(int startIndex, int endIndex, com.gs.collections.api.block.procedure.Procedure<? super T> procedure) Iterates over the section of the list covered by the specified inclusive indexes.
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.
T	get(int index) Returns the item at the specified position in this list iterable.
protected com.gs.collections.api.list.MutableList<T>	getDelegate()
protected java.util.concurrent.locks.ReadWriteLock	getLock()
<V> com.gs.collections.api.multimap.list.MutableListMultimap<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> com.gs.collections.api.multimap.list.MutableListMultimap<V,T>	groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V> com.gs.collections.api.map.MutableMap<V,T>	groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function) For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode() Follows the same general contract as List.hashCode().
int	indexOf(java.lang.Object o) Returns the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the item.
int	lastIndexOf(java.lang.Object o) Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
java.util.ListIterator<T>	listIterator() This method is not supported directly on a MultiReaderFastList.
java.util.ListIterator<T>	listIterator(int index) This method is not supported directly on a MultiReaderFastList.
com.gs.collections.api.list.MutableList<T>	newEmpty() Creates a new empty mutable version of the same collection type.
static <T> MultiReaderFastList<T>	newList()
static <T> MultiReaderFastList<T>	newList(int capacity)
static <T> MultiReaderFastList<T>	newList(java.lang.Iterable<T> iterable)
static <T> MultiReaderFastList<T>	newListWith(T... elements)
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.
void	readExternal(java.io.ObjectInput in)
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.
T	remove(int index)
void	reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) Evaluates the procedure for each element of the list iterating in reverse order.
com.gs.collections.api.list.MutableList<T>	reverseThis() Mutates the current list by reversing its order and returns the current list as a result
com.gs.collections.api.list.MutableList<T>	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
<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.
T	set(int index, T element)
com.gs.collections.api.list.MutableList<T>	sortThis() Sorts the internal data structure of this list and returns the list itself as a convenience.
com.gs.collections.api.list.MutableList<T>	sortThis(java.util.Comparator<? super T> comparator) Sorts the internal data structure of this list and returns the list itself as a convenience.
<V extends java.lang.Comparable<? super V>> com.gs.collections.api.list.MutableList<T>	sortThisBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Sorts the internal data structure of this list based on the natural order of the attribute returned by function.
com.gs.collections.api.list.MutableList<T>	subList(int fromIndex, int toIndex)
com.gs.collections.api.list.MutableList<T>	takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the initial elements that satisfy the Predicate.
com.gs.collections.api.list.ImmutableList<T>	toImmutable() Returns an immutable copy of this list.
com.gs.collections.api.list.MutableList<T>	toReversed() Returns a new MutableList in reverse order
com.gs.collections.api.stack.MutableStack<T>	toStack() Converts the list to a mutable MutableStack implementation.
com.gs.collections.api.list.MutableList<T>	with(T element) This method allows mutable and fixed size collections the ability to add elements to their existing elements.
com.gs.collections.api.list.MutableList<T>	withAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
com.gs.collections.api.list.MutableList<T>	without(T element) This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
com.gs.collections.api.list.MutableList<T>	withoutAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
void	withReadLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.list.MutableList<T>> procedure)
void	withWriteLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.list.MutableList<T>> procedure)
void	writeExternal(java.io.ObjectOutput out)
<S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>>	zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

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

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

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, 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

forEach, forEachWith, forEachWithIndex

Constructor Detail

MultiReaderFastList

public MultiReaderFastList()

Method Detail

newList

public static <T> MultiReaderFastList<T> newList()

newList

public static <T> MultiReaderFastList<T> newList(int capacity)

newList

public static <T> MultiReaderFastList<T> newList(java.lang.Iterable<T> iterable)

newListWith

public static <T> MultiReaderFastList<T> newListWith(T... elements)

getDelegate

protected com.gs.collections.api.list.MutableList<T> getDelegate()

Specified by:

getDelegate in class AbstractMultiReaderMutableCollection<T>

getLock

protected java.util.concurrent.locks.ReadWriteLock getLock()

Specified by:

getLock in class AbstractMultiReaderMutableCollection<T>

withReadLockAndDelegate

public void withReadLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.list.MutableList<T>> procedure)

withWriteLockAndDelegate

public void withWriteLockAndDelegate(com.gs.collections.api.block.procedure.Procedure<com.gs.collections.api.list.MutableList<T>> procedure)

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.

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

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>

clone

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

Specified by:

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

Overrides:

clone in class java.lang.Object

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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)

newEmpty

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

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

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

Specified by:

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

Specified by:

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

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>

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

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>

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)

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>

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>

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)

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>

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>

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>

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

sortThis

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

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

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

Specified by:

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

sortThis

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

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

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

Specified by:

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

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>

subList

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

Specified by:

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

Specified by:

subList in interface java.util.List<T>

equals

public boolean equals(java.lang.Object o)

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

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

Specified by:

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

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.List<T>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

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

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

Specified by:

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

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.List<T>

Overrides:

hashCode in class java.lang.Object

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>

indexOf

public int indexOf(java.lang.Object o)

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>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

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

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

Specified by:

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

Specified by:

lastIndexOf in interface java.util.List<T>

with

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

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.add(Object)

without

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

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.remove(Object)

withAll

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

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.addAll(Collection)

withoutAll

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

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

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

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

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

Specified by:

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

Specified by:

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

See Also:

Collection.removeAll(Collection)

listIterator

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

This method is not supported directly on a MultiReaderFastList. If you would like to use a ListIterator with MultiReaderFastList, then you must do the following:

 multiReaderList.withReadLockAndDelegate(new Procedure>()
 {
     public void value(MutableList people)
     {
         Iterator it = people.listIterator();
         ....
     }
 });
 

Specified by:

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

Specified by:

listIterator in interface java.util.List<T>

See Also:

List.listIterator()

listIterator

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

This method is not supported directly on a MultiReaderFastList. If you would like to use a ListIterator with MultiReaderFastList, then you must do the following:

 multiReaderList.withReadLockAndDelegate(new Procedure>()
 {
     public void value(MutableList people)
     {
         Iterator it = people.listIterator(0);
         ....
     }
 });
 

Specified by:

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

Specified by:

listIterator in interface java.util.List<T>

See Also:

List.listIterator(int)

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

set

public T set(int index,
    T element)

Specified by:

set in interface java.util.List<T>

addAll

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

Specified by:

addAll in interface java.util.List<T>

add

public void add(int index,
       T element)

Specified by:

add in interface java.util.List<T>

forEach

public void forEach(int startIndex,
           int endIndex,
           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>

binarySearch

public int binarySearch(T key,
               java.util.Comparator<? super T> comparator)

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

Searches for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator.

Specified by:

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

See Also:

Collections.binarySearch(java.util.List, Object, java.util.Comparator)

binarySearch

public int binarySearch(T key)

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

Searches for the specified object using the binary search algorithm. The elements in this list must implement Comparable and the list must be sorted into ascending order.

Specified by:

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

See Also:

Collections.binarySearch(java.util.List, Object)

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

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

groupBy

public <V> com.gs.collections.api.multimap.list.MutableListMultimap<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>

groupByEach

public <V> com.gs.collections.api.multimap.list.MutableListMultimap<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>

groupByUniqueKey

public <V> com.gs.collections.api.map.MutableMap<V,T> groupByUniqueKey(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 he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

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

Specified by:

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

See Also:

RichIterable.groupBy(Function)

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>

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>

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)

toReversed

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

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

Returns a new MutableList in reverse order

Specified by:

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

reverseThis

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

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

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

Specified by:

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

toStack

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

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

Converts the list to a mutable MutableStack implementation.

Specified by:

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

Specified by:

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

chunk

public com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>> chunk(int size)

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

Partitions elements in fixed size chunks.

Specified by:

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

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.

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>

asReversed

public com.gs.collections.api.LazyIterable<T> asReversed()

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

Returns a reversed view of this ListIterable.

Specified by:

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

Specified by:

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