de.topobyte.adt.multicollections

Class HashMultiSet<T>

java.lang.Object

de.topobyte.adt.multicollections.HashMultiSet<T>

Type Parameters:

T - the type of elements

All Implemented Interfaces:

MultiSet<T>, Iterable<T>

public class HashMultiSet<T>
extends Object
implements MultiSet<T>

A straightforward implementation of MultiSet using a HashMap.

Constructor Summary

Constructors

Constructor and Description
HashMultiSet()
HashMultiSet(MultiSet<T> prototype)

Method Summary

Modifier and Type	Method and Description
void	add(T key) Put key to the MultiSet once.
void	add(T key, int howOften)
void	addAll(Collection<T> keys) Put all keys contained in key into the MultiSet once.
void	addAll(Collection<T> keys, int howOften)
boolean	contains(T key) Test whether key is present in this MultiSet.
Iterator<T>	iterator()
Set<T>	keySet() Get the set of keys in this MultiSet.
int	occurences(T key) Get the number of times the element key is present in this MultiSet.
void	remove(T key) Remove key from the MultiSet once.
void	removeAll(Collection<? extends T> c)
void	removeAllN(Collection<? extends T> c, int n)
void	removeAllOccurences(Collection<? extends T> c)
void	removeN(T key, int n) Remove key from the MultiSet once.
void	removeOccurences(T key) Remove all occurrences of key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HashMultiSet

public HashMultiSet()

HashMultiSet

public HashMultiSet(MultiSet<T> prototype)

Method Detail

contains

public boolean contains(T key)

Description copied from interface: MultiSet

Test whether key is present in this MultiSet.

Specified by:

contains in interface MultiSet<T>

Parameters:

key - the element queried.

Returns:

whether key is contained in this MultiSet.

occurences

public int occurences(T key)

Description copied from interface: MultiSet

Get the number of times the element key is present in this MultiSet.

Specified by:

occurences in interface MultiSet<T>

Parameters:

key - the element queried.

Returns:

the number of occurrences of key in this MultiSet.

add

public void add(T key)

Description copied from interface: MultiSet

Put key to the MultiSet once.

Specified by:

add in interface MultiSet<T>

Parameters:

key - the element to add.

add

public void add(T key,
                int howOften)

Specified by:

add in interface MultiSet<T>

addAll

public void addAll(Collection<T> keys)

Description copied from interface: MultiSet

Put all keys contained in key into the MultiSet once.

Specified by:

addAll in interface MultiSet<T>

Parameters:

keys - a collection of keys.

addAll

public void addAll(Collection<T> keys,
                   int howOften)

Specified by:

addAll in interface MultiSet<T>

remove

public void remove(T key)

Description copied from interface: MultiSet

Remove key from the MultiSet once.

Specified by:

remove in interface MultiSet<T>

Parameters:

key - the element to remove.

removeAll

public void removeAll(Collection<? extends T> c)

Specified by:

removeAll in interface MultiSet<T>

removeOccurences

public void removeOccurences(T key)

Description copied from interface: MultiSet

Remove all occurrences of key.

Specified by:

removeOccurences in interface MultiSet<T>

Parameters:

key - the element to remove.

removeAllOccurences

public void removeAllOccurences(Collection<? extends T> c)

Specified by:

removeAllOccurences in interface MultiSet<T>

removeN

public void removeN(T key,
                    int n)

Description copied from interface: MultiSet

Remove key from the MultiSet once.

Specified by:

removeN in interface MultiSet<T>

Parameters:

key - the element to remove.

n - the number of times to remove the specified element.

removeAllN

public void removeAllN(Collection<? extends T> c,
                       int n)

Specified by:

removeAllN in interface MultiSet<T>

keySet

public Set<T> keySet()

Description copied from interface: MultiSet

Get the set of keys in this MultiSet.

Specified by:

keySet in interface MultiSet<T>

Returns:

the set of keys.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>