org.apache.struts2.portlet
Class PortletRequestMap

java.lang.Object
  extended by java.util.AbstractMap
      extended by org.apache.struts2.portlet.PortletRequestMap
All Implemented Interfaces:
java.util.Map

public class PortletRequestMap
extends java.util.AbstractMap

A simple implementation of the Map interface to handle a collection of request attributes.


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
PortletRequestMap(javax.portlet.PortletRequest request)
          Saves the request to use as the backing for getting and setting values
 
Method Summary
 void clear()
          Removes all attributes from the request as well as clears entries in this map.
 java.util.Set entrySet()
          Returns a Set of attributes from the portlet request.
 java.lang.Object get(java.lang.Object key)
          Returns the request attribute associated with the given key or null if it doesn't exist.
 java.lang.Object put(java.lang.Object key, java.lang.Object value)
          Saves an attribute in the request.
 java.lang.Object remove(java.lang.Object key)
          Removes the specified request 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

PortletRequestMap

public PortletRequestMap(javax.portlet.PortletRequest request)
Saves the request to use as the backing for getting and setting values

Parameters:
request - the portlet request.
Method Detail

clear

public void clear()
Removes all attributes from the request as well as clears entries in this map.

Specified by:
clear in interface java.util.Map
Overrides:
clear in class java.util.AbstractMap

entrySet

public java.util.Set entrySet()
Returns a Set of attributes from the portlet request.

Specified by:
entrySet in interface java.util.Map
Specified by:
entrySet in class java.util.AbstractMap
Returns:
a Set of attributes from the portlet request.

get

public java.lang.Object get(java.lang.Object key)
Returns the request attribute associated with the given key or null if it doesn't exist.

Specified by:
get in interface java.util.Map
Overrides:
get in class java.util.AbstractMap
Parameters:
key - the name of the request attribute.
Returns:
the request attribute or null if it doesn't exist.

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
Saves an attribute in the request.

Specified by:
put in interface java.util.Map
Overrides:
put in class java.util.AbstractMap
Parameters:
key - the name of the request attribute.
value - the value to set.
Returns:
the object that was just set.

remove

public java.lang.Object remove(java.lang.Object key)
Removes the specified request attribute.

Specified by:
remove in interface java.util.Map
Overrides:
remove in class java.util.AbstractMap
Parameters:
key - the name of the attribute to remove.
Returns:
the value that was removed or null if the value was not found (and hence, not removed).


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.