Package org.apache.catalina.util
Class ParameterMap<K,V>
- java.lang.Object
-
- org.apache.catalina.util.ParameterMap<K,V>
-
- Type Parameters:
K- The type of KeyV- The type of Value
- All Implemented Interfaces:
Serializable,Map<K,V>
public final class ParameterMap<K,V> extends Object implements Map<K,V>, Serializable
Implementation of java.util.Map that includes alockedproperty. This class can be used to safely expose Catalina internal parameter map objects to user classes without having to clone them in order to avoid modifications. When first created, aParameterMapinstance is not locked.- Author:
- Craig R. McClanahan
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ParameterMap()Construct a new, empty map with the default initial capacity and load factor.ParameterMap(int initialCapacity)Construct a new, empty map with the specified initial capacity and default load factor.ParameterMap(int initialCapacity, float loadFactor)Construct a new, empty map with the specified initial capacity and load factor.ParameterMap(Map<K,V> map)Construct a new map with the same mappings as the given map.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()booleancontainsKey(Object key)booleancontainsValue(Object value)Set<Map.Entry<K,V>>entrySet()Vget(Object key)booleanisEmpty()booleanisLocked()Set<K>keySet()Vput(K key, V value)voidputAll(Map<? extends K,? extends V> map)Vremove(Object key)voidsetLocked(boolean locked)Set the locked state of this parameter map.intsize()Collection<V>values()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Constructor Detail
-
ParameterMap
public ParameterMap()
Construct a new, empty map with the default initial capacity and load factor.
-
ParameterMap
public ParameterMap(int initialCapacity)
Construct a new, empty map with the specified initial capacity and default load factor.- Parameters:
initialCapacity- The initial capacity of this map
-
ParameterMap
public ParameterMap(int initialCapacity, float loadFactor)Construct a new, empty map with the specified initial capacity and load factor.- Parameters:
initialCapacity- The initial capacity of this maploadFactor- The load factor of this map
-
-
Method Detail
-
isLocked
public boolean isLocked()
- Returns:
- the locked state of this parameter map.
-
setLocked
public void setLocked(boolean locked)
Set the locked state of this parameter map.- Parameters:
locked- The new locked state
-
clear
public void clear()
- Specified by:
clearin interfaceMap<K,V>- Throws:
IllegalStateException- if this map is currently locked
-
put
public V put(K key, V value)
- Specified by:
putin interfaceMap<K,V>- Throws:
IllegalStateException- if this map is currently locked
-
putAll
public void putAll(Map<? extends K,? extends V> map)
- Specified by:
putAllin interfaceMap<K,V>- Throws:
IllegalStateException- if this map is currently locked
-
remove
public V remove(Object key)
- Specified by:
removein interfaceMap<K,V>- Throws:
IllegalStateException- if this map is currently locked
-
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKeyin interfaceMap<K,V>
-
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValuein interfaceMap<K,V>
-
keySet
public Set<K> keySet()
Returns an unmodifiable
Setview of the keys contained in this map if it is locked.
-
values
public Collection<V> values()
Returns an unmodifiable
Collectionview of the values contained in this map if it is locked.
-
-