com.gs.collections.impl.collection.mutable

Class AbstractMutableCollection<T>

java.lang.Object

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

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

All Implemented Interfaces:

MutableCollection<T>, InternalIterable<T>, RichIterable<T>, Iterable<T>, Collection<T>

Direct Known Subclasses:

AbstractMutableBag, AbstractMutableList, AbstractMutableSet, TreeSortedSet

public abstract class AbstractMutableCollection<T>
extends AbstractRichIterable<T>
implements MutableCollection<T>

Constructor Summary

Constructors

Constructor and Description
AbstractMutableCollection()

Method Summary

Modifier and Type	Method and Description
boolean	add(T element)
boolean	addAll(Collection<? extends T> source)
boolean	addAllIterable(Iterable<? extends T> iterable)
<K,V> MutableMap<K,V>	aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator) Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
<K,V> MutableMap<K,V>	aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
RichIterable<RichIterable<T>>	chunk(int size) Partitions elements in fixed size chunks.
<IV,P> IV	injectIntoWith(IV injectValue, Function3<? super IV,? super T,? super P,? extends IV> function, P parameter)
boolean	remove(Object o)
boolean	removeAll(Collection<?> source)
boolean	removeAllIterable(Iterable<?> iterable)
void	removeIf(Predicate<? super T> predicate) Removes all elements in the collection that evaluate to true for the specified predicate.
<P> void	removeIfWith(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(Collection<?> source)
boolean	retainAllIterable(Iterable<?> iterable)
<P> Twin<MutableList<T>>	selectAndRejectWith(Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into two separate collections based on a predicate returned via a Pair.

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

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, forEachWith, forEachWithIndex, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, groupBy, groupByEach, groupByUniqueKey, newEmpty, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, toImmutable, with, withAll, without, withoutAll, zip, zipWithIndex

Methods inherited from interface java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeIf, size, spliterator, stream, toArray, toArray

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, getFirst, getLast, 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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbstractMutableCollection

public AbstractMutableCollection()

Method Detail

selectAndRejectWith

public <P> Twin<MutableList<T>> selectAndRejectWith(Predicate2<? super T,? super P> predicate,
                                                    P parameter)

Description copied from interface: 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 MutableCollection<T>

removeIf

public void removeIf(Predicate<? super T> predicate)

Description copied from interface: 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 MutableCollection<T>

removeIfWith

public <P> void removeIfWith(Predicate2<? super T,? super P> predicate,
                             P parameter)

Description copied from interface: 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 MutableCollection<T>

injectIntoWith

public <IV,P> IV injectIntoWith(IV injectValue,
                                Function3<? super IV,? super T,? super P,? extends IV> function,
                                P parameter)

Specified by:

injectIntoWith in interface MutableCollection<T>

addAllIterable

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

Specified by:

addAllIterable in interface MutableCollection<T>

See Also:

Collection.addAll(Collection)

removeAllIterable

public boolean removeAllIterable(Iterable<?> iterable)

Specified by:

removeAllIterable in interface MutableCollection<T>

See Also:

Collection.removeAll(Collection)

retainAllIterable

public boolean retainAllIterable(Iterable<?> iterable)

Specified by:

retainAllIterable in interface MutableCollection<T>

See Also:

Collection.retainAll(Collection)

chunk

public RichIterable<RichIterable<T>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface 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.

aggregateInPlaceBy

public <K,V> MutableMap<K,V> aggregateInPlaceBy(Function<? super T,? extends K> groupBy,
                                                Function0<? extends V> zeroValueFactory,
                                                Procedure2<? super V,? super T> mutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

aggregateInPlaceBy in interface MutableCollection<T>

Specified by:

aggregateInPlaceBy in interface RichIterable<T>

aggregateBy

public <K,V> MutableMap<K,V> aggregateBy(Function<? super T,? extends K> groupBy,
                                         Function0<? extends V> zeroValueFactory,
                                         Function2<? super V,? super T,? extends V> nonMutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).

Specified by:

aggregateBy in interface MutableCollection<T>

Specified by:

aggregateBy in interface RichIterable<T>

add

public boolean add(T element)

Specified by:

add in interface Collection<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

addAll

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

Specified by:

addAll in interface Collection<T>

removeAll

public boolean removeAll(Collection<?> source)

Specified by:

removeAll in interface Collection<T>

retainAll

public boolean retainAll(Collection<?> source)

Specified by:

retainAll in interface Collection<T>