ImmutableHashBag (GS Collections

java.lang.Object
- com.gs.collections.impl.AbstractRichIterable<T>
- - com.gs.collections.impl.collection.immutable.AbstractImmutableCollection<T>
  - - com.gs.collections.impl.bag.immutable.AbstractImmutableBag<T>
    - - com.gs.collections.impl.bag.immutable.ImmutableHashBag<T>

All Implemented Interfaces:

Bag<T>, ImmutableBag<T>, UnsortedBag<T>, ImmutableCollection<T>, InternalIterable<T>, RichIterable<T>, Serializable, Iterable<T>, Collection<T>
```
public class ImmutableHashBag<T>
extends AbstractImmutableBag<T>
implements Serializable
```
Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ImmutableHashBag()

ImmutableHashBag(Bag<? extends T> source)

ImmutableHashBag(Iterable<? extends T> source)

Constructors
Constructor and Description
`ImmutableHashBag()`
`ImmutableHashBag(Bag<? extends T> source)`
`ImmutableHashBag(Iterable<? extends T> source)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`boolean`	`anySatisfy(Predicate<? super T> predicate)` Returns true if the predicate evaluates to true for any element of the iterable.
`void`	`appendString(Appendable appendable)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(Appendable appendable, String separator)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(Appendable appendable, String start, String separator, String end)` Prints a string representation of this collection onto the given `Appendable`.
`LazyIterable<T>`	`asLazy()` Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
`<V> ImmutableBag<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.
`<V> ImmutableBag<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.
`<P,V,R extends Collection<V>> R`	`collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection)` Same as collectWith but with a targetCollection parameter to gather the results.
`boolean`	`contains(Object object)` Returns true if the iterable has an element which responds true to element.equals(object).
`boolean`	`containsAllArguments(Object... elements)` Returns true if all elements in the specified var arg array are contained in this collection.
`boolean`	`containsAllIterable(Iterable<?> source)` Returns true if all elements in source are contained in this collection.
`int`	`count(Predicate<? super T> predicate)` Return the total number of elements that answer true to 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.
`boolean`	`equals(Object obj)` Two bags`b1` and `b2` are equal if `m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount())`.
`<V> ImmutableBag<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> ImmutableBagMultimap<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> ImmutableBagMultimap<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> ImmutableMap<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()`.
`<IV> IV`	`injectInto(IV injectedValue, Function2<? super IV,? super T,? extends IV> function)` Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`Iterator<T>`	`iterator()`
`String`	`makeString()` Returns a string representation of this collection by delegating to `RichIterable.makeString(String)` and defaulting the separator parameter to the characters `", "` (comma and space).
`String`	`makeString(String separator)` Returns a string representation of this collection by delegating to `RichIterable.makeString(String, String, String)` and defaulting the start and end parameters to `""` (the empty String).
`String`	`makeString(String start, String separator, String end)` Returns a string representation of this collection.
`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 <T> ImmutableHashBag<T>`	`newBag()`
`static <T> ImmutableHashBag<T>`	`newBag(Iterable<? extends T> source)`
`static <T> ImmutableHashBag<T>`	`newBagWith(Bag<? extends T> bag)`
`static <T> ImmutableHashBag<T>`	`newBagWith(T... elements)`
`ImmutableBag<T>`	`newWith(T element)`
`ImmutableBag<T>`	`newWithAll(Iterable<? extends T> elements)`
`ImmutableBag<T>`	`newWithout(T element)`
`ImmutableBag<T>`	`newWithoutAll(Iterable<? extends T> elements)`
`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.
`boolean`	`notEmpty()` The English equivalent of !this.isEmpty()
`int`	`occurrencesOf(Object item)` The occurrences of a distinct item in the bag.
`PartitionImmutableBag<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionImmutableBag<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`ImmutableBag<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,R extends Collection<T>> R`	`rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)` Similar to `RichIterable.reject(Predicate, Collection)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`ImmutableBag<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.
`ImmutableBag<T>`	`selectByOccurrences(IntPredicate predicate)` Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
`<S> ImmutableBag<S>`	`selectInstancesOf(Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P,R extends Collection<T>> R`	`selectWith(Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)` Similar to `RichIterable.select(Predicate, Collection)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`int`	`size()` Returns the number of items in this iterable.
`int`	`sizeDistinct()` The size of the Bag when counting only distinct elements.
`Object[]`	`toArray()` Converts this iterable to an array.
`<T> T[]`	`toArray(T[] a)` Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
`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.
`<K,V> MutableMap<K,V>`	`toMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)` Converts the collection to a MutableMap implementation using the specified key and value functions.
`MapIterable<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.
`MutableList<T>`	`toSortedList()` Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
`MutableList<T>`	`toSortedList(Comparator<? super T> comparator)` Converts the collection to a MutableList implementation and sorts it using the specified comparator.
`String`	`toString()` Returns a string representation of this collection.
`<S> ImmutableBag<Pair<T,S>>`	`zip(Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`<S,R extends Collection<Pair<T,S>>> R`	`zip(Iterable<S> that, R target)` Same as `RichIterable.zip(Iterable)` but uses `target` for output.
`ImmutableSet<Pair<T,Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.
`<R extends Collection<Pair<T,Integer>>> R`	`zipWithIndex(R target)` Same as `RichIterable.zipWithIndex()` but uses `target` for output.

