com.gs.collections.impl.list.fixed

Class AbstractArrayAdapter<T>

java.lang.Object

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

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

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

com.gs.collections.impl.list.fixed.AbstractArrayAdapter<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.OrderedIterable<T>, com.gs.collections.api.ordered.ReversibleIterable<T>, com.gs.collections.api.RichIterable<T>, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess

Direct Known Subclasses:

ArrayAdapter

public abstract class AbstractArrayAdapter<T>
extends AbstractMutableList<T>
implements java.util.RandomAccess

Nested Class Summary

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

AbstractMutableList.SubList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected T[]	items

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractArrayAdapter() This method must be here so subclasses can be serializable.
protected	AbstractArrayAdapter(T[] newElements)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	abstractArrayAdapterEquals(AbstractArrayAdapter<?> list)
void	add(int index, T element)
boolean	addAll(java.util.Collection<? extends T> collection)
boolean	addAll(int index, java.util.Collection<? extends T> collection)
boolean	addAllIterable(java.lang.Iterable<? extends T> iterable)
boolean	allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
<P> boolean	allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for any element of the collection, or return false.
void	appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end) Prints a string representation of this collection onto the given Appendable.
void	clear()
<V> com.gs.collections.api.list.MutableList<V>	collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.
<V,R extends java.util.Collection<V>> R	collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target) Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
<V> com.gs.collections.api.list.MutableList<V>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.
<V,R extends java.util.Collection<V>> R	collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target) Same as the collectIf method with two parameters but uses the specified target collection for the results.
<P,A> com.gs.collections.api.list.MutableList<A>	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function, P parameter) Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<P,A,R extends java.util.Collection<A>> R	collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function, P parameter, R target) Same as collectWith but with a targetCollection parameter to gather the results.
boolean	contains(java.lang.Object o) Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(java.util.Collection<?> collection) Returns true if all elements in source are contained in this collection.
<S> boolean	corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other, com.gs.collections.api.block.predicate.Predicate2<? super T,? super S> predicate) Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
int	count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns the total number of elements that evaluate to true for the specified predicate.
T	detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
T	detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function0<? extends T> function) Returns the first element of the iterable for which the predicate evaluates to true.
int	detectIndex(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
int	detectLastIndex(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true.
<P> T	detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
<P> T	detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, com.gs.collections.api.block.function.Function0<? extends T> function) Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
com.gs.collections.api.list.MutableList<T>	distinct() Returns a new ListIterable containing the distinct elements in this list.
com.gs.collections.api.list.MutableList<T>	distinct(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy) Returns a new ListIterable containing the distinct elements in this list.
com.gs.collections.api.list.MutableList<T>	drop(int count) Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
void	each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure) The procedure is executed for each element in the iterable.
boolean	equals(java.lang.Object that) Follows the same general contract as List.equals(Object).
<V> com.gs.collections.api.list.MutableList<V>	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function) flatCollect is a special case of RichIterable.collect(Function).
<V,R extends java.util.Collection<V>> R	flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target) Same as flatCollect, only the results are collected into the target collection.
void	forEach(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.Procedure<? super T> procedure) Iterates over the section of the iterable covered by the specified inclusive indexes.
<P> void	forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter) The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
T	get(int index) Returns the item at the specified position in this list iterable.
T	getFirst() Returns the first element of an iterable.
T	getLast() Returns the last element of an iterable.
int	hashCode() Follows the same general contract as List.hashCode().
int	indexOf(java.lang.Object item) Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
<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.
<IV,P> IV	injectIntoWith(IV injectValue, com.gs.collections.api.block.function.Function3<? super IV,? super T,? super P,? extends IV> function, P parameter)
boolean	isEmpty() Returns true if this iterable has zero items.
java.util.Iterator<T>	iterator()
int	lastIndexOf(java.lang.Object item) 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(int index)
boolean	noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
<P> boolean	noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to false for every element of the collection, or return false.
boolean	notEmpty() The English equivalent of !this.isEmpty()
com.gs.collections.api.list.MutableList<T>	reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
<R extends java.util.Collection<T>> R	reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target) Same as the reject method with one parameter but uses the specified target collection for the results.
<P> com.gs.collections.api.list.MutableList<T>	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
<P,R extends java.util.Collection<T>> R	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R target) Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
T	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> collection)
boolean	removeAllIterable(java.lang.Iterable<?> iterable)
boolean	removeIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Removes all elements in the collection that evaluate to true for the specified predicate.
<P> boolean	removeIfWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.
boolean	retainAll(java.util.Collection<?> collection)
boolean	retainAllIterable(java.lang.Iterable<?> iterable)
com.gs.collections.api.list.MutableList<T>	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
<R extends java.util.Collection<T>> R	select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target) Same as the select method with one parameter but uses the specified target collection for the results.
<P> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>>	selectAndRejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into two separate collections based on a predicate returned via a Pair.
<P> com.gs.collections.api.list.MutableList<T>	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
<P,R extends java.util.Collection<T>> R	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R target) Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
int	size() Returns the number of items in this iterable.
com.gs.collections.api.list.MutableList<T>	subList(int fromIndex, int toIndex)
com.gs.collections.api.list.MutableList<T>	take(int count) Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
java.lang.Object[]	toArray() Converts this iterable to an array.
<E> E[]	toArray(E[] array) Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

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

