org.gatein.common.util

Class CollectionMap<K,V>

java.lang.Object

org.gatein.common.util.CollectionMap<K,V>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ListMap, SetMap

public abstract class CollectionMap<K,V>
extends Object
implements Serializable

A map of collections.

Version:

$Revision: 1.1 $

Author:

Julien Viet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Comparator<V>	comparator An optional comparator.

Constructor Summary

Constructors

Constructor and Description
CollectionMap()
CollectionMap(CollectionMap<K,V> other)
CollectionMap(CollectionMap<K,V> other, Comparator<V> comparator)
CollectionMap(Comparator<V> comparator)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	add(Collection<V> c, V o)
boolean	contains(K key, Object o) Return true if the specified set contains the object o.
Collection<V>	get(K key) Return the collection specified by the key.
Iterator<V>	iterator(K key) Return an iterator over the values in the set specified by the key.
Set<K>	keySet() Return the set of keys.
protected abstract Collection<V>	newCollection()
protected abstract Collection<V>	newCollection(Collection<V> other)
void	put(K key, V o) Add an object in the set keyed under the specified key.
protected abstract void	remove(Collection<V> c, Object o) Removes an object from the collection.
void	remove(K key) Remove the entire set of objects specified by the key.
void	remove(K key, Object o) Remove an object in the set keyed under the specified key.

Methods inherited from class java.lang.Object

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

Field Detail

comparator

protected Comparator<V> comparator

An optional comparator.

Constructor Detail

CollectionMap

public CollectionMap()

CollectionMap

public CollectionMap(CollectionMap<K,V> other)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

CollectionMap

public CollectionMap(CollectionMap<K,V> other,
             Comparator<V> comparator)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

CollectionMap

public CollectionMap(Comparator<V> comparator)

Method Detail

put

public final void put(K key,
       V o)
               throws NullPointerException

Add an object in the set keyed under the specified key.

Throws:

NullPointerException - if the key is null

keySet

public final Set<K> keySet()

Return the set of keys.

remove

public final void remove(K key)
                  throws NullPointerException

Remove the entire set of objects specified by the key.

Throws:

NullPointerException - if the key is null

remove

public final void remove(K key,
          Object o)
                  throws NullPointerException

Remove an object in the set keyed under the specified key.

Throws:

NullPointerException - if the key is null

contains

public final boolean contains(K key,
               Object o)
                       throws NullPointerException

Return true if the specified set contains the object o.

Throws:

NullPointerException - if the key is null

get

public Collection<V> get(K key)

Return the collection specified by the key.

iterator

public final Iterator<V> iterator(K key)

Return an iterator over the values in the set specified by the key.

Throws:

NullPointerException - if the key is null

add

protected abstract void add(Collection<V> c,
       V o)

remove

protected abstract void remove(Collection<V> c,
          Object o)

Removes an object from the collection. The type of the object to remove is intentionnally Object and not the parameterized type because the Collection interface is designed that way.

Parameters:

c - the collection to remove from

o - the object to remove

newCollection

protected abstract Collection<V> newCollection()

newCollection

protected abstract Collection<V> newCollection(Collection<V> other)