Methods inherited from class com.gs.collections.impl.bag.immutable.AbstractImmutableBag
collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, collectWith, rejectWith, selectWith, toStringOfItemToCount

Methods inherited from class com.gs.collections.impl.collection.immutable.AbstractImmutableCollection
add, addAll, aggregateBy, aggregateInPlaceBy, chunk, clear, remove, removeAll, retainAll

Methods inherited from class com.gs.collections.impl.AbstractRichIterable
allSatisfyWith, anySatisfyWith, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, countWith, detectWith, detectWithIfNone, injectInto, injectInto, injectInto, injectInto, noneSatisfyWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy

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

Methods inherited from interface com.gs.collections.api.RichIterable
aggregateBy, aggregateInPlaceBy, allSatisfyWith, anySatisfyWith, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, countWith, detectWith, detectWithIfNone, injectInto, injectInto, injectInto, injectInto, noneSatisfyWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy

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

Methods inherited from interface com.gs.collections.api.collection.ImmutableCollection
aggregateBy, aggregateInPlaceBy

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

- Constructor Detail
  - ImmutableHashBag
```
public ImmutableHashBag()
```
  - ImmutableHashBag
```
public ImmutableHashBag(Iterable<? extends T> source)
```
  - ImmutableHashBag
```
public ImmutableHashBag(Bag<? extends T> source)
```
- Method Detail
  - newBag
```
public static <T> ImmutableHashBag<T> newBag()
```
  - newBag
```
public static <T> ImmutableHashBag<T> newBag(Iterable<? extends T> source)
```
  - newBagWith
```
public static <T> ImmutableHashBag<T> newBagWith(T... elements)
```
  - newBagWith
```
public static <T> ImmutableHashBag<T> newBagWith(Bag<? extends T> bag)
```
  - newWith
```
public ImmutableBag<T> newWith(T element)
```
    Specified by:
    
    newWith in interface ImmutableBag<T>
    
    Specified by:
    
    newWith in interface ImmutableCollection<T>
  - newWithout
```
public ImmutableBag<T> newWithout(T element)
```
    Specified by:
    
    newWithout in interface ImmutableBag<T>
    
    Specified by:
    
    newWithout in interface ImmutableCollection<T>
  - newWithAll
```
public ImmutableBag<T> newWithAll(Iterable<? extends T> elements)
```
    Specified by:
    
    newWithAll in interface ImmutableBag<T>
    
    Specified by:
    
    newWithAll in interface ImmutableCollection<T>
  - newWithoutAll
