HashBag (Goldman Sachs Collections

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

All Implemented Interfaces:

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

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

HashBag()

HashBag(int size)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T item)`
`boolean`	`addAll(Collection<? extends T> source)`
`void`	`addOccurrences(T item, int occurrences)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`void`	`each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)`
`boolean`	`equals(Object other)`
`<P> void`	`forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter)`
`void`	`forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)`
`void`	`forEachWithOccurrences(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)`
`<V> HashBagMultimap<V,T>`	`groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)`
`<V> HashBagMultimap<V,T>`	`groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends Iterable<V>> function)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<T>`	`iterator()`
`static <E> HashBag<E>`	`newBag()`
`static <E> HashBag<E>`	`newBag(com.gs.collections.api.bag.Bag<? extends E> source)`
`static <E> HashBag<E>`	`newBag(int size)`
`static <E> HashBag<E>`	`newBag(Iterable<? extends E> source)`
`static <E> HashBag<E>`	`newBagWith(E... elements)`
`com.gs.collections.api.bag.MutableBag<T>`	`newEmpty()`
`int`	`occurrencesOf(Object item)`
`void`	`readExternal(ObjectInput in)`
`boolean`	`remove(Object item)`
`boolean`	`removeAllIterable(Iterable<?> iterable)`
`boolean`	`removeIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)`
`<P> boolean`	`removeIfWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)`
`boolean`	`removeOccurrences(Object item, int occurrences)`
`com.gs.collections.api.bag.MutableBag<T>`	`selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)`
`boolean`	`setOccurrences(T item, int occurrences)`
`int`	`size()`
`int`	`sizeDistinct()`
`com.gs.collections.api.map.MutableMap<T,Integer>`	`toMapOfItemToCount()`
`HashBag<T>`	`with(T... elements)`
`HashBag<T>`	`with(T element)`
`HashBag<T>`	`with(T element1, T element2)`
`HashBag<T>`	`with(T element1, T element2, T element3)`
`HashBag<T>`	`withAll(Iterable<? extends T> iterable)`
`HashBag<T>`	`without(T element)`
`HashBag<T>`	`withoutAll(Iterable<? extends T> iterable)`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class com.gs.collections.impl.bag.mutable.AbstractMutableBag
asParallel, asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, tap, toImmutable, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.bag.mutable.AbstractMutableBagIterable
addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, bottomOccurrences, chunk, detect, detectIfNone, detectWith, detectWithIfNone, getFirst, getLast, groupByUniqueKey, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, removeAll, retainAll, retainAllIterable, selectAndRejectWith, topOccurrences

Methods inherited from class com.gs.collections.impl.bag.AbstractBag
collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, count, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toSet, toSortedBag, toSortedBag, toSortedList, toSortedSet, toSortedSet, toStringOfItemToCount

Methods inherited from class com.gs.collections.impl.AbstractRichIterable
appendString, appendString, appendString, asLazy, containsAll, containsAllArguments, containsAllIterable, countWith, forEach, groupByUniqueKey, makeString, makeString, makeString, notEmpty, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray, toMap, toSortedBagBy, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSetBy, toString, zip, zipWithIndex

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

Methods inherited from interface com.gs.collections.api.bag.MutableBagIterable
bottomOccurrences, topOccurrences

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

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

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

Methods inherited from interface com.gs.collections.api.RichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

- Constructor Detail
  - HashBag
```
public HashBag()
```
  - HashBag
```
public HashBag(int size)
```
- Method Detail
  - newBag
```
public static <E> HashBag<E> newBag()
```
  - newBag
```
public static <E> HashBag<E> newBag(int size)
```
  - newBag
```
public static <E> HashBag<E> newBag(com.gs.collections.api.bag.Bag<? extends E> source)
```
  - newBag
```
public static <E> HashBag<E> newBag(Iterable<? extends E> source)
```
  - newBagWith
```
public static <E> HashBag<E> newBagWith(E... elements)
```
  - addAll
```
public boolean addAll(Collection<? extends T> source)
```
    Specified by:
    
    addAll in interface Collection<T>
    
    Overrides:
    
    addAll in class AbstractMutableBagIterable<T>
  - addOccurrences
```
public void addOccurrences(T item,
                           int occurrences)
```
    Specified by:
    
    addOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    equals in interface Collection<T>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    hashCode in interface Collection<T>
    
    Overrides:
    
    hashCode in class Object
  - sizeDistinct
```
public int sizeDistinct()
```
    Specified by:
    
    sizeDistinct in interface com.gs.collections.api.bag.Bag<T>
  - occurrencesOf
```
public int occurrencesOf(Object item)
```
    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)
