HashBag (GS Collections

java.lang.Object
- com.gs.collections.impl.AbstractRichIterable<T>
- - com.gs.collections.impl.collection.mutable.AbstractMutableCollection<T>
 - - com.gs.collections.impl.collection.AbstractMutableBag<T>
 - - com.gs.collections.impl.bag.mutable.HashBag<T>

All Implemented Interfaces:

Bag<T>, MutableBag<T>, UnsortedBag<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>, Externalizable, Serializable, Iterable<T>, Collection<T>
```
public class HashBag<T>
extends AbstractMutableBag<T>
implements Externalizable, MutableBag<T>
```
A HashBag is a MutableBag which uses a Map as its underlying data store. Each key in the Map represents some item, and the value in the map represents the current number of occurrences of that item.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

HashBag()

HashBag(int size)

Constructors
Constructor and Description
`HashBag()`
`HashBag(int size)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T item)`
`void`	`addOccurrences(T item, int occurrences)`
`boolean`	`allSatisfy(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(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(Predicate<? super T> predicate)` Returns true if the predicate evaluates to true for any element of the iterable.
`<P> boolean`	`anySatisfyWith(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.
`ParallelUnsortedBag<T>`	`asParallel(ExecutorService executorService, int batchSize)`
`SynchronizedBag<T>`	`asSynchronized()` Returns a synchronized (thread-safe) collection backed by this collection.
`UnmodifiableBag<T>`	`asUnmodifiable()` Returns an unmodifiable view of this collection.
`void`	`clear()`
`<V> MutableBag<V>`	`collect(Function<? super T,? extends V> function)` Returns a new collection with the results of applying the specified function on each element of the source collection.
`<V,R extends Collection<V>> R`	`collect(Function<? super T,? extends V> function, R target)` Same as `RichIterable.collect(Function)`, except that the results are gathered into the specified `target` collection.
`MutableBooleanBag`	`collectBoolean(BooleanFunction<? super T> booleanFunction)` Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`MutableByteBag`	`collectByte(ByteFunction<? super T> byteFunction)` Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`MutableCharBag`	`collectChar(CharFunction<? super T> charFunction)` Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`MutableDoubleBag`	`collectDouble(DoubleFunction<? super T> doubleFunction)` Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`MutableFloatBag`	`collectFloat(FloatFunction<? super T> floatFunction)` Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`<V> MutableBag<V>`	`collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)` Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
`<V,R extends Collection<V>> R`	`collectIf(Predicate<? super T> predicate, 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.
`MutableIntBag`	`collectInt(IntFunction<? super T> intFunction)` Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`MutableLongBag`	`collectLong(LongFunction<? super T> longFunction)` Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection.
`MutableShortBag`	`collectShort(ShortFunction<? super T> shortFunction)` Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<P,V> MutableBag<V>`	`collectWith(Function2<? super T,? super P,? extends V> function, P parameter)` Same as collect with a `Function2` and specified parameter which is passed to the block
`boolean`	`contains(Object o)` Returns true if the iterable has an element which responds true to element.equals(object).
`int`	`count(Predicate<? super T> predicate)` Return the total number of elements that answer true to the specified predicate.
`<P> int`	`countWith(Predicate2<? super T,? super P> predicate, P parameter)` Returns the total number of elements that evaluate to true for the specified predicate.
`T`	`detect(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(Predicate<? super T> predicate, Function0<? extends T> function)` Returns the first element of the iterable for which the predicate evaluates to true.
`<P> T`	`detectWith(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(Predicate2<? super T,? super P> predicate, P parameter, 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.
`boolean`	`equals(Object other)` Two bags`b1` and `b2` are equal if `m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount())`.
`<V> MutableBag<V>`	`flatCollect(Function<? super T,? extends Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`<V,R extends Collection<V>> R`	`flatCollect(Function<? super T,? extends Iterable<V>> function, R target)` Same as flatCollect, only the results are collected into the target collection.
`void`	`forEach(Procedure<? super T> procedure)` The procedure is executed for each element in the iterable.
`<P> void`	`forEachWith(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(ObjectIntProcedure<? super T> objectIntProcedure)` Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
`void`	`forEachWithOccurrences(ObjectIntProcedure<? super T> objectIntProcedure)` For each distinct item, with the number of occurrences, execute the specified procedure.
`T`	`getFirst()` Returns the first element of an iterable.
`T`	`getLast()` Returns the last element of an iterable.
`<V> HashBagMultimap<V,T>`	`groupBy(Function<? super T,? extends V> function)` For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
`<V,R extends MutableMultimap<V,T>> R`	`groupBy(Function<? super T,? extends V> function, R target)` Same as `RichIterable.groupBy(Function)`, except that the results are gathered into the specified `target` multimap.
`<V> HashBagMultimap<V,T>`	`groupByEach(Function<? super T,? extends Iterable<V>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`<V,R extends MutableMultimap<V,T>> R`	`groupByEach(Function<? super T,? extends Iterable<V>> function, R target)` Same as `RichIterable.groupByEach(Function)`, except that the results are gathered into the specified `target` multimap.
`<V> MutableMap<V,T>`	`groupByUniqueKey(Function<? super T,? extends V> function)` For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
`int`	`hashCode()` Returns the hash code for this Bag, defined as `this.Bag.toMapOfItemToCount().hashCode()`.
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`Iterator<T>`	`iterator()`
`T`	`max()` Returns the maximum element out of this container based on the natural order.
`T`	`max(Comparator<? super T> comparator)` Returns the maximum element out of this container based on the comparator.
`<V extends Comparable<? super V>> T`	`maxBy(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(Comparator<? super T> comparator)` Returns the minimum element out of this container based on the comparator.
`<V extends Comparable<? super V>> T`	`minBy(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.
`static <E> HashBag<E>`	`newBag()`
`static <E> HashBag<E>`	`newBag(Bag<? extends E> source)`
`static <E> HashBag<E>`	`newBag(int size)`
`static <E> HashBag<E>`	`newBag(Iterable<? extends E> source)`
`static <E> HashBag<E>`	`newBagWith(E... elements)`
`MutableBag<T>`	`newEmpty()` Creates a new empty mutable version of the same collection type.
`boolean`	`noneSatisfy(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(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.
`int`	`occurrencesOf(Object item)` The occurrences of a distinct item in the bag.
`PartitionMutableBag<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionMutableBag<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`void`	`readExternal(ObjectInput in)`
`MutableBag<T>`	`reject(Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<R extends Collection<T>> R`	`reject(Predicate<? super T> predicate, R target)` Same as the reject method with one parameter but uses the specified target collection for the results.
`<P> MutableBag<T>`	`rejectWith(Predicate2<? super T,? super P> predicate, P parameter)` Similar to `RichIterable.reject(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`<P,R extends Collection<T>> R`	`rejectWith(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`.
`boolean`	`remove(Object item)`
`boolean`	`removeAll(Collection<?> collection)`
`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`	`removeOccurrences(Object item, int occurrences)`
`boolean`	`retainAll(Collection<?> collection)`
`boolean`	`retainAllIterable(Iterable<?> iterable)`
`MutableBag<T>`	`select(Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<R extends Collection<T>> R`	`select(Predicate<? super T> predicate, R target)` Same as the select method with one parameter but uses the specified target collection for the results.
`MutableBag<T>`	`selectByOccurrences(IntPredicate predicate)` Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
`<S> MutableBag<S>`	`selectInstancesOf(Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> MutableBag<T>`	`selectWith(Predicate2<? super T,? super P> predicate, P parameter)` Similar to `RichIterable.select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`<P,R extends Collection<T>> R`	`selectWith(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`.
`boolean`	`setOccurrences(T item, int occurrences)`
`int`	`size()` Returns the number of items in this iterable.
`int`	`sizeDistinct()` The size of the Bag when counting only distinct elements.
`double`	`sumOfDouble(DoubleFunction<? super T> function)` Returns the final double result of evaluating function for each element of the iterable and adding the results together.
`double`	`sumOfFloat(FloatFunction<? super T> function)` Returns the final double result of evaluating function for each element of the iterable and adding the results together.
`long`	`sumOfInt(IntFunction<? super T> function)` Returns the final long result of evaluating function for each element of the iterable and adding the results together.
`long`	`sumOfLong(LongFunction<? super T> function)` Returns the final long result of evaluating function for each element of the iterable and adding the results together.
`MutableBag<T>`	`toBag()` Converts the collection to the default MutableBag implementation.
`ImmutableBag<T>`	`toImmutable()` Converts the UnsortedBag to an ImmutableBag.
`MutableList<T>`	`toList()` Converts the collection to a MutableList implementation.
`MutableMap<T,Integer>`	`toMapOfItemToCount()` Converts the Bag to a Map of the Item type to its count as an Integer.
`MutableSet<T>`	`toSet()` Converts the collection to a MutableSet implementation.
`String`	`toStringOfItemToCount()` Returns a string representation of this bag.
`HashBag<T>`	`with(T... elements)`
`HashBag<T>`	`with(T element)` This method allows mutable and fixed size collections the ability to add elements to their existing elements.
`HashBag<T>`	`with(T element1, T element2)`
`HashBag<T>`	`with(T element1, T element2, T element3)`
`HashBag<T>`	`withAll(Iterable<? extends T> iterable)` This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
`HashBag<T>`	`without(T element)` This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
`HashBag<T>`	`withoutAll(Iterable<? extends T> iterable)` This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
`void`	`writeExternal(ObjectOutput out)`
`<S> MutableBag<Pair<T,S>>`	`zip(Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`MutableSet<Pair<T,Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from class com.gs.collections.impl.collection.AbstractMutableBag
collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractMutableCollection
addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, chunk, injectIntoWith, selectAndRejectWith

Methods inherited from class com.gs.collections.impl.AbstractRichIterable
appendString, appendString, appendString, asLazy, collectWith, containsAll, containsAllArguments, containsAllIterable, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, notEmpty, toArray, toArray, toMap, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.api.RichIterable
aggregateBy, aggregateInPlaceBy, appendString, appendString, appendString, asLazy, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, notEmpty, toArray, toArray, toMap, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.gs.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, injectIntoWith, selectAndRejectWith

Methods inherited from interface java.util.Collection
addAll, containsAll, parallelStream, removeIf, spliterator, stream, toArray, toArray

- Constructor Detail
 - HashBag
```
public HashBag()
```
 - HashBag
```
public HashBag(int size)
```
- Method Detail
 - newBag
```
public static <E> HashBag<E> newBag()
```
 - newBag
```
public static <E> HashBag<E> newBag(int size)
```
 - newBag
```
public static <E> HashBag<E> newBag(Bag<? extends E> source)
```
 - newBag
```
public static <E> HashBag<E> newBag(Iterable<? extends E> source)
```
 - newBagWith
```
public static <E> HashBag<E> newBagWith(E... elements)
```
 - addOccurrences
```
public void addOccurrences(T item,
 int occurrences)
```
 Specified by:
 
 addOccurrences in interface MutableBag<T>
 - equals
```
public boolean equals(Object other)
```
 Description copied from interface: Bag
 
 Two bagsb1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
 
 Specified by:
 
 equals in interface Bag<T>
 
 Specified by:
 
 equals in interface Collection<T>
 
 Overrides:
 
 equals in class Object
 
 See Also:
 
 Map.equals(Object)
 - sizeDistinct
```
public int sizeDistinct()
```
 Description copied from interface: Bag
 
 The size of the Bag when counting only distinct elements.
 
 Specified by:
 
 sizeDistinct in interface Bag<T>
 - hashCode
```
public int hashCode()
```
 Description copied from interface: Bag
 
 Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().
 
 Specified by:
 
 hashCode in interface Bag<T>
 
 Specified by:
 
 hashCode in interface Collection<T>
 
 Overrides:
 
 hashCode in class Object
 
 See Also:
 
 Map.hashCode()
 - occurrencesOf
```
public int occurrencesOf(Object item)
```
 Description copied from interface: Bag
 
 The occurrences of a distinct item in the bag.
 
 Specified by:
 
 occurrencesOf in interface Bag<T>
 - forEachWithOccurrences
```
public void forEachWithOccurrences(ObjectIntProcedure<? super T> objectIntProcedure)
```
 Description copied from interface: Bag
 
 For each distinct item, with the number of occurrences, execute the specified procedure.
 
 Specified by:
 
 forEachWithOccurrences in interface Bag<T>
 
 Specified by:
 
 forEachWithOccurrences in class AbstractMutableBag<T>
 - selectByOccurrences
```
public MutableBag<T> selectByOccurrences(IntPredicate predicate)
```
 Description copied from interface: Bag
 
 Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
 
 Specified by:
 
 selectByOccurrences in interface Bag<T>
 
 Specified by:
 
 selectByOccurrences in interface MutableBag<T>
 
 Specified by:
 
 selectByOccurrences in interface UnsortedBag<T>
 - toMapOfItemToCount
```
public MutableMap<T,Integer> toMapOfItemToCount()
```
 Description copied from interface: Bag
 
 Converts the Bag to a Map of the Item type to its count as an Integer.
 
 Specified by:
 
 toMapOfItemToCount in interface Bag<T>
 - toStringOfItemToCount
```
public String toStringOfItemToCount()
```
 Description copied from interface: Bag
 
 Returns a string representation of this bag. The string representation consists of a list of element-count mappings. The elements each appear once, in an order consistent with other methods like Bag.forEachWithOccurrences(ObjectIntProcedure) and Iterable.iterator(). The element-count mappings are enclosed in braces ("{}"). Adjacent mappings are separated by the characters ", " (comma and space). Each element-count mapping is rendered as the element followed by an equals sign ("=") followed by the number of ooccurrences. Elements and are converted to strings as by String.valueOf(Object).
 The string representation is similar to AbstractMap.toString(), not RichIterable.toString().
 
 Specified by:
 
 toStringOfItemToCount in interface Bag<T>
 
 Returns:
 
 a string representation of this bag
 - remove
```
public boolean remove(Object item)
```
 Specified by:
 
 remove in interface Collection<T>
 
 Overrides:
 
 remove in class AbstractMutableCollection<T>
 - removeAll
```
public boolean removeAll(Collection<?> collection)
```
 Specified by:
 
 removeAll in interface Collection<T>
 
 Overrides:
 
 removeAll in class AbstractMutableCollection<T>
 - retainAll
```
public boolean retainAll(Collection<?> collection)
```
 Specified by:
 
 retainAll in interface Collection<T>
 
 Overrides:
 
 retainAll in class AbstractMutableCollection<T>
 - clear
```
public void clear()
```
 Specified by:
 
 clear in interface Collection<T>
 - isEmpty
```
public boolean isEmpty()
```
 Description copied from interface: RichIterable
 
 Returns true if this iterable has zero items.
 
 Specified by:
 
 isEmpty in interface RichIterable<T>
 
 Specified by:
 
 isEmpty in interface Collection<T>
 
 Overrides:
 
 isEmpty in class AbstractRichIterable<T>
 - writeExternal
```
public void writeExternal(ObjectOutput out)
 throws IOException
```
 Specified by:
 
 writeExternal in interface Externalizable
 
 Throws:
 
 IOException
 - readExternal
```
public void readExternal(ObjectInput in)
 throws IOException,
 ClassNotFoundException
```
 Specified by:
 
 readExternal in interface Externalizable
 
 Throws:
 
 IOException
 
 ClassNotFoundException
 - forEach
```
public void forEach(Procedure<? super T> procedure)
```
 Description copied from interface: InternalIterable
 The procedure is executed for each element in the iterable.
```
e.g.
 people.forEach(new Procedure()
 {
 public void value(Person person)
 {
 LOGGER.info(person.getName());
 }
 });
 
```
 Specified by:
 
 forEach in interface InternalIterable<T>
 - forEachWithIndex
```
public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
```
 Description copied from interface: InternalIterable
 Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
```
e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
 public void value(Person person, int index)
 {
 LOGGER.info("Index: " + index + " person: " + person.getName());
 }
 });
 
```
 Specified by:
 
 forEachWithIndex in interface InternalIterable<T>
 
 Overrides:
 
 forEachWithIndex in class AbstractRichIterable<T>
 - forEachWith
```
public  void forEachWith(Procedure2<? super T,? super P> procedure,
 P parameter)
```
 Description copied from interface: InternalIterable
 The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
```
e.g.
 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 InternalIterable<T>
 
 Overrides:
 
 forEachWith in class AbstractRichIterable<T>
 - iterator
```
public Iterator<T> iterator()
```
 Specified by:
 
 iterator in interface Iterable<T>
 
 Specified by:
 
 iterator in interface Collection<T>
 - removeOccurrences
```
public boolean removeOccurrences(Object item,
 int occurrences)
```
 Specified by:
 
 removeOccurrences in interface MutableBag<T>
 - setOccurrences
```
public boolean setOccurrences(T item,
 int occurrences)
```
 Specified by:
 
 setOccurrences in interface MutableBag<T>
 - without
```
public HashBag<T> without(T element)
```
 Description copied from interface: MutableCollection
 This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 list = list.without("1");
 list = list.without("2");
 return list;
 
```
 In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.
 Specified by:
 
 without in interface MutableBag<T>
 
 Specified by:
 
 without in interface MutableCollection<T>
 
 See Also:
 
 Collection.remove(Object)
 - newEmpty
```
public MutableBag<T> newEmpty()
```
 Description copied from interface: MutableCollection
 
 Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.
 
 Specified by:
 
 newEmpty in interface MutableBag<T>
 
 Specified by:
 
 newEmpty in interface MutableCollection<T>
 - collectWith
```
public <P,V> MutableBag<V> collectWith(Function2<? super T,? super P,? extends V> function,
 P parameter)
```
 Description copied from interface: RichIterable
 Same as collect with a Function2 and specified parameter which is passed to the block
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
 public Integer value(final Integer each, final Integer parameter)
 {
 return each + parameter;
 }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
 Specified by:
 
 collectWith in interface MutableBag<T>
 
 Specified by:
 
 collectWith in interface UnsortedBag<T>
 
 Specified by:
 
 collectWith in interface MutableCollection<T>
 
 Specified by:
 
 collectWith in interface RichIterable<T>
 
 Parameters:
 
 function - A Function2 to use as the collect transformation function
 
 parameter - A parameter to pass in for evaluation of the second argument P in function
 
 Returns:
 
 A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
 
 See Also:
 
 RichIterable.collect(Function)
 - with
```
public HashBag<T> with(T element)
```
 Description copied from interface: MutableCollection
 This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 list = list.with("1");
 list = list.with("2");
 return list;
 
```
 In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.
 Specified by:
 
 with in interface MutableBag<T>
 
 Specified by:
 
 with in interface MutableCollection<T>
 
 See Also:
 
 Collection.add(Object)
 - asSynchronized
```
public SynchronizedBag<T> asSynchronized()
```
 Description copied from interface: MutableCollection
 Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.
 It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.
```
 MutableCollection collection = myCollection.asSynchronized();
 ...
 synchronized(collection)
 {
 Iterator i = c.iterator(); // Must be in the synchronized block
 while (i.hasNext())
 foo(i.next());
 }
 
```
 Failure to follow this advice may result in non-deterministic behavior.
 The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.
```
 MutableCollection collection = myCollection.asSynchronized();
 ...
 collection.forEach(new Procedure()
 {
 public void value(Object each)
 {
 ...
 }
 });
 
```
 The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
 The returned collection will be serializable if this collection is serializable.
 Specified by:
 
 asSynchronized in interface MutableBag<T>
 
 Specified by:
 
 asSynchronized in interface MutableCollection<T>
 
 Returns:
 
 a synchronized view of this collection.
 - withAll
```
public HashBag<T> withAll(Iterable<? extends T> iterable)
```
 Description copied from interface: MutableCollection
 This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 
```
 In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.
 Specified by:
 
 withAll in interface MutableBag<T>
 
 Specified by:
 
 withAll in interface MutableCollection<T>
 
 See Also:
 
 Collection.addAll(Collection)
 - withoutAll
```
public HashBag<T> withoutAll(Iterable<? extends T> iterable)
```
 Description copied from interface: MutableCollection
 This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 
```
 In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.
 Specified by:
 
 withoutAll in interface MutableBag<T>
 
 Specified by:
 
 withoutAll in interface MutableCollection<T>
 
 See Also:
 
 Collection.removeAll(Collection)
 - selectWith
```
public  MutableBag<T> selectWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 
 Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 selectWith in interface Bag<T>
 
 Specified by:
 
 selectWith in interface MutableBag<T>
 
 Specified by:
 
 selectWith in interface UnsortedBag<T>
 
 Specified by:
 
 selectWith in interface MutableCollection<T>
 
 Specified by:
 
 selectWith in interface RichIterable<T>
 
 Parameters:
 
 predicate - a Predicate2 to use as the select criteria
 
 parameter - a parameter to pass in for evaluation of the second argument P in predicate
 
 See Also:
 
 RichIterable.select(Predicate)
 - rejectWith
```
public  MutableBag<T> rejectWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 
 Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 rejectWith in interface Bag<T>
 
 Specified by:
 
 rejectWith in interface MutableBag<T>
 
 Specified by:
 
 rejectWith in interface UnsortedBag<T>
 
 Specified by:
 
 rejectWith in interface MutableCollection<T>
 
 Specified by:
 
 rejectWith in interface RichIterable<T>
 
 Parameters:
 
 predicate - a Predicate2 to use as the select criteria
 
 parameter - a parameter to pass in for evaluation of the second argument P in predicate
 
 See Also:
 
 RichIterable.select(Predicate)
 - 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>
 
 Overrides:
 
 removeIf in class AbstractMutableCollection<T>
 - removeIfWith
```
public  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>
 
 Overrides:
 
 removeIfWith in class AbstractMutableCollection<T>
 - detectWith
```
public  T detectWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
```
e.g.
 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 RichIterable<T>
 
 Overrides:
 
 detectWith in class AbstractRichIterable<T>
 - detectWithIfNone
```
public  T detectWithIfNone(Predicate2<? super T,? super P> predicate,
 P parameter,
 Function0<? extends T> function)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 detectWithIfNone in class AbstractRichIterable<T>
 - countWith
```
public  int countWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 countWith in class AbstractRichIterable<T>
 - anySatisfyWith
```
public  boolean anySatisfyWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 anySatisfyWith in class AbstractRichIterable<T>
 - allSatisfyWith
```
public  boolean allSatisfyWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 
 Returns true if the predicate evaluates to true for every element of the collection, or returns false.
 
 Specified by:
 
 allSatisfyWith in interface RichIterable<T>
 
 Overrides:
 
 allSatisfyWith in class AbstractRichIterable<T>
 - noneSatisfyWith
```
public  boolean noneSatisfyWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 noneSatisfyWith in class AbstractRichIterable<T>
 - asUnmodifiable
```
public UnmodifiableBag<T> asUnmodifiable()
```
 Description copied from interface: MutableCollection
 
 Returns an unmodifiable view of this collection. This method allows modules to provide users with "read-only" access to internal collections. Query operations on the returned collection "read through" to this collection, and attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.
 The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
 
 The returned collection will be serializable if this collection is serializable.
 
 Specified by:
 
 asUnmodifiable in interface MutableBag<T>
 
 Specified by:
 
 asUnmodifiable in interface MutableCollection<T>
 
 Returns:
 
 an unmodifiable view of this collection.
 - toImmutable
```
public ImmutableBag<T> toImmutable()
```
 Description copied from interface: UnsortedBag
 
 Converts the UnsortedBag to an ImmutableBag. If the bag is immutable, it returns itself.
 
 Specified by:
 
 toImmutable in interface UnsortedBag<T>
 
 Specified by:
 
 toImmutable in interface MutableCollection<T>
 - removeAllIterable
```
public boolean removeAllIterable(Iterable<?> iterable)
```
 Specified by:
 
 removeAllIterable in interface MutableCollection<T>
 
 Overrides:
 
 removeAllIterable in class AbstractMutableCollection<T>
 
 See Also:
 
 Collection.removeAll(Collection)
 - retainAllIterable
```
public boolean retainAllIterable(Iterable<?> iterable)
```
 Specified by:
 
 retainAllIterable in interface MutableCollection<T>
 
 Overrides:
 
 retainAllIterable in class AbstractMutableCollection<T>
 
 See Also:
 
 Collection.retainAll(Collection)
 - size
```
public int size()
```
 Description copied from interface: RichIterable
 
 Returns the number of items in this iterable.
 
 Specified by:
 
 size in interface RichIterable<T>
 
 Specified by:
 
 size in interface Collection<T>
 - contains
```
public boolean contains(Object o)
```
 Description copied from interface: RichIterable
 
 Returns true if the iterable has an element which responds true to element.equals(object).
 
 Specified by:
 
 contains in interface RichIterable<T>
 
 Specified by:
 
 contains in interface Collection<T>
 
 Overrides:
 
 contains in class AbstractRichIterable<T>
 - select
```
public MutableBag<T> select(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getCity().equals("Metuchen");
 }
 });
 
```
 Specified by:
 
 select in interface Bag<T>
 
 Specified by:
 
 select in interface MutableBag<T>
 
 Specified by:
 
 select in interface UnsortedBag<T>
 
 Specified by:
 
 select in interface MutableCollection<T>
 
 Specified by:
 
 select in interface RichIterable<T>
 - partition
```
public PartitionMutableBag<T> partition(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
```
e.g.
 return people.partition(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 partition in interface Bag<T>
 
 Specified by:
 
 partition in interface MutableBag<T>
 
 Specified by:
 
 partition in interface UnsortedBag<T>
 
 Specified by:
 
 partition in interface MutableCollection<T>
 
 Specified by:
 
 partition in interface RichIterable<T>
 - partitionWith
```
public  PartitionMutableBag<T> partitionWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 Filters a collection into a PartitionIterable based on the evaluation of the predicate.
```
e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
 public boolean accept(Person person, String state)
 {
 return person.getAddress().getState().getName().equals(state);
 }
 }, "New York");
 
```
 Specified by:
 
 partitionWith in interface Bag<T>
 
 Specified by:
 
 partitionWith in interface MutableBag<T>
 
 Specified by:
 
 partitionWith in interface MutableCollection<T>
 
 Specified by:
 
 partitionWith in interface RichIterable<T>
 - selectInstancesOf
```
public <S> MutableBag<S> selectInstancesOf(Class<S> clazz)
```
 Description copied from interface: RichIterable
 
 Returns all elements of the source collection that are instances of the Class clazz.
 
 Specified by:
 
 selectInstancesOf in interface Bag<T>
 
 Specified by:
 
 selectInstancesOf in interface MutableBag<T>
 
 Specified by:
 
 selectInstancesOf in interface UnsortedBag<T>
 
 Specified by:
 
 selectInstancesOf in interface MutableCollection<T>
 
 Specified by:
 
 selectInstancesOf in interface RichIterable<T>
 - collectBoolean
```
public MutableBooleanBag collectBoolean(BooleanFunction<? super T> booleanFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
 public boolean booleanValueOf(Person person)
 {
 return person.hasDrivingLicense();
 }
 });
 
```
 Specified by:
 
 collectBoolean in interface MutableBag<T>
 
 Specified by:
 
 collectBoolean in interface UnsortedBag<T>
 
 Specified by:
 
 collectBoolean in interface MutableCollection<T>
 
 Specified by:
 
 collectBoolean in interface RichIterable<T>
 - collectByte
```
public MutableByteBag collectByte(ByteFunction<? super T> byteFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
 public byte byteValueOf(Person person)
 {
 return person.getCode();
 }
 });
 
```
 Specified by:
 
 collectByte in interface MutableBag<T>
 
 Specified by:
 
 collectByte in interface UnsortedBag<T>
 
 Specified by:
 
 collectByte in interface MutableCollection<T>
 
 Specified by:
 
 collectByte in interface RichIterable<T>
 - collectChar
```
public MutableCharBag collectChar(CharFunction<? super T> charFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
 public char charValueOf(Person person)
 {
 return person.getMiddleInitial();
 }
 });
 
```
 Specified by:
 
 collectChar in interface MutableBag<T>
 
 Specified by:
 
 collectChar in interface UnsortedBag<T>
 
 Specified by:
 
 collectChar in interface MutableCollection<T>
 
 Specified by:
 
 collectChar in interface RichIterable<T>
 - collectDouble
```
public MutableDoubleBag collectDouble(DoubleFunction<? super T> doubleFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
 public double doubleValueOf(Person person)
 {
 return person.getMilesFromNorthPole();
 }
 });
 
```
 Specified by:
 
 collectDouble in interface MutableBag<T>
 
 Specified by:
 
 collectDouble in interface UnsortedBag<T>
 
 Specified by:
 
 collectDouble in interface MutableCollection<T>
 
 Specified by:
 
 collectDouble in interface RichIterable<T>
 - getFirst
```
public T getFirst()
```
 Description copied from interface: 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 RichIterable<T>
 - groupBy
```
public <V> HashBagMultimap<V,T> groupBy(Function<? super T,? extends V> function)
```
 Description copied from interface: RichIterable
 For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 groupBy in interface Bag<T>
 
 Specified by:
 
 groupBy in interface MutableBag<T>
 
 Specified by:
 
 groupBy in interface UnsortedBag<T>
 
 Specified by:
 
 groupBy in interface MutableCollection<T>
 
 Specified by:
 
 groupBy in interface RichIterable<T>
 - groupByUniqueKey
```
public <V> MutableMap<V,T> groupByUniqueKey(Function<? super T,? extends V> function)
```
 Description copied from interface: 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 MutableCollection<T>
 
 Specified by:
 
 groupByUniqueKey in interface RichIterable<T>
 
 See Also:
 
 RichIterable.groupBy(Function)
 - zipWithIndex
```
public MutableSet<Pair<T,Integer>> zipWithIndex()
```
 Description copied from interface: RichIterable
 
 Zips this RichIterable with its indices.
 
 Specified by:
 
 zipWithIndex in interface Bag<T>
 
 Specified by:
 
 zipWithIndex in interface MutableBag<T>
 
 Specified by:
 
 zipWithIndex in interface UnsortedBag<T>
 
 Specified by:
 
 zipWithIndex in interface MutableCollection<T>
 
 Specified by:
 
 zipWithIndex in interface RichIterable<T>
 
 Returns:
 
 A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
 
 See Also:
 
 RichIterable.zip(Iterable)
 - getLast
```
public T getLast()
```
 Description copied from interface: 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 RichIterable<T>
 - select
```
public <R extends Collection<T>> R select(Predicate<? super T> predicate,
 R target)
```
 Description copied from interface: RichIterable
 Same as the select method with one parameter but uses the specified target collection for the results.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 }, Lists.mutable.of());
 
```
```
e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 
```
 Specified by:
 
 select in interface RichIterable<T>
 
 Overrides:
 
 select in class AbstractRichIterable<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)
 - selectWith
```
public <P,R extends Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate,
 P parameter,
 R target)
```
 Description copied from interface: RichIterable
 
 Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 selectWith in interface RichIterable<T>
 
 Overrides:
 
 selectWith in class AbstractRichIterable<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)
 - reject
```
public <R extends Collection<T>> R reject(Predicate<? super T> predicate,
 R target)
```
 Description copied from interface: RichIterable
 Same as the reject method with one parameter but uses the specified target collection for the results.
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 }, Lists.mutable.of());
 
```
 Specified by:
 
 reject in interface RichIterable<T>
 
 Overrides:
 
 reject in class AbstractRichIterable<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
 - reject
```
public MutableBag<T> reject(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 
```
 Specified by:
 
 reject in interface Bag<T>
 
 Specified by:
 
 reject in interface MutableBag<T>
 
 Specified by:
 
 reject in interface UnsortedBag<T>
 
 Specified by:
 
 reject in interface MutableCollection<T>
 
 Specified by:
 
 reject in interface RichIterable<T>
 
 Parameters:
 
 predicate - a Predicate to use as the reject criteria
 
 Returns:
 
 a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false
 - rejectWith
```
public <P,R extends Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate,
 P parameter,
 R target)
```
 Description copied from interface: 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 a height greater than 100cm
```
 return people.reject(new Predicate2<Person, Integer>()
 {
 public boolean accept(Person p, Integer i)
 {
 return p.getHeightInCm() < i.intValue();
 }
 }, Integer.valueOf(100), FastList.newList());
 
```
 Specified by:
 
 rejectWith in interface RichIterable<T>
 
 Overrides:
 
 rejectWith in class AbstractRichIterable<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)
 - collect
```
public <V> MutableBag<V> collect(Function<? super T,? extends V> function)
```
 Description copied from interface: RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
 public String valueOf(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 collect in interface MutableBag<T>
 
 Specified by:
 
 collect in interface UnsortedBag<T>
 
 Specified by:
 
 collect in interface MutableCollection<T>
 
 Specified by:
 
 collect in interface RichIterable<T>
 - collectFloat
```
public MutableFloatBag collectFloat(FloatFunction<? super T> floatFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
 public float floatValueOf(Person person)
 {
 return person.getHeightInInches();
 }
 });
 