```
public ImmutableBag<T> newWithoutAll(Iterable<? extends T> elements)
```
    Specified by:
    
    newWithoutAll in interface ImmutableBag<T>
    
    Specified by:
    
    newWithoutAll in interface ImmutableCollection<T>
  - 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>
  - groupBy
```
public <V> ImmutableBagMultimap<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 ImmutableBag<T>
    
    Specified by:
    
    groupBy in interface UnsortedBag<T>
    
    Specified by:
    
    groupBy in interface ImmutableCollection<T>
    
    Specified by:
    
    groupBy in interface RichIterable<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> ImmutableBagMultimap<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 ImmutableBag<T>
    
    Specified by:
    
    groupByEach in interface UnsortedBag<T>
    
    Specified by:
    
    groupByEach in interface ImmutableCollection<T>
    
    Specified by:
    
    groupByEach in interface RichIterable<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>
  - groupByUniqueKey
```
public <V> ImmutableMap<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 ImmutableCollection<T>
    
    Specified by:
    
    groupByUniqueKey in interface RichIterable<T>
    
    See Also:
    
    RichIterable.groupBy(Function)
  - 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>
  - notEmpty
```
public boolean notEmpty()
```
    Description copied from interface: RichIterable
    
    The English equivalent of !this.isEmpty()
    
    Specified by:
    
    notEmpty in interface RichIterable<T>
    
    Overrides:
    
    notEmpty in class AbstractRichIterable<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>
  - 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>
  - 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>
  - contains
```
public boolean contains(Object object)
```
    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>
  - containsAllIterable
```
public boolean containsAllIterable(Iterable<?> source)
```
    Description copied from interface: RichIterable
    
    Returns true if all elements in source are contained in this collection.
    
    Specified by:
    
    containsAllIterable in interface RichIterable<T>
    
    Overrides:
    
    containsAllIterable in class AbstractRichIterable<T>
  - containsAllArguments
```
public boolean containsAllArguments(Object... elements)
```
    Description copied from interface: RichIterable
    
    Returns true if all elements in the specified var arg array are contained in this collection.
    
    Specified by:
    
    containsAllArguments in interface RichIterable<T>
    
    Overrides:
    
    containsAllArguments in class AbstractRichIterable<T>
  - toMap
```
public <K,V> MutableMap<K,V> toMap(Function<? super T,? extends K> keyFunction,
                                   Function<? super T,? extends V> valueFunction)
```
    Description copied from interface: RichIterable
    
    Converts the collection to a MutableMap implementation using the specified key and value functions.
    
    Specified by:
    
    toMap in interface RichIterable<T>
    
    Overrides:
    
    toMap in class AbstractRichIterable<T>
  - 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 <P> 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>
  - selectByOccurrences
```
public ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    selectByOccurrences in interface UnsortedBag<T>
  - select
```
public ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    select in interface UnsortedBag<T>
    
    Specified by:
    
    select in interface ImmutableCollection<T>
    
    Specified by:
    
    select in interface RichIterable<T>
  - reject
```
public ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    reject in interface UnsortedBag<T>
    
    Specified by:
    
    reject in interface ImmutableCollection<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
  - partition
```
public PartitionImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    partition in interface UnsortedBag<T>
    
    Specified by:
    
    partition in interface ImmutableCollection<T>
    
    Specified by:
    
    partition in interface RichIterable<T>
    
    Overrides:
    
    partition in class AbstractImmutableBag<T>
  - partitionWith
```
public <P> PartitionImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    partitionWith in interface ImmutableCollection<T>
    
    Specified by:
    
    partitionWith in interface RichIterable<T>
    
    Overrides:
    
    partitionWith in class AbstractImmutableBag<T>
  - selectInstancesOf
```
public <S> ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    selectInstancesOf in interface UnsortedBag<T>
    
    Specified by:
    
    selectInstancesOf in interface ImmutableCollection<T>
    
    Specified by:
    
    selectInstancesOf in interface RichIterable<T>
  - collect