```
    Specified by:
    
    forEachWithOccurrences in interface com.gs.collections.api.bag.Bag<T>
  - selectByOccurrences
```
public com.gs.collections.api.bag.MutableBag<T> selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)
```
    Specified by:
    
    selectByOccurrences in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    selectByOccurrences in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    selectByOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    selectByOccurrences in interface com.gs.collections.api.bag.UnsortedBag<T>
  - toMapOfItemToCount
```
public com.gs.collections.api.map.MutableMap<T,Integer> toMapOfItemToCount()
```
    Specified by:
    
    toMapOfItemToCount in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    toMapOfItemToCount in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    toMapOfItemToCount in interface com.gs.collections.api.bag.MutableBagIterable<T>
  - remove
```
public boolean remove(Object item)
```
    Specified by:
    
    remove in interface Collection<T>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<T>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface com.gs.collections.api.RichIterable<T>
    
    Specified by:
    
    isEmpty in interface Collection<T>
    
    Overrides:
    
    isEmpty in class AbstractRichIterable<T>
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - each
```
public void each(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
```
    Specified by:
    
    each in interface com.gs.collections.api.RichIterable<T>
  - forEachWithIndex
```
public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
```
    Specified by:
    
    forEachWithIndex in interface com.gs.collections.api.InternalIterable<T>
    
    Overrides:
    
    forEachWithIndex in class AbstractRichIterable<T>
  - forEachWith
```
public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
                            P parameter)
```
    Specified by:
    
    forEachWith in interface com.gs.collections.api.InternalIterable<T>
    
    Overrides:
    
    forEachWith in class AbstractRichIterable<T>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>
  - removeOccurrences
```
public boolean removeOccurrences(Object item,
                                 int occurrences)
```
    Specified by:
    
    removeOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>
  - setOccurrences
```
public boolean setOccurrences(T item,
                              int occurrences)
```
    Specified by:
    
    setOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>
  - without
```
public HashBag<T> without(T element)
```
    Specified by:
    
    without in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    without in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    without in interface com.gs.collections.api.collection.MutableCollection<T>
  - newEmpty
```
public com.gs.collections.api.bag.MutableBag<T> newEmpty()
```
    Specified by:
    
    newEmpty in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    newEmpty in interface com.gs.collections.api.collection.MutableCollection<T>
  - with
```
public HashBag<T> with(T element)
```
    Specified by:
    
    with in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    with in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    with in interface com.gs.collections.api.collection.MutableCollection<T>
  - withAll
```
public HashBag<T> withAll(Iterable<? extends T> iterable)
```
    Specified by:
    
    withAll in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    withAll in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    withAll in interface com.gs.collections.api.collection.MutableCollection<T>
  - withoutAll
```
public HashBag<T> withoutAll(Iterable<? extends T> iterable)
```
    Specified by:
    
    withoutAll in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    withoutAll in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    withoutAll in interface com.gs.collections.api.collection.MutableCollection<T>
  - removeIf
```
public boolean removeIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
    Specified by:
    
    removeIf in interface com.gs.collections.api.collection.MutableCollection<T>
  - removeIfWith
```
public <P> boolean removeIfWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                P parameter)
```
    Specified by:
    
    removeIfWith in interface com.gs.collections.api.collection.MutableCollection<T>
  - removeAllIterable
```
public boolean removeAllIterable(Iterable<?> iterable)
```
    Specified by:
    
    removeAllIterable in interface com.gs.collections.api.collection.MutableCollection<T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface com.gs.collections.api.RichIterable<T>
    
    Specified by:
    
    size in interface Collection<T>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface com.gs.collections.api.RichIterable<T>
    
    Specified by:
    
    contains in interface Collection<T>
    
    Overrides:
    
    contains in class AbstractRichIterable<T>
  - groupBy
```
public <V> HashBagMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
    Specified by:
    
    groupBy in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.bag.UnsortedBag<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.collection.MutableCollection<T>
    
    Specified by:
    
    groupBy in interface com.gs.collections.api.RichIterable<T>
  - groupByEach
```
public <V> HashBagMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends Iterable<V>> function)
```
    Specified by:
    
    groupByEach in interface com.gs.collections.api.bag.Bag<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.bag.MutableBag<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.bag.MutableBagIterable<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.bag.UnsortedBag<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.RichIterable<T>
  - with
```
public HashBag<T> with(T... elements)
```
  - with
```
public HashBag<T> with(T element1,
                       T element2)
```
  - add
```
public boolean add(T item)
```
    Specified by:
    
    add in interface Collection<T>
  - with
```
public HashBag<T> with(T element1,
                       T element2,
                       T element3)
```

Class HashBag<T>

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.bag.mutable.AbstractMutableBag

Methods inherited from class com.gs.collections.impl.bag.mutable.AbstractMutableBagIterable

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

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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.util.Collection

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

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

Constructor Detail

HashBag

HashBag

Method Detail

newBag

newBag

newBag

newBag

newBagWith

addAll

addOccurrences

equals

hashCode

sizeDistinct

occurrencesOf

forEachWithOccurrences

selectByOccurrences

toMapOfItemToCount

remove

clear

isEmpty

writeExternal

readExternal

each

forEachWithIndex

forEachWith

iterator

removeOccurrences

setOccurrences

without

newEmpty

with

withAll

withoutAll

removeIf

removeIfWith

removeAllIterable

size

contains

groupBy

groupByEach

with

with

add

with