appendString, asParallel, asReversed, asSynchronized, asUnmodifiable, binarySearch, binarySearch, clone, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, defaultSort, dropWhile, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, listIterator, max, max, maxBy, min, min, minBy, newEmpty, partition, partitionWhile, partitionWith, reverseForEach, reverseThis, selectInstancesOf, shuffleThis, shuffleThis, sortThis, sortThis, sortThisBy, sortThisByBoolean, sortThisByByte, sortThisByChar, sortThisByDouble, sortThisByFloat, sortThisByInt, sortThisByLong, sortThisByShort, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, takeWhile, tap, toImmutable, toList, toReversed, toSet, toSortedList, toSortedList, toStack, with, withAll, without, withoutAll, zip, zip, zipWithIndex, zipWithIndex

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

add, aggregateBy, aggregateInPlaceBy, chunk

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

appendString, asLazy, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAllArguments, containsAllIterable, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, makeString, makeString, makeString, sumByDouble, sumByFloat, sumByInt, sumByLong, toBag, toMap, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString

Methods inherited from class java.lang.Object

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

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

aggregateBy, aggregateInPlaceBy

Methods inherited from interface java.util.List

add, set

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

appendString, asLazy, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAllArguments, containsAllIterable, groupBy, groupByEach, groupByUniqueKey, injectInto, makeString, makeString, makeString, sumByDouble, sumByFloat, sumByInt, sumByLong, toBag, toMap, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString

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

forEach

Field Detail

items

protected T[] items

Constructor Detail

AbstractArrayAdapter

protected AbstractArrayAdapter()

This method must be here so subclasses can be serializable.

AbstractArrayAdapter

protected AbstractArrayAdapter(T[] newElements)

Method Detail

notEmpty

public boolean notEmpty()

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

The English equivalent of !this.isEmpty()

Specified by:

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

Overrides:

notEmpty in class AbstractRichIterable<T>

getFirst

public T getFirst()

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

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

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

Specified by:

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

Specified by:

getFirst in interface com.gs.collections.api.ordered.OrderedIterable<T>

Specified by:

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

Overrides:

getFirst in class AbstractMutableList<T>

getLast

public T getLast()

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

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

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

Specified by:

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

Specified by:

getLast in interface com.gs.collections.api.ordered.OrderedIterable<T>

Specified by:

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

Overrides:

getLast in class AbstractMutableList<T>

each

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

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

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

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

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable#forEach(java.util.function.Consumer).

Specified by:

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

Overrides:

each in class AbstractMutableList<T>

See Also:

InternalIterable.forEach(Procedure), Iterable#forEach(java.util.function.Consumer)

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.

Example using a Java 8 lambda:

 people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Example using an anonymous inner class:

 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>

Specified by:

forEachWithIndex in interface com.gs.collections.api.ordered.OrderedIterable<T>

Overrides:

forEachWithIndex in class AbstractMutableList<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.ordered.OrderedIterable

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

e.g.
 OrderedIterable 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.ordered.OrderedIterable<T>

Overrides:

forEachWithIndex in class AbstractMutableList<T>

removeIf

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

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

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

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

Specified by:

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

Overrides:

removeIf in class AbstractMutableList<T>

removeIfWith

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

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

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

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

Specified by:

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

Overrides:

removeIfWith in class AbstractMutableList<T>

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.

Example using a Java 8 lambda expression:

 Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

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

Specified by:

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

Overrides:

detect in class AbstractMutableList<T>

detectIfNone

public T detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
             com.gs.collections.api.block.function.Function0<? extends T> 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 AbstractMutableList<T>

detectIndex

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

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

Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectIndex in interface com.gs.collections.api.ordered.OrderedIterable<T>

Overrides:

detectIndex in class AbstractMutableList<T>

detectLastIndex

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

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

Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

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

Overrides:

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

Example using a Java 8 lambda expression:

 int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

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

Specified by:

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

Overrides:

count in class AbstractMutableList<T>

corresponds

public <S> boolean corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other,
                      com.gs.collections.api.block.predicate.Predicate2<? super T,? super S> predicate)

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

Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.

Specified by:

corresponds in interface com.gs.collections.api.ordered.OrderedIterable<T>

Overrides:

corresponds in class AbstractMutableList<T>

anySatisfy

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

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

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

Specified by:

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

Overrides:

anySatisfy in class AbstractMutableList<T>

allSatisfy

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

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

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

Specified by:

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

Overrides:

allSatisfy in class AbstractMutableList<T>

noneSatisfy

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

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

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

Specified by:

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

Overrides:

noneSatisfy in class AbstractMutableList<T>

injectInto

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

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

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

Specified by:

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

Overrides:

injectInto in class AbstractMutableList<T>

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

Specified by:

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

Specified by:

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

Overrides:

select in class AbstractMutableList<T>

select

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

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

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

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

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

Overrides:

select in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the select criteria

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

Returns:

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

See Also:

RichIterable.select(Predicate)

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

Specified by:

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

Specified by:

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

Overrides:

reject in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

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

reject

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

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

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

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

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

Overrides:

reject in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the reject criteria

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

Returns:

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

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

Specified by:

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

Specified by:

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

Overrides:

collect in class AbstractMutableList<T>

collect

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

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

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

Example using a Java 8 lambda expression:

 MutableList<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     }, Lists.mutable.empty());
 

Specified by:

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

Overrides:

collect in class AbstractMutableList<T>

Parameters:

function - a Function to use as the collect transformation function

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

Returns:

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

See Also:

RichIterable.collect(Function)

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

Specified by:

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

Specified by:

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

Overrides:

collectIf in class AbstractMutableList<T>

collectIf

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

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

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

Specified by:

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

Overrides:

collectIf in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

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

Returns:

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

See Also:

RichIterable.collectIf(Predicate, Function)

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 = 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.OrderedIterable<T>

Specified by:

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

Specified by:

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

Overrides:

flatCollect in class AbstractMutableList<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollect

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

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

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

Specified by:

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

Overrides:

flatCollect in class AbstractMutableList<T>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

RichIterable.flatCollect(Function)

selectAndRejectWith

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

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

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

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

Specified by:

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

Overrides:

selectAndRejectWith in class AbstractMutableList<T>

size

public int size()

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

Returns the number of items in this iterable.

Specified by:

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

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<T>

isEmpty

public boolean isEmpty()

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

Returns true if this iterable has zero items.

Specified by:

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

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.List<T>

Overrides:

isEmpty in class AbstractRichIterable<T>

contains

public boolean contains(java.lang.Object o)

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

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

Specified by:

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

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.List<T>

Overrides:

contains in class AbstractMutableList<T>

iterator

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

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.List<T>

Overrides:

iterator in class AbstractMutableList<T>

toArray

public java.lang.Object[] toArray()

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

Converts this iterable to an array.

Specified by:

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

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray()

toArray

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

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

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

Specified by:

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

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray(Object[])

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class AbstractMutableCollection<T>

containsAll

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

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

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

Specified by:

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

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.List<T>

Overrides:

containsAll in class AbstractMutableList<T>

See Also:

Collection.containsAll(Collection)

addAll

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

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class AbstractMutableCollection<T>

addAllIterable

public boolean addAllIterable(java.lang.Iterable<? extends T> iterable)

Specified by:

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

Overrides:

addAllIterable in class AbstractMutableCollection<T>

See Also:

Collection.addAll(Collection)

removeAll

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

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

Overrides:

removeAll in class AbstractMutableList<T>

removeAllIterable

public boolean removeAllIterable(java.lang.Iterable<?> iterable)

Specified by:

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

Overrides:

removeAllIterable in class AbstractMutableCollection<T>

See Also:

Collection.removeAll(Collection)

retainAll

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

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

Overrides:

retainAll in class AbstractMutableList<T>

retainAllIterable

public boolean retainAllIterable(java.lang.Iterable<?> iterable)

Specified by:

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

Overrides:

retainAllIterable in class AbstractMutableCollection<T>

See Also:

Collection.retainAll(Collection)

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

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

get

public T get(int index)

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

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

Specified by:

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

Specified by:

get in interface java.util.List<T>

add

public void add(int index,
       T element)

Specified by:

add in interface java.util.List<T>

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

indexOf

public int indexOf(java.lang.Object item)

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

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

Specified by:

indexOf in interface com.gs.collections.api.ordered.OrderedIterable<T>

Specified by:

indexOf in interface java.util.List<T>

Overrides:

indexOf in class AbstractMutableList<T>

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(java.lang.Object item)

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

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

Specified by:

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

Specified by:

lastIndexOf in interface java.util.List<T>

Overrides:

lastIndexOf in class AbstractMutableList<T>

listIterator

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

Specified by:

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

Specified by:

listIterator in interface java.util.List<T>

Overrides:

listIterator in class AbstractMutableList<T>

See Also:

List.listIterator(int)

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>

