Package org.glassfish.grizzly.http.server.util

Class ParameterMap

java.lang.Object
java.util.AbstractMap<K,V>
java.util.HashMap<K,V>
java.util.LinkedHashMap<String,String[]>
org.glassfish.grizzly.http.server.util.ParameterMap
All Implemented Interfaces:
Serializable, Cloneable, Map<String,String[]>
public final class ParameterMap extends LinkedHashMap<String,String[]>
Extended implementation of LinkedHashMap that includes a locked property. 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, a ParameterMap instance is not locked.
Version:
$Revision: 1.4 $ $Date: 2007/06/18 17:41:35 $
Author:
Craig R. McClanahan
See Also:

  • Constructor Details

    • 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 map
      loadFactor - The load factor of this map

    • ParameterMap

      public ParameterMap(Map<String,String[]> map)
      Construct a new map with the same mappings as the given map.
      Parameters:
      map - Map whose contents are duplicated in the new map

  • Method Details

    • isLocked

      public boolean isLocked()
      Return 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()
      Remove all mappings from this map.
      Specified by:
      clear in interface Map<String,String[]>
      Overrides:
      clear in class LinkedHashMap<String,String[]>
      Throws:
      IllegalStateException - if this map is currently locked

    • put

      public String[] put(String key, String[] value)
      Associate the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.
      Specified by:
      put in interface Map<String,String[]>
      Overrides:
      put in class HashMap<String,String[]>
      Parameters:
      key - Key with which the specified value is to be associated
      value - Value to be associated with the specified key
      Returns:
      The previous value associated with the specified key, or null if there was no mapping for key
      Throws:
      IllegalStateException - if this map is currently locked

    • putAll

      public void putAll(Map map)
      Copy all of the mappings from the specified map to this one. These mappings replace any mappings that this map had for any of the keys currently in the specified Map.
      Specified by:
      putAll in interface Map<String,String[]>
      Overrides:
      putAll in class HashMap<String,String[]>
      Parameters:
      map - Mappings to be stored into this map
      Throws:
      IllegalStateException - if this map is currently locked

    • remove

      public Object remove(String key)
      Remove the mapping for this key from the map if present.
      Parameters:
      key - Key whose mapping is to be removed from the map
      Returns:
      The previous value associated with the specified key, or null if there was no mapping for that key
      Throws:
      IllegalStateException - if this map is currently locked