```
public <V> ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    collect in interface UnsortedBag<T>
    
    Specified by:
    
    collect in interface ImmutableCollection<T>
    
    Specified by:
    
    collect in interface RichIterable<T>
  - collectIf
```
public <V> ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    collectIf in interface UnsortedBag<T>
    
    Specified by:
    
    collectIf in interface ImmutableCollection<T>
    
    Specified by:
    
    collectIf in interface RichIterable<T>
  - flatCollect
```
public <V> ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    flatCollect in interface UnsortedBag<T>
    
    Specified by:
    
    flatCollect in interface ImmutableCollection<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
  - 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>
  - 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>
  - 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>
  - toSortedList
```
public MutableList<T> toSortedList()
```
    Description copied from interface: RichIterable
    
    Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
    
    Specified by:
    
    toSortedList in interface RichIterable<T>
    
    Overrides:
    
    toSortedList in class AbstractRichIterable<T>
  - toSortedList
```
public MutableList<T> toSortedList(Comparator<? super T> comparator)
```
    Description copied from interface: RichIterable
    
    Converts the collection to a MutableList implementation and sorts it using the specified comparator.
    
    Specified by:
    
    toSortedList in interface RichIterable<T>
    
    Overrides:
    
    toSortedList in class AbstractRichIterable<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 targetCollection)
```
    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
    
    targetCollection - 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
  - rejectWith
```
public <P,R extends Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate,
                                                P parameter,
                                                R targetCollection)
```
    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
    
    targetCollection - 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,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)
  - collectWith
```
public <P,V,R extends Collection<V>> R collectWith(Function2<? super T,? super P,? extends V> function,
                                                   P parameter,
                                                   R targetCollection)
```
    Description copied from interface: RichIterable
    Same as collectWith but with a targetCollection parameter to gather the results.
```
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), UnifiedSet.newSet());
 
```
    Specified by:
    
    collectWith in interface RichIterable<T>
    
    Overrides:
    
    collectWith in class AbstractRichIterable<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
    
    targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function
    
    Returns:
    
    targetCollection, which contains appended elements as a result of the collect transformation
  - 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)
  - 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)
  - 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>
  - injectInto
```
public <IV> IV injectInto(IV injectedValue,
                          Function2<? super IV,? super T,? extends IV> function)
```
    Description copied from interface: RichIterable
    
    Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.
    
    Specified by:
    
    injectInto in interface RichIterable<T>
    
    Overrides:
    
    injectInto in class AbstractRichIterable<T>
  - equals
```
public boolean equals(Object obj)
```
    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)
  - 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()
  - toMapOfItemToCount
```
public MapIterable<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>
  - 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>
  - 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>
  - asLazy
```
public LazyIterable<T> asLazy()
```
    Description copied from interface: RichIterable
    
    Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
    
    Specified by:
    
    asLazy in interface RichIterable<T>
    
    Overrides:
    
    asLazy in class AbstractRichIterable<T>
  - toArray
```
public Object[] toArray()
```
    Description copied from interface: RichIterable
    
    Converts this iterable to an array.
    
    Specified by:
    
    toArray in interface RichIterable<T>
    
    Specified by:
    
    toArray in interface Collection<T>
    
    Overrides:
    
    toArray in class AbstractRichIterable<T>
    
    See Also:
    
    Collection.toArray()
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Description copied from interface: RichIterable
    
    Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
    
    Specified by:
    
    toArray in interface RichIterable<T>
    
    Specified by:
    
    toArray in interface Collection<T>
    
    Overrides:
    
    toArray in class AbstractRichIterable<T>
    
    See Also:
    
    Collection.toArray(Object[])
  - toString
```
public String toString()
```
    Description copied from class: AbstractRichIterable
    
    Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).
    
    This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned.
    
    Specified by:
    
    toString in interface RichIterable<T>
    
    Overrides:
    
    toString in class AbstractRichIterable<T>
    
    Returns:
    
    a string representation of this collection.
  - makeString
```
public String makeString()
```
    Description copied from interface: RichIterable
    
    Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
    
    Specified by:
    
    makeString in interface RichIterable<T>
    
    Overrides:
    
    makeString in class AbstractRichIterable<T>
    
    Returns:
    
    a string representation of this collection.
  - makeString
```
public String makeString(String separator)
```
    Description copied from interface: RichIterable
    
    Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
    
    Specified by:
    
    makeString in interface RichIterable<T>
    
    Overrides:
    
    makeString in class AbstractRichIterable<T>
    
    Returns:
    
    a string representation of this collection.
  - makeString
```
public String makeString(String start,
                         String separator,
                         String end)
