org.apache.tiles.request.freemarker.extractor
Class EnvironmentScopeExtractor

Package class diagram package EnvironmentScopeExtractor
java.lang.Object
  extended by org.apache.tiles.request.freemarker.extractor.EnvironmentScopeExtractor
All Implemented Interfaces:
Addable<Object>, AttributeExtractor, HasAddableKeys<Object>, HasKeys<Object>, HasRemovableKeys<Object>

public class EnvironmentScopeExtractor
extends Object
implements AttributeExtractor

Extract attributes from Environment objects as a scope.

Version:
$Rev: 1294456 $ $Date: 2012-02-27 23:44:55 -0500 (Mon, 27 Feb 2012) $

Constructor Summary
EnvironmentScopeExtractor(Environment request)
          Constructor.
 
Method Summary
 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 key, 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

EnvironmentScopeExtractor

public EnvironmentScopeExtractor(Environment request)
Constructor.

Parameters:
request - The environment.
Method Detail

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.

setValue

public void setValue(String key,
                     Object value)
Description copied from interface: Addable
Sets a value for the given key.

Specified by:
setValue in interface Addable<Object>
Parameters:
key - The key of the attribute.
value - The value of the attribute.


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.