org.apache.tiles.request.portlet.extractor

Class SessionScopeExtractor

java.lang.Object

org.apache.tiles.request.portlet.extractor.SessionScopeExtractor

All Implemented Interfaces:

Addable<Object>, AttributeExtractor, HasAddableKeys<Object>, HasKeys<Object>, HasRemovableKeys<Object>

public class SessionScopeExtractor
extends Object
implements AttributeExtractor

Extracts attributes from the session scope of a portlet request.

Version:

$Rev: 1066849 $ $Date: 2011-02-04 03:12:39 +1100 (Fri, 04 Feb 2011) $

Constructor Summary

Constructors

Constructor and Description
SessionScopeExtractor(javax.portlet.PortletRequest request, int scope) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Enumeration<String>	getKeys() The enumeration of the keys of the stored attributes.
Object	getValue(String key) Returns the value of the attribute with the given key.
void	removeValue(String name) Removes an attribute.
void	setValue(String name, Object value) Sets a value for the given key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionScopeExtractor

public SessionScopeExtractor(javax.portlet.PortletRequest request,
                     int scope)

Constructor.

Parameters:

request - The request.

scope - The subscope (application or portlet).

Method Detail

setValue

public void setValue(String name,
            Object value)

Description copied from interface: Addable

Sets a value for the given key.

Specified by:

setValue in interface Addable<Object>

Parameters:

name - The key of the attribute.

value - The value of the attribute.

removeValue

public void removeValue(String name)

Description copied from interface: HasRemovableKeys

Removes an attribute.

Specified by:

removeValue in interface HasRemovableKeys<Object>

Parameters:

name - The key of the attribute to remove.

getKeys

public Enumeration<String> getKeys()

Description copied from interface: HasKeys

The enumeration of the keys of the stored attributes.

Specified by:

getKeys in interface HasKeys<Object>

Returns:

The keys.

getValue

public Object getValue(String key)

Description copied from interface: HasKeys

Returns the value of the attribute with the given key.

Specified by:

getValue in interface HasKeys<Object>

Parameters:

key - The key of the attribute.

Returns:

The value.