ImmutableArrayBag (Goldman Sachs Collections

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

All Implemented Interfaces:

com.gs.collections.api.bag.Bag<T>, com.gs.collections.api.bag.ImmutableBag<T>, com.gs.collections.api.collection.ImmutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>
```
public class ImmutableArrayBag<T>
extends AbstractImmutableBag<T>
implements java.io.Serializable
```
Since:

1.0

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.gs.collections.impl.bag.immutable.AbstractImmutableBag
  AbstractImmutableBag.ImmutableBagSerializationProxy<T>

Method Summary

Methods
Modifier and Type	Method and Description
`<V> com.gs.collections.api.bag.ImmutableBag<V>`	`collect(com.gs.collections.api.block.function.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> com.gs.collections.api.bag.ImmutableBag<V>`	`collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.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.
`<P,V,R extends java.util.Collection<V>> R`	`collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection)` Same as collectWith but with a targetCollection parameter to gather the results.
`static <T> ImmutableArrayBag<T>`	`copyFrom(com.gs.collections.api.bag.Bag<T> bag)`
`boolean`	`equals(java.lang.Object other)` Two bags`b1` and `b2` are equal if `m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount())`.
`<V> com.gs.collections.api.bag.ImmutableBag<V>`	`flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`void`	`forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)` The procedure is executed for each element in the iterable.
`void`	`forEachWithOccurrences(com.gs.collections.api.block.procedure.primitive.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> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T>`	`groupBy(com.gs.collections.api.block.function.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 com.gs.collections.api.multimap.MutableMultimap<V,T>> R`	`groupBy(com.gs.collections.api.block.function.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> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T>`	`groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.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 com.gs.collections.api.multimap.MutableMultimap<V,T>> R`	`groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target)` Same as `RichIterable.groupByEach(Function)`, except that the results are gathered into the specified `target` multimap.
`int`	`hashCode()` Returns the hash code for this Bag, defined as `this.Bag.toMapOfItemToCount().hashCode()`.
`java.util.Iterator<T>`	`iterator()`
`T`	`max()` Returns the maximum element out of this container based on the natural order.
`T`	`max(java.util.Comparator<? super T> comparator)` Returns the maximum element out of this container based on the comparator.
`<V extends java.lang.Comparable<? super V>> T`	`maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
`T`	`min()` Returns the minimum element out of this container based on the natural order.
`T`	`min(java.util.Comparator<? super T> comparator)` Returns the minimum element out of this container based on the comparator.
`<V extends java.lang.Comparable<? super V>> T`	`minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
`static <T> ImmutableArrayBag<T>`	`newBagWith(T... elements)`
`com.gs.collections.api.bag.ImmutableBag<T>`	`newWith(T element)`
`com.gs.collections.api.bag.ImmutableBag<T>`	`newWithAll(java.lang.Iterable<? extends T> elements)`
`com.gs.collections.api.bag.ImmutableBag<T>`	`newWithout(T element)`
`com.gs.collections.api.bag.ImmutableBag<T>`	`newWithoutAll(java.lang.Iterable<? extends T> elements)`
`int`	`occurrencesOf(java.lang.Object item)` The occurrences of a distinct item in the bag.
`com.gs.collections.api.partition.bag.PartitionImmutableBag<T>`	`partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`com.gs.collections.api.bag.ImmutableBag<T>`	`reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<P,R extends java.util.Collection<T>> R`	`rejectWith(com.gs.collections.api.block.predicate.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`.
`com.gs.collections.api.bag.ImmutableBag<T>`	`select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`com.gs.collections.api.bag.ImmutableBag<T>`	`selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)` Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
`<S> com.gs.collections.api.bag.ImmutableBag<S>`	`selectInstancesOf(java.lang.Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P,R extends java.util.Collection<T>> R`	`selectWith(com.gs.collections.api.block.predicate.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.
`com.gs.collections.api.bag.ImmutableBag<T>`	`toImmutable()` Convert the Bag to an ImmutableBag.
`com.gs.collections.api.map.MutableMap<T,java.lang.Integer>`	`toMapOfItemToCount()` Converts the Bag to a Map of the Item type to its count as an Integer.
`protected java.lang.Object`	`writeReplace()`
`<S> com.gs.collections.api.bag.ImmutableBag<com.gs.collections.api.tuple.Pair<T,S>>`	`zip(java.lang.Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`com.gs.collections.api.bag.ImmutableBag<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

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

Methods inherited from class com.gs.collections.impl.collection.immutable.AbstractImmutableCollection
add, addAll, aggregateBy, aggregateInPlaceBy, allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, clear, collect, collectIf, contains, containsAll, containsAllArguments, containsAllIterable, count, detect, detectIfNone, flatCollect, forEachWith, forEachWithIndex, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, noneSatisfy, notEmpty, reject, remove, removeAll, removeAllFrom, retainAll, select, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

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

Methods inherited from interface com.gs.collections.api.RichIterable
allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, collect, collectIf, contains, containsAll, containsAllArguments, containsAllIterable, count, detect, detectIfNone, flatCollect, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, noneSatisfy, notEmpty, reject, select, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEachWith, forEachWithIndex

- Method Detail
  - newBagWith
```
public static <T> ImmutableArrayBag<T> newBagWith(T... elements)
```
  - copyFrom
```
public static <T> ImmutableArrayBag<T> copyFrom(com.gs.collections.api.bag.Bag<T> bag)
```
  - size
```
public int size()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the number of items in this iterable.
    
    Specified by:
    
    size in interface com.gs.collections.api.RichIterable<T>
    
    Specified by:
    
    size in interface java.util.Collection<T>
  - sizeDistinct
```
public int sizeDistinct()
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    The size of the Bag when counting only distinct elements.
    
    Specified by:
    
    sizeDistinct in interface com.gs.collections.api.bag.Bag<T>
  - occurrencesOf
```
public int occurrencesOf(java.lang.Object item)
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    The occurrences of a distinct item in the bag.
    
    Specified by:
    
    occurrencesOf in interface com.gs.collections.api.bag.Bag<T>
  - forEachWithOccurrences
```
public void forEachWithOccurrences(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    For each distinct item, with the number of occurrences, execute the specified procedure.
    
    Specified by:
    
    forEachWithOccurrences in interface com.gs.collections.api.bag.Bag<T>
  - newWith
```
public com.gs.collections.api.bag.ImmutableBag<T> newWith(T element)
```
    Specified by:
    
    newWith in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    newWith in interface com.gs.collections.api.collection.ImmutableCollection<T>
  - newWithout
```
public com.gs.collections.api.bag.ImmutableBag<T> newWithout(T element)
```
    Specified by:
    
    newWithout in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    newWithout in interface com.gs.collections.api.collection.ImmutableCollection<T>
  - toMapOfItemToCount
```
public com.gs.collections.api.map.MutableMap<T,java.lang.Integer> toMapOfItemToCount()
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    Converts the Bag to a Map of the Item type to its count as an Integer.
    
    Specified by:
    
    toMapOfItemToCount in interface com.gs.collections.api.bag.Bag<T>
  - toImmutable
```
public com.gs.collections.api.bag.ImmutableBag<T> toImmutable()
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    Convert the Bag to an ImmutableBag. If the bag is immutable, it returns itself.
    
    Specified by:
    
    toImmutable in interface com.gs.collections.api.bag.Bag<T>
  - newWithAll
```
public com.gs.collections.api.bag.ImmutableBag<T> newWithAll(java.lang.Iterable<? extends T> elements)
```
    Specified by:
    
    newWithAll in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    newWithAll in interface com.gs.collections.api.collection.ImmutableCollection<T>
  - newWithoutAll
```
public com.gs.collections.api.bag.ImmutableBag<T> newWithoutAll(java.lang.Iterable<? extends T> elements)
```
    Specified by:
    
    newWithoutAll in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    newWithoutAll in interface com.gs.collections.api.collection.ImmutableCollection<T>
  - selectByOccurrences
```
public com.gs.collections.api.bag.ImmutableBag<T> selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
    
    Specified by:
    
    selectByOccurrences in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    selectByOccurrences in interface com.gs.collections.api.bag.ImmutableBag<T>
  - select
```
public com.gs.collections.api.bag.ImmutableBag<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    select in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    select in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    select in interface com.gs.collections.api.RichIterable<T>
  - selectWith
```
public <P,R extends java.util.Collection<T>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
    
    Specified by:
    
    selectWith in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    selectWith in class AbstractImmutableCollection<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 com.gs.collections.api.bag.ImmutableBag<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    reject in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    reject in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    reject in interface com.gs.collections.api.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 java.util.Collection<T>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    rejectWith in class AbstractImmutableCollection<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)
  - partition
```
public com.gs.collections.api.partition.bag.PartitionImmutableBag<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    partition in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    partition in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    partition in interface com.gs.collections.api.RichIterable<T>
  - selectInstancesOf
```
public <S> com.gs.collections.api.bag.ImmutableBag<S> selectInstancesOf(java.lang.Class<S> clazz)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns all elements of the source collection that are instances of the Class clazz.
    
    Specified by:
    
    selectInstancesOf in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    selectInstancesOf in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    selectInstancesOf in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    selectInstancesOf in interface com.gs.collections.api.RichIterable<T>
  - collect
```
public <V> com.gs.collections.api.bag.ImmutableBag<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    collect in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    collect in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    collect in interface com.gs.collections.api.RichIterable<T>
  - collectWith
```
public <P,V,R extends java.util.Collection<V>> R collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
                                                    P parameter,
                                                    R targetCollection)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    collectWith in class AbstractImmutableCollection<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
  - collectIf
