com.gs.collections.impl.collection.immutable

Class AbstractImmutableCollection<T>

java.lang.Object

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

com.gs.collections.impl.collection.immutable.AbstractImmutableCollection<T>

All Implemented Interfaces:

com.gs.collections.api.collection.ImmutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, java.lang.Iterable<T>, java.util.Collection<T>

Direct Known Subclasses:

AbstractImmutableSet

public abstract class AbstractImmutableCollection<T>
extends AbstractRichIterable<T>
implements com.gs.collections.api.collection.ImmutableCollection<T>, java.util.Collection<T>

Constructor Summary

Constructors

Constructor and Description
AbstractImmutableCollection()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T t)
boolean	addAll(java.util.Collection<? extends T> collection)
<K,V> com.gs.collections.api.map.ImmutableMap<K,V>	aggregateBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy, com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory, com.gs.collections.api.block.function.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> com.gs.collections.api.map.ImmutableMap<K,V>	aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy, com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V,? super T> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>>	chunk(int size) Partitions elements in fixed size chunks.
void	clear()
<V> com.gs.collections.api.map.ImmutableMap<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.
protected abstract com.gs.collections.api.collection.MutableCollection<T>	newMutable(int size)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> collection)
protected void	removeAllFrom(java.lang.Iterable<? extends T> elements, com.gs.collections.api.collection.MutableCollection<T> result)
boolean	retainAll(java.util.Collection<?> collection)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, groupBy, groupByEach, newWith, newWithAll, newWithout, newWithoutAll, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, tap, zip, zipWithIndex

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, each, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, 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

iterator

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, size, toArray, toArray

Constructor Detail

AbstractImmutableCollection

public AbstractImmutableCollection()

Method Detail

newMutable

protected abstract com.gs.collections.api.collection.MutableCollection<T> newMutable(int size)

aggregateInPlaceBy

public <K,V> com.gs.collections.api.map.ImmutableMap<K,V> aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy,
                                                                    com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory,
                                                                    com.gs.collections.api.block.procedure.Procedure2<? super V,? super T> mutatingAggregator)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

aggregateBy

public <K,V> com.gs.collections.api.map.ImmutableMap<K,V> aggregateBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy,
                                                             com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory,
                                                             com.gs.collections.api.block.function.Function2<? super V,? super T,? extends V> nonMutatingAggregator)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.collection.ImmutableCollection<T>

Specified by:

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

groupByUniqueKey

public <V> com.gs.collections.api.map.ImmutableMap<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.ImmutableCollection<T>

Specified by:

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

See Also:

RichIterable.groupBy(Function)

add

public boolean add(T t)

Specified by:

add in interface java.util.Collection<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

addAll

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

Specified by:

addAll in interface java.util.Collection<T>

removeAll

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

Specified by:

removeAll in interface java.util.Collection<T>

retainAll

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

Specified by:

retainAll in interface java.util.Collection<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

removeAllFrom

protected void removeAllFrom(java.lang.Iterable<? extends T> elements,
                 com.gs.collections.api.collection.MutableCollection<T> result)

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.