```
    Description copied from interface: RichIterable
    
    Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).
    
    Specified by:
    
    makeString in interface RichIterable<T>
    
    Overrides:
    
    makeString in class AbstractRichIterable<T>
    
    Returns:
    
    a string representation of this collection.
  - appendString
```
public void appendString(Appendable appendable)
```
    Description copied from interface: RichIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().
    
    Specified by:
    
    appendString in interface RichIterable<T>
    
    Overrides:
    
    appendString in class AbstractRichIterable<T>
  - appendString
```
public void appendString(Appendable appendable,
                         String separator)
```
    Description copied from interface: RichIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).
    
    Specified by:
    
    appendString in interface RichIterable<T>
    
    Overrides:
    
    appendString in class AbstractRichIterable<T>
  - appendString
```
public void appendString(Appendable appendable,
                         String start,
                         String separator,
                         String end)
```
    Description copied from interface: RichIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).
    
    Specified by:
    
    appendString in interface RichIterable<T>
    
    Overrides:
    
    appendString in class AbstractRichIterable<T>
  - zip
```
public <S> ImmutableBag<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 ImmutableBag<T>
    
    Specified by:
    
    zip in interface UnsortedBag<T>
    
    Specified by:
    
    zip in interface ImmutableCollection<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.
  - zip
```
public <S,R extends Collection<Pair<T,S>>> R zip(Iterable<S> that,
                                                 R target)
```
    Description copied from interface: RichIterable
    
    Same as RichIterable.zip(Iterable) but uses target for output.
    
    Specified by:
    
    zip in interface RichIterable<T>
    
    Overrides:
    
    zip in class AbstractRichIterable<T>
  - zipWithIndex
```
public ImmutableSet<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 ImmutableBag<T>
    
    Specified by:
    
    zipWithIndex in interface UnsortedBag<T>
    
    Specified by:
    
    zipWithIndex in interface ImmutableCollection<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)
  - zipWithIndex
```
public <R extends Collection<Pair<T,Integer>>> R zipWithIndex(R target)
```
    Description copied from interface: RichIterable
    
    Same as RichIterable.zipWithIndex() but uses target for output.
    
    Specified by:
    
    zipWithIndex in interface RichIterable<T>
    
    Overrides:
    
    zipWithIndex in class AbstractRichIterable<T>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>

Class ImmutableHashBag<T>

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.bag.immutable.AbstractImmutableBag

Methods inherited from class com.gs.collections.impl.collection.immutable.AbstractImmutableCollection

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.ImmutableCollection

Methods inherited from interface java.util.Collection

Constructor Detail

ImmutableHashBag

ImmutableHashBag

ImmutableHashBag

Method Detail

newBag

newBag

newBagWith

newBagWith

newWith

newWithout

newWithAll

newWithoutAll

size

groupBy

groupBy

groupByEach

groupByEach

groupByUniqueKey

isEmpty

notEmpty

getFirst

getLast

min

max

min

max

minBy

maxBy

contains

containsAllIterable

containsAllArguments

toMap

forEach

forEachWithIndex

forEachWith

selectByOccurrences

select

reject

partition

partitionWith

selectInstancesOf

collect

collectIf

flatCollect

toList

sizeDistinct

occurrencesOf

forEachWithOccurrences

toSortedList

toSortedList

select

selectWith

reject

rejectWith

collect

collectWith

flatCollect

collectIf

detect

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

injectInto

equals

hashCode

toMapOfItemToCount