org.kocakosm.pitaya.collection

Class ConcurrentHashBag<E>

java.lang.Object

java.util.AbstractCollection<E>

org.kocakosm.pitaya.collection.AbstractBag<E>

org.kocakosm.pitaya.collection.ConcurrentHashBag<E>

Type Parameters:

E - the type of the elements in the bag.

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Bag<E>, ConcurrentBag<E>

public final class ConcurrentHashBag<E>
extends AbstractBag<E>
implements ConcurrentBag<E>, Serializable

A thread-safe variant of HashBag based on ConcurrentHashMap.

Author:

Osman KOCAK

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConcurrentHashBag() Creates a new empty ConcurrentHashBag.
ConcurrentHashBag(Collection<? extends E> c) Creates a new ConcurrentHashBag using the elements contained in the given Collection.
ConcurrentHashBag(E... elements) Creates a new ConcurrentHashBag using the elements contained in the given array.
ConcurrentHashBag(int initialCapacity) Creates a new empty ConcurrentHashBag having the given initial capacity.
ConcurrentHashBag(Iterable<? extends E> i) Creates a new ConcurrentHashBag using the elements contained in the given Iterable.
ConcurrentHashBag(Iterator<? extends E> i) Creates a new ConcurrentHashBag using the elements contained in the given Iterator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e)
int	addAllAbsent(Collection<? extends E> c) Adds all of the elements in the specified collection that are not already contained in this bag.
boolean	addIfAbsent(E e) Adds the given element to this bag if not already present.
void	clear()
boolean	contains(Object o)
int	count(E e) Returns the count of the given element in this bag.
Iterator<E>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()

Methods inherited from class org.kocakosm.pitaya.collection.AbstractBag

equals, hashCode

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

addAll, containsAll, equals, hashCode, isEmpty, toArray, toArray

Constructor Detail

ConcurrentHashBag

public ConcurrentHashBag()

Creates a new empty ConcurrentHashBag.

ConcurrentHashBag

public ConcurrentHashBag(int initialCapacity)

Creates a new empty ConcurrentHashBag having the given initial capacity.

Parameters:

initialCapacity - the bag's initial capacity.

Throws:

IllegalArgumentException - if initialCapacity < 0.

ConcurrentHashBag

public ConcurrentHashBag(Collection<? extends E> c)

Creates a new ConcurrentHashBag using the elements contained in the given Collection.

Parameters:

c - the collection to use to populate the created bag.

Throws:

NullPointerException - if c is null or if it contains a null reference.

ConcurrentHashBag

public ConcurrentHashBag(Iterable<? extends E> i)

Creates a new ConcurrentHashBag using the elements contained in the given Iterable.

Parameters:

i - the iterable to use to populate the created bag.

Throws:

NullPointerException - if i is null or if it contains a null reference.

ConcurrentHashBag

public ConcurrentHashBag(Iterator<? extends E> i)

Creates a new ConcurrentHashBag using the elements contained in the given Iterator.

Parameters:

i - the iterator to use to populate the created bag.

Throws:

NullPointerException - if i is null or if it contains a null reference.

ConcurrentHashBag

public ConcurrentHashBag(E... elements)

Creates a new ConcurrentHashBag using the elements contained in the given array.

Parameters:

elements - the elements to use to populate the created bag.

Throws:

NullPointerException - if elements is null or if it contains a null reference.

Method Detail

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollection<E>

addAllAbsent

public int addAllAbsent(Collection<? extends E> c)

Description copied from interface: ConcurrentBag

Adds all of the elements in the specified collection that are not already contained in this bag.

Specified by:

addAllAbsent in interface ConcurrentBag<E>

Parameters:

c - the collection containing elements to be added to this bag.

Returns:

the number of elements added.

addIfAbsent

public boolean addIfAbsent(E e)

Description copied from interface: ConcurrentBag

Adds the given element to this bag if not already present.

Specified by:

addIfAbsent in interface ConcurrentBag<E>

Parameters:

e - the element to be added to this bag, if absent.

Returns:

true if the element has been added.

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Overrides:

contains in class AbstractCollection<E>

count

public int count(E e)

Description copied from interface: Bag

Returns the count of the given element in this bag.

Specified by:

count in interface Bag<E>

Overrides:

count in class AbstractBag<E>

Parameters:

e - the object to count.

Returns:

the number of occurrences of e in this bag.

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class AbstractCollection<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>