```
public <V> com.gs.collections.api.bag.ImmutableBag<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                       com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    collectIf in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    collectIf in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    collectIf in interface com.gs.collections.api.RichIterable<T>
  - groupBy
```
public <V> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    For each element of the iterable, the function is evaluated and 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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.RichIterable<T>
  - groupByEach
```
public <V> com.gs.collections.api.multimap.bag.ImmutableBagMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.RichIterable<T>
  - getFirst
```
public T getFirst()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
    The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.
    
    Specified by:
    
    getFirst in interface com.gs.collections.api.RichIterable<T>
  - getLast
```
public T getLast()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
    The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.
    
    Specified by:
    
    getLast in interface com.gs.collections.api.RichIterable<T>
  - flatCollect
```
public <V> com.gs.collections.api.bag.ImmutableBag<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    flatCollect in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    flatCollect in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    flatCollect in interface com.gs.collections.api.RichIterable<T>
    
    Parameters:
    function - The Function to apply
    
    Returns:
    a new flattened collection produced by applying the given function
  - groupBy
```
public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                                           R target)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
  - groupByEach
```
public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
                                                                               R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.RichIterable<T>
  - equals
```
public boolean equals(java.lang.Object other)
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    Two bagsb1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
    
    Specified by:
    
    equals in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    equals in interface java.util.Collection<T>
    
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    Map.equals(Object)
  - hashCode
```
public int hashCode()
```
    Description copied from interface: com.gs.collections.api.bag.Bag
    
    Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().
    
    Specified by:
    
    hashCode in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    hashCode in interface java.util.Collection<T>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    Map.hashCode()
  - forEach
```
public void forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.InternalIterable<T>
  - iterator