```
 Specified by:
 
 collectFloat in interface MutableBag<T>
 
 Specified by:
 
 collectFloat in interface UnsortedBag<T>
 
 Specified by:
 
 collectFloat in interface MutableCollection<T>
 
 Specified by:
 
 collectFloat in interface RichIterable<T>
 - collectInt
```
public MutableIntBag collectInt(IntFunction<? super T> intFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
 public int intValueOf(Person person)
 {
 return person.getAge();
 }
 });
 
```
 Specified by:
 
 collectInt in interface MutableBag<T>
 
 Specified by:
 
 collectInt in interface UnsortedBag<T>
 
 Specified by:
 
 collectInt in interface MutableCollection<T>
 
 Specified by:
 
 collectInt in interface RichIterable<T>
 - collectLong
```
public MutableLongBag collectLong(LongFunction<? super T> longFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
 public long longValueOf(Person person)
 {
 return person.getGuid();
 }
 });
 
```
 Specified by:
 
 collectLong in interface MutableBag<T>
 
 Specified by:
 
 collectLong in interface UnsortedBag<T>
 
 Specified by:
 
 collectLong in interface MutableCollection<T>
 
 Specified by:
 
 collectLong in interface RichIterable<T>
 - collectShort
```
public MutableShortBag collectShort(ShortFunction<? super T> shortFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
 public short shortValueOf(Person person)
 {
 return person.getNumberOfJunkMailItemsReceivedPerMonth();
 }
 });
 
