Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts2.dispatcher
Class RequestMap

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

All Implemented Interfaces:
  Serializable, Map

    public class RequestMap

extends AbstractMap
implements Serializable

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

See Also:
  Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap
`AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>`

Nested classes/interfaces inherited from interface java.util.Map
`Map.Entry<K,V>`

Constructor Summary
`RequestMap(javax.servlet.http.HttpServletRequest 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.
`Set` | `entrySet()` Returns a Set of attributes from the http request.
`Object` | `get(Object key)` Returns the request attribute associated with the given key or `null` if it doesn't exist.
`Object` | `put(Object key, Object value)` Saves an attribute in the request.
`Object` | `remove(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

### RequestMap

    public RequestMap(javax.servlet.http.HttpServletRequest request)

  Saves the request to use as the backing for getting and setting values

  Parameters:
    `request` - the http servlet 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 `Map`
  Overrides:
    `clear` in class `AbstractMap`

### entrySet

    public Set entrySet()

  Returns a Set of attributes from the http request.

  Specified by:
    `entrySet` in interface `Map`
  Specified by:
    `entrySet` in class `AbstractMap`
  Returns:
    a Set of attributes from the http request.

### get

    public Object get(Object key)

  Returns the request attribute associated with the given key or `null` if it doesn't exist.

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

### put

    public Object put(Object key,
                      Object value)

  Saves an attribute in the request.

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

### remove

    public Object remove(Object key)

  Removes the specified request attribute.

  Specified by:
    `remove` in interface `Map`
  Overrides:
    `remove` in class `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).

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000–2018 Apache Software Foundation. All rights reserved.