com.gs.collections.impl.bag.mutable

Class AbstractMutableBagIterable<T>

java.lang.Object

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

com.gs.collections.impl.bag.AbstractBag<T>

com.gs.collections.impl.bag.mutable.AbstractMutableBagIterable<T>

All Implemented Interfaces:

com.gs.collections.api.bag.Bag<T>, com.gs.collections.api.bag.MutableBagIterable<T>, com.gs.collections.api.collection.MutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, java.lang.Iterable<T>, java.util.Collection<T>

Direct Known Subclasses:

AbstractMutableBag, AbstractMutableSortedBag

public abstract class AbstractMutableBagIterable<T>
extends AbstractBag<T>
implements com.gs.collections.api.bag.MutableBagIterable<T>

Constructor Summary

Constructors

Constructor and Description
AbstractMutableBagIterable()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAll(java.util.Collection<? extends T> source)
boolean	addAllIterable(java.lang.Iterable<? extends T> iterable)
<K,V> com.gs.collections.api.map.MutableMap<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.MutableMap<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.
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.
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>>	bottomOccurrences(int n) Returns the count least frequently occurring items.
com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>>	chunk(int size) Partitions elements in fixed size chunks.
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.
<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.
T	getFirst() Returns the first element of an iterable.
protected abstract com.gs.collections.api.RichIterable<T>	getKeysView()
T	getLast() Returns the last element of an iterable.
<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.
T	max() Returns the maximum element out of this container based on the natural order.
T	max(java.util.Comparator<? super T> comparator) Returns the maximum element out of this container based on the comparator.
<V extends java.lang.Comparable<? super V>> T	maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
T	min() Returns the minimum element out of this container based on the natural order.
T	min(java.util.Comparator<? super T> comparator) Returns the minimum element out of this container based on the comparator.
<V extends java.lang.Comparable<? super V>> T	minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
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	removeAll(java.util.Collection<?> collection)
boolean	retainAll(java.util.Collection<?> collection)
boolean	retainAllIterable(java.lang.Iterable<?> iterable)
<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.
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>>	topOccurrences(int n) Returns the count most frequently occurring items.

Methods inherited from class com.gs.collections.impl.bag.AbstractBag

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, count, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, occurrencesSortingBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toListWithOccurrences, toSet, toSortedBag, toSortedBag, toSortedList, toSortedSet, toSortedSet, toStringOfItemToCount

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

appendString, appendString, appendString, asLazy, contains, containsAll, containsAllArguments, containsAllIterable, countWith, forEach, forEachWith, forEachWithIndex, groupByUniqueKey, isEmpty, makeString, makeString, makeString, notEmpty, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray, toMap, toSortedBagBy, toSortedList, toSortedListBy, toSortedMap, toSortedMap, 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.bag.MutableBagIterable

addOccurrences, groupBy, groupByEach, partition, partitionWith, reject, rejectWith, removeOccurrences, select, selectByOccurrences, selectInstancesOf, selectWith, setOccurrences, tap, toMapOfItemToCount, with, withAll, without, withoutAll, zipWithIndex

Methods inherited from interface com.gs.collections.api.bag.Bag

equals, forEachWithOccurrences, hashCode, occurrencesOf, sizeDistinct, toImmutable, toStringOfItemToCount

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

asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, injectIntoWith, newEmpty, removeAllIterable, removeIf, removeIfWith, toImmutable, zip

Methods inherited from interface java.util.Collection

add, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, size, toArray, toArray

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

appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, each, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, 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

Constructor Detail

AbstractMutableBagIterable

public AbstractMutableBagIterable()

Method Detail

getKeysView

protected abstract com.gs.collections.api.RichIterable<T> getKeysView()

addAll

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

Specified by:

addAll in interface java.util.Collection<T>

addAllIterable

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

Specified by:

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

See Also:

Collection.addAll(Collection)

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>

retainAllIterable

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

Specified by:

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

See Also:

Collection.retainAll(Collection)

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>

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.RichIterable<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.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)

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.

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

min

public T min()

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

Returns the minimum element out of this container based on the natural order.

Specified by:

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

Overrides:

min in class AbstractRichIterable<T>

min

public T min(java.util.Comparator<? super T> comparator)

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

Returns the minimum element out of this container based on the comparator.

Specified by:

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

Overrides:

min in class AbstractRichIterable<T>

minBy

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

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

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

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

Overrides:

minBy in class AbstractRichIterable<T>

max

public T max()

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

Returns the maximum element out of this container based on the natural order.

Specified by:

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

Overrides:

max in class AbstractRichIterable<T>

max

public T max(java.util.Comparator<? super T> comparator)

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

Returns the maximum element out of this container based on the comparator.

Specified by:

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

Overrides:

max in class AbstractRichIterable<T>

maxBy

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

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

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

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

Overrides:

maxBy in class AbstractRichIterable<T>

aggregateInPlaceBy

public <K,V> com.gs.collections.api.map.MutableMap<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.MutableCollection<T>

Specified by:

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

aggregateBy

public <K,V> com.gs.collections.api.map.MutableMap<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.MutableCollection<T>

Specified by:

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

topOccurrences

public com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>> topOccurrences(int n)

Description copied from interface: com.gs.collections.api.bag.Bag

Returns the count most frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Specified by:

topOccurrences in interface com.gs.collections.api.bag.Bag<T>

Specified by:

topOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>

bottomOccurrences

public com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>> bottomOccurrences(int n)

Description copied from interface: com.gs.collections.api.bag.Bag

Returns the count least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Specified by:

bottomOccurrences in interface com.gs.collections.api.bag.Bag<T>

Specified by:

bottomOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>