```
public java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
    
    Specified by:
    
    iterator in interface java.util.Collection<T>
  - min
```
public T min(java.util.Comparator<? super T> comparator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the minimum element out of this container based on the comparator.
    
    Specified by:
    
    min in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    min in class AbstractImmutableCollection<T>
  - max
```
public T max(java.util.Comparator<? super T> comparator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the maximum element out of this container based on the comparator.
    
    Specified by:
    
    max in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    max in class AbstractImmutableCollection<T>
  - min
```
public T min()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the minimum element out of this container based on the natural order.
    
    Specified by:
    
    min in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    min in class AbstractImmutableCollection<T>
  - max
```
public T max()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the maximum element out of this container based on the natural order.
    
    Specified by:
    
    max in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    max in class AbstractImmutableCollection<T>
  - minBy
```
public <V extends java.lang.Comparable<? super V>> T minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
    
    Specified by:
    
    minBy in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    minBy in class AbstractImmutableCollection<T>
  - maxBy
```
public <V extends java.lang.Comparable<? super V>> T maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
    
    Specified by:
    
    maxBy in interface com.gs.collections.api.RichIterable<T>
    
    Overrides:
    
    maxBy in class AbstractImmutableCollection<T>
  - zip
```
public <S> com.gs.collections.api.bag.ImmutableBag<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)
```
    Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    zip in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    zip in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    zip in interface com.gs.collections.api.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.
  - zipWithIndex
```
public com.gs.collections.api.bag.ImmutableBag<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    zipWithIndex in interface com.gs.collections.api.bag.ImmutableBag<T>
    
    Specified by:
    
    zipWithIndex in interface com.gs.collections.api.collection.ImmutableCollection<T>
    
    Specified by:
    
    zipWithIndex in interface com.gs.collections.api.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)
  - writeReplace
```
protected java.lang.Object writeReplace()
```

Class ImmutableArrayBag<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.gs.collections.impl.bag.immutable.AbstractImmutableBag

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 java.lang.Object

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

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

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

Method Detail

newBagWith

copyFrom

size

sizeDistinct

occurrencesOf

forEachWithOccurrences

newWith

newWithout

toMapOfItemToCount

toImmutable

newWithAll

newWithoutAll

selectByOccurrences

select

selectWith

reject

rejectWith

partition

selectInstancesOf

collect

collectWith

collectIf

groupBy

groupByEach

getFirst

getLast

flatCollect

groupBy

groupByEach

equals

hashCode

forEach

iterator

min

max

min

max

minBy

maxBy

zip

zipWithIndex

writeReplace