```
 Specified by:
 
 collectShort in interface MutableBag<T>
 
 Specified by:
 
 collectShort in interface UnsortedBag<T>
 
 Specified by:
 
 collectShort in interface MutableCollection<T>
 
 Specified by:
 
 collectShort in interface RichIterable<T>
 - collectIf
```
public <V> MutableBag<V> collectIf(Predicate<? super T> predicate,
 Function<? super T,? extends V> function)
```
 Description copied from interface: RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).
```
e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 
```
 Specified by:
 
 collectIf in interface MutableBag<T>
 
 Specified by:
 
 collectIf in interface UnsortedBag<T>
 
 Specified by:
 
 collectIf in interface MutableCollection<T>
 
 Specified by:
 
 collectIf in interface RichIterable<T>
 - flatCollect
```
public <V> MutableBag<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
```
 Description copied from interface: RichIterable
 flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
 Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:
```
 Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>()
 {
 public List<Address> valueOf(Person person)
 {
 return person.getAddresses();
 }
 };
 MutableList<Person> people = ...;
 
```
 Using collect returns a collection of collections of addresses.
```
 MutableList<List<Address>> addresses = people.collect(addressFunction);
 
```
 Using flatCollect returns a single flattened list of addresses.
```
 MutableList<Address> addresses = people.flatCollect(addressFunction);
 
