org.apache.commons.collections4.bag

Class HashBag<E>

java.lang.Object

org.apache.commons.collections4.bag.AbstractMapBag<E>

org.apache.commons.collections4.bag.HashBag<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, Bag<E>

public class HashBag<E>
extends AbstractMapBag<E>
implements java.io.Serializable

Implements Bag, using a HashMap to provide the data storage. This is the standard implementation of a bag.

A Bag stores each object in the collection together with a count of occurrences. Extra methods on the interface allow multiple copies of an object to be added or removed at once. It is important to read the interface javadoc carefully as several methods violate the Collection interface specification.

Since:

3.0 (previously in main package v2.0)

Version:

$Id: HashBag.java 1543928 2013-11-20 20:15:35Z tn $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections4.bag.AbstractMapBag

AbstractMapBag.BagIterator<E>, AbstractMapBag.MutableInteger

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serial version lock

Constructor Summary

Constructors

Constructor and Description
HashBag() Constructs an empty HashBag.
HashBag(java.util.Collection<? extends E> coll) Constructs a bag containing all the members of the given collection.

Method Summary

Modifier and Type	Method and Description
private void	readObject(java.io.ObjectInputStream in) Read the bag in using a custom routine.
private void	writeObject(java.io.ObjectOutputStream out) Write the bag out using a custom routine.

Methods inherited from class org.apache.commons.collections4.bag.AbstractMapBag

add, add, addAll, clear, contains, containsAll, containsAll, doReadObject, doWriteObject, equals, getCount, getMap, hashCode, isEmpty, iterator, remove, remove, removeAll, retainAll, retainAll, size, toArray, toArray, toString, uniqueSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version lock

See Also:

Constant Field Values

Constructor Detail

HashBag

public HashBag()

Constructs an empty HashBag.

HashBag

public HashBag(java.util.Collection<? extends E> coll)

Constructs a bag containing all the members of the given collection.

Parameters:

coll - a collection to copy into this bag

Method Detail

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Write the bag out using a custom routine.

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Read the bag in using a custom routine.

Throws:

java.io.IOException

java.lang.ClassNotFoundException