org.apache.struts2.dispatcher
Class ApplicationMap

java.lang.Object
  java.util.AbstractMap
      org.apache.struts2.dispatcher.ApplicationMap

All Implemented Interfaces:

java.io.Serializable, java.util.Map

public class ApplicationMap
extends java.util.AbstractMap
implements java.io.Serializable

A simple implementation of the Map interface to handle a collection of attributes and init parameters in a ServletContext object. The entrySet() method enumerates over all servlet context attributes and init parameters and returns a collection of both. Note, this will occur lazily - only when the entry set is asked for.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

ApplicationMap(javax.servlet.ServletContext ctx)
Creates a new map object given the servlet context.

Method Summary

void	clear() Removes all entries from the Map and removes all attributes from the servlet context.
java.util.Set	entrySet() Creates a Set of all servlet context attributes as well as context init parameters.
java.lang.Object	get(java.lang.Object key) Returns the servlet context attribute or init parameter based on the given key.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Sets a servlet context attribute given a attribute name and value.
java.lang.Object	remove(java.lang.Object key) Removes the specified servlet context attribute.

Methods inherited from class java.util.AbstractMap

clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationMap

public ApplicationMap(javax.servlet.ServletContext ctx)

Creates a new map object given the servlet context.

Parameters:

ctx - the servlet context

Method Detail

clear

public void clear()

Removes all entries from the Map and removes all attributes from the servlet context.

Specified by:

clear in interface java.util.Map

Overrides:

clear in class java.util.AbstractMap

entrySet

public java.util.Set entrySet()

Creates a Set of all servlet context attributes as well as context init parameters.

Specified by:

entrySet in interface java.util.Map

Specified by:

entrySet in class java.util.AbstractMap

Returns:

a Set of all servlet context attributes as well as context init parameters.

get

public java.lang.Object get(java.lang.Object key)

Returns the servlet context attribute or init parameter based on the given key. If the entry is not found, null is returned.

Specified by:

get in interface java.util.Map

Overrides:

get in class java.util.AbstractMap

Parameters:

key - the entry key.

Returns:

the servlet context attribute or init parameter or null if the entry is not found.

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Sets a servlet context attribute given a attribute name and value.

Specified by:

put in interface java.util.Map

Overrides:

put in class java.util.AbstractMap

Parameters:

key - the name of the attribute.

value - the value to set.

Returns:

the attribute that was just set.

remove

public java.lang.Object remove(java.lang.Object key)

Removes the specified servlet context attribute.

Specified by:

remove in interface java.util.Map

Overrides:

remove in class java.util.AbstractMap

Parameters:

key - the attribute to remove.

Returns:

the entry that was just removed.