```
 Specified by:
 
 flatCollect in interface MutableBag<T>
 
 Specified by:
 
 flatCollect in interface UnsortedBag<T>
 
 Specified by:
 
 flatCollect in interface MutableCollection<T>
 
 Specified by:
 
 flatCollect in interface RichIterable<T>
 
 Parameters:
 
 function - The Function to apply
 
 Returns:
 
 a new flattened collection produced by applying the given function
 - collect
```
public <V,R extends Collection<V>> R collect(Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: RichIterable
 Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
 public String valueOf(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 }, Lists.mutable.of());
 
```
 Specified by:
 
 collect in interface RichIterable<T>
 
 Overrides:
 
 collect in class AbstractRichIterable<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)
 - groupByEach
```
public <V> HashBagMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)
```
 Description copied from interface: RichIterable
 
 Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
 
 Specified by:
 
 groupByEach in interface Bag<T>
 
 Specified by:
 
 groupByEach in interface MutableBag<T>
 
 Specified by:
 
 groupByEach in interface UnsortedBag<T>
 
 Specified by:
 
 groupByEach in interface MutableCollection<T>
 
 Specified by:
 
 groupByEach in interface RichIterable<T>
 - zip
```
public <S> MutableBag<Pair<T,S>> zip(Iterable<S> that)
```
 Description copied from interface: RichIterable
 
 Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
 
 Specified by:
 
 zip in interface MutableBag<T>
 
 Specified by:
 
 zip in interface UnsortedBag<T>
 
 Specified by:
 
 zip in interface MutableCollection<T>
 
 Specified by:
 
 zip in interface RichIterable<T>
 
 Type Parameters:
 
 S - the type of the second half of the returned pairs
 
 Parameters:
 
 that - The RichIterable providing the second half of each result pair
 
 Returns:
 
 A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.
 - collectIf
```
public <V,R extends Collection<V>> R collectIf(Predicate<? super T> predicate,
 Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: RichIterable
 
 Same as the collectIf method with two parameters but uses the specified target collection for the results.
 
 Specified by:
 
 collectIf in interface RichIterable<T>
 
 Overrides:
 
 collectIf in class AbstractRichIterable<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,R extends Collection<V>> R flatCollect(Function<? super T,? extends Iterable<V>> function,
 R target)
```
 Description copied from interface: RichIterable
 
 Same as flatCollect, only the results are collected into the target collection.
 
 Specified by:
 
 flatCollect in interface RichIterable<T>
 
 Overrides:
 
 flatCollect in class AbstractRichIterable<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)
 - detect
```
public T detect(Predicate<? super T> predicate)
```
 Description copied from interface: 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.
```
e.g.
 return people.detect(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 detect in interface RichIterable<T>
 
 Overrides:
 
 detect in class AbstractRichIterable<T>
 - detectIfNone
```
public T detectIfNone(Predicate<? super T> predicate,
 Function0<? extends T> function)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 detectIfNone in class AbstractRichIterable<T>
 - count
```
public int count(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Return the total number of elements that answer true to the specified predicate.
```
e.g.
 return people.count(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 count in interface RichIterable<T>
 
 Overrides:
 
 count in class AbstractRichIterable<T>
 - anySatisfy
```
public boolean anySatisfy(Predicate<? super T> predicate)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 anySatisfy in class AbstractRichIterable<T>
 - allSatisfy
```
public boolean allSatisfy(Predicate<? super T> predicate)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 allSatisfy in class AbstractRichIterable<T>
 - noneSatisfy
```
public boolean noneSatisfy(Predicate<? super T> predicate)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 noneSatisfy in class AbstractRichIterable<T>
 - toList
```
public MutableList<T> toList()
```
 Description copied from interface: RichIterable
 
 Converts the collection to a MutableList implementation.
 
 Specified by:
 
 toList in interface RichIterable<T>
 
 Overrides:
 
 toList in class AbstractRichIterable<T>
 - toSet
```
public MutableSet<T> toSet()
```
 Description copied from interface: RichIterable
 
 Converts the collection to a MutableSet implementation.
 
 Specified by:
 
 toSet in interface RichIterable<T>
 
 Overrides:
 
 toSet in class AbstractRichIterable<T>
 - toBag
```
public MutableBag<T> toBag()
```
 Description copied from interface: RichIterable
 
 Converts the collection to the default MutableBag implementation.
 
 Specified by:
 
 toBag in interface RichIterable<T>
 
 Overrides:
 
 toBag in class AbstractRichIterable<T>
 - min
```
public T min(Comparator<? super T> comparator)
```
 Description copied from interface: RichIterable
 
 Returns the minimum element out of this container based on the comparator.
 
 Specified by:
 
 min in interface RichIterable<T>
 
 Overrides:
 
 min in class AbstractRichIterable<T>
 - max
```
public T max(Comparator<? super T> comparator)
```
 Description copied from interface: RichIterable
 
 Returns the maximum element out of this container based on the comparator.
 
 Specified by:
 
 max in interface RichIterable<T>
 
 Overrides:
 
 max in class AbstractRichIterable<T>
 - min
```
public T min()
```
 Description copied from interface: RichIterable
 
 Returns the minimum element out of this container based on the natural order.
 
 Specified by:
 
 min in interface RichIterable<T>
 
 Overrides:
 
 min in class AbstractRichIterable<T>
 - max
```
public T max()
```
 Description copied from interface: RichIterable
 
 Returns the maximum element out of this container based on the natural order.
 
 Specified by:
 
 max in interface RichIterable<T>
 
 Overrides:
 
 max in class AbstractRichIterable<T>
 - minBy
```
public <V extends Comparable<? super V>> T minBy(Function<? super T,? extends V> function)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 minBy in class AbstractRichIterable<T>
 - maxBy
```
public <V extends Comparable<? super V>> T maxBy(Function<? super T,? extends V> function)
```
 Description copied from interface: 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 RichIterable<T>
 
 Overrides:
 
 maxBy in class AbstractRichIterable<T>
 - sumOfInt
```
public long sumOfInt(IntFunction<? super T> function)
```
 Description copied from interface: RichIterable
 
 Returns the final long result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfInt in interface RichIterable<T>
 
 Overrides:
 
 sumOfInt in class AbstractRichIterable<T>
 - sumOfFloat
```
public double sumOfFloat(FloatFunction<? super T> function)
```
 Description copied from interface: RichIterable
 
 Returns the final double result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfFloat in interface RichIterable<T>
 
 Overrides:
 
 sumOfFloat in class AbstractRichIterable<T>
 - sumOfLong
```
public long sumOfLong(LongFunction<? super T> function)
```
 Description copied from interface: RichIterable
 
 Returns the final long result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfLong in interface RichIterable<T>
 
 Overrides:
 
 sumOfLong in class AbstractRichIterable<T>
 - sumOfDouble
```
public double sumOfDouble(DoubleFunction<? super T> function)
```
 Description copied from interface: RichIterable
 
 Returns the final double result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfDouble in interface RichIterable<T>
 
 Overrides:
 
 sumOfDouble in class AbstractRichIterable<T>
 - groupBy
```
public <V,R extends MutableMultimap<V,T>> R groupBy(Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: RichIterable
 Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 }, new FastListMultimap<String, Person>());
 
```
 Specified by:
 
 groupBy in interface RichIterable<T>
 
 Overrides:
 
 groupBy in class AbstractRichIterable<T>
 - groupByEach
```
public <V,R extends MutableMultimap<V,T>> R groupByEach(Function<? super T,? extends Iterable<V>> function,
 R target)
```
 Description copied from interface: RichIterable
 
 Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
 
 Specified by:
 
 groupByEach in interface RichIterable<T>
 
 Overrides:
 
 groupByEach in class AbstractRichIterable<T>
 - with
```
public HashBag<T> with(T... elements)
```
 - with
```
public HashBag<T> with(T element1,
 T element2)
```
 - add
```
public boolean add(T item)
```
 Specified by:
 
 add in interface Collection<T>
 
 Overrides:
 
 add in class AbstractMutableCollection<T>
 - with
```
public HashBag<T> with(T element1,
 T element2,
 T element3)
```
 - asParallel
```
public ParallelUnsortedBag<T> asParallel(ExecutorService executorService,
 int batchSize)
```

Class HashBag<T>

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.collection.AbstractMutableBag

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

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

Methods inherited from interface java.util.Collection

Constructor Detail

HashBag

HashBag

Method Detail

newBag

newBag

newBag

newBag

newBagWith

addOccurrences

equals

sizeDistinct

hashCode

occurrencesOf

forEachWithOccurrences

selectByOccurrences

toMapOfItemToCount

toStringOfItemToCount

remove

removeAll

retainAll

clear

isEmpty

writeExternal

readExternal

forEach

forEachWithIndex

forEachWith

iterator

removeOccurrences

setOccurrences

without

newEmpty

collectWith

with

asSynchronized

withAll

withoutAll

selectWith

rejectWith

removeIf

removeIfWith

detectWith

detectWithIfNone

countWith

anySatisfyWith

allSatisfyWith

noneSatisfyWith

asUnmodifiable

toImmutable

removeAllIterable

retainAllIterable

size

contains

select

partition

partitionWith

selectInstancesOf

collectBoolean

collectByte

collectChar

collectDouble

getFirst

groupBy

groupByUniqueKey

zipWithIndex

getLast

select

selectWith