org.gatein.common.util

Class AbstractTypedMap<EK,EV,IK,IV>

java.lang.Object

org.gatein.common.util.AbstractTypedMap<EK,EV,IK,IV>

All Implemented Interfaces:

Map<EK,EV>

Direct Known Subclasses:

ParameterMap, TypedMap

public abstract class AbstractTypedMap<EK,EV,IK,IV>
extends Object
implements Map<EK,EV>

A map implementations that use a conversion mechanism to provide a type mapping between the external types declared by the map and the internal representations backed by the internal map.

Version:

$Revision: 1.1 $

Author:

Julien Viet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTypedMap.Converter<E,I> Defines a converter that converts an internal value to an external value and vice versa.

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractTypedMap()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected Map<IK,IV>	convert(Map<? extends EK,? extends EV> t) Validates and unwraps the map.
Set<Map.Entry<EK,EV>>	entrySet()
boolean	equals(Object o) Compare to parameters objects.
EV	get(Object key)
protected abstract Map<IK,IV>	getDelegate()
abstract AbstractTypedMap.Converter<EK,IK>	getKeyConverter()
abstract AbstractTypedMap.Converter<EV,IV>	getValueConverter()
boolean	isEmpty()
Set<EK>	keySet()
EV	put(EK ek, EV ev)
void	putAll(Map<? extends EK,? extends EV> em)
EV	remove(Object key)
void	replace(Map<EK,EV> map) Replace the content with the new map which is validated before replacement.
int	size()
String	toString()
void	validate() Validate the content.
Collection<EV>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

hashCode

Constructor Detail

AbstractTypedMap

public AbstractTypedMap()

Method Detail

getKeyConverter

public abstract AbstractTypedMap.Converter<EK,IK> getKeyConverter()

getValueConverter

public abstract AbstractTypedMap.Converter<EV,IV> getValueConverter()

getDelegate

protected abstract Map<IK,IV> getDelegate()

size

public final int size()

Specified by:

size in interface Map<EK,EV>

clear

public final void clear()

Specified by:

clear in interface Map<EK,EV>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Map<EK,EV>

containsKey

public final boolean containsKey(Object key)

Specified by:

containsKey in interface Map<EK,EV>

keySet

public final Set<EK> keySet()

Specified by:

keySet in interface Map<EK,EV>

put

public final EV put(EK ek,
     EV ev)

Specified by:

put in interface Map<EK,EV>

get

public final EV get(Object key)

Specified by:

get in interface Map<EK,EV>

remove

public final EV remove(Object key)

Specified by:

remove in interface Map<EK,EV>

containsValue

public final boolean containsValue(Object value)

Specified by:

containsValue in interface Map<EK,EV>

entrySet

public final Set<Map.Entry<EK,EV>> entrySet()

Specified by:

entrySet in interface Map<EK,EV>

putAll

public final void putAll(Map<? extends EK,? extends EV> em)

Specified by:

putAll in interface Map<EK,EV>

values

public final Collection<EV> values()

Specified by:

values in interface Map<EK,EV>

equals

public final boolean equals(Object o)

Compare to parameters objects.

Specified by:

equals in interface Map<EK,EV>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

convert

protected final Map<IK,IV> convert(Map<? extends EK,? extends EV> t)
                            throws IllegalArgumentException,
                                   NullPointerException,
                                   ClassCastException

Validates and unwraps the map.

Throws:

IllegalArgumentException

NullPointerException

ClassCastException

replace

public final void replace(Map<EK,EV> map)
                   throws ClassCastException,
                          NullPointerException,
                          IllegalArgumentException

Replace the content with the new map which is validated before replacement.

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

validate

public final void validate()
                    throws ClassCastException,
                           NullPointerException,
                           IllegalArgumentException

Validate the content.

Throws:

ClassCastException

NullPointerException

IllegalArgumentException