Overrides:

subList in class AbstractMutableList<T>

equals

public boolean equals(java.lang.Object that)

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

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

Specified by:

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

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.List<T>

Overrides:

equals in class AbstractMutableList<T>

abstractArrayAdapterEquals

public boolean abstractArrayAdapterEquals(AbstractArrayAdapter<?> list)

hashCode

public int hashCode()

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

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

Specified by:

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

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.List<T>

Overrides:

hashCode in class AbstractMutableList<T>

forEachWith

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

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

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

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

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

Specified by:

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

Overrides:

forEachWith in class AbstractMutableList<T>

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

Specified by:

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

Specified by:

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

Overrides:

selectWith in class AbstractMutableList<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

RichIterable.select(Predicate)

selectWith

public <P,R extends java.util.Collection<T>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                 P parameter,
                                                 R target)

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

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

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() >= age;
         }
     }, Integer.valueOf(18), Lists.mutable.empty());
 

Specified by:

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

Overrides:

selectWith in class AbstractMutableList<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

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

Returns:

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

See Also:

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

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

Specified by:

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

Specified by:

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

Overrides:

rejectWith in class AbstractMutableList<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

RichIterable.select(Predicate)

rejectWith

public <P,R extends java.util.Collection<T>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                 P parameter,
                                                 R target)

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

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

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18), Lists.mutable.empty());
 

Specified by:

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

Overrides:

rejectWith in class AbstractMutableList<T>

Parameters:

predicate - a Predicate2 to use as the reject criteria

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

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

Returns:

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

See Also:

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

collectWith

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

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

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(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.OrderedIterable<T>

Specified by:

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

Specified by:

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

Overrides:

collectWith in class AbstractMutableList<T>

Parameters:

function - A Function2 to use as the collect transformation function

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

Returns:

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

See Also:

RichIterable.collect(Function)

collectWith

public <P,A,R extends java.util.Collection<A>> R collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function,
                                                    P parameter,
                                                    R target)

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

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

Example using a Java 8 lambda expression:

 MutableSet<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1), Sets.mutable.empty());
 

Example using an anonymous inner class:

 Function2 addParameterFunction =
     new Function2()
     {
         public Integer value(final Integer each, final Integer parameter)
         {
             return each + parameter;
         }
     };
 MutableSet<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), Sets.mutable.empty());
 

Specified by:

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

Overrides:

collectWith in class AbstractMutableList<T>

Parameters:

function - a Function2 to use as the collect transformation function

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

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

Returns:

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

injectIntoWith

public <IV,P> IV injectIntoWith(IV injectValue,
                       com.gs.collections.api.block.function.Function3<? super IV,? super T,? super P,? extends IV> function,
                       P parameter)

Specified by:

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

Overrides:

injectIntoWith in class AbstractMutableList<T>

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.ordered.OrderedIterable

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

e.g.
 OrderedIterable 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.ordered.OrderedIterable<T>

Overrides:

forEach in class AbstractMutableList<T>

detectWith

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

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

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

Example using a Java 8 lambda expression:

 Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Example using an anonymous inner class:

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

Specified by:

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

Overrides:

detectWith in class AbstractMutableList<T>

detectWithIfNone

public <P> T detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                     P parameter,
                     com.gs.collections.api.block.function.Function0<? extends T> function)

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

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

Specified by:

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

Overrides:

detectWithIfNone in class AbstractMutableList<T>

countWith

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

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

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

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

Specified by:

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

Overrides:

countWith in class AbstractMutableList<T>

anySatisfyWith

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

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

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

Specified by:

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

Overrides:

anySatisfyWith in class AbstractMutableList<T>

allSatisfyWith

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

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

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

Specified by:

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

Overrides:

allSatisfyWith in class AbstractMutableList<T>

noneSatisfyWith

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

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

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

Specified by:

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

Overrides:

noneSatisfyWith in class AbstractMutableList<T>

distinct

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

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

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

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

Specified by:

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

Overrides:

distinct in class AbstractMutableList<T>

Returns:

ListIterable of distinct elements

distinct

public com.gs.collections.api.list.MutableList<T> distinct(com.gs.collections.api.block.HashingStrategy<? super T> hashingStrategy)

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

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

Specified by:

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

Specified by:

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

Overrides:

distinct in class AbstractMutableList<T>

Returns:

ListIterable of distinct elements

appendString

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

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

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

Specified by:

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

Overrides:

appendString in class AbstractMutableList<T>

take

public com.gs.collections.api.list.MutableList<T> take(int count)

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

Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

take in class AbstractMutableList<T>

Parameters:

count - the number of items to take.

drop

public com.gs.collections.api.list.MutableList<T> drop(int count)

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

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

drop in class AbstractMutableList<T>

Parameters:

count - the number of items to drop.