org.apache.velocity.context

Interface Context

Known Subinterfaces:
InternalContextAdapter
Known Implementing Classes:
AbstractContext, InternalContextAdapterImpl, VelocityContext, VMContext

public interface Context

Interface describing the application data context. This set of routines is used by the application to set and remove 'named' data object to pass them to the template engine to use when rendering a template. This is the same set of methods supported by the original Context class
Version:
$Id: Context.java,v 1.5.4.1 2004/03/03 23:22:54 geirm Exp $
Authors:
Jason van Zyl
Geir Magnusson Jr.
See Also:
AbstractContext, VelocityContext

Method Summary

boolean
containsKey(Object key)
Indicates whether the specified key is in the context.
Object
get(String key)
Gets the value corresponding to the provided key from the context.
Object[]
getKeys()
Get all the keys for the values in the context
Object
put(String key, Object value)
Adds a name/value pair to the context.
Object
remove(Object key)
Removes the value associated with the specified key from the context.

Method Details

containsKey

public boolean containsKey(Object key)
Indicates whether the specified key is in the context.
Parameters:
key - The key to look for.
Returns:
Whether the key is in the context.

get

public Object get(String key)
Gets the value corresponding to the provided key from the context.
Parameters:
key - The name of the desired value.
Returns:
The value corresponding to the provided key.

getKeys

public Object[] getKeys()
Get all the keys for the values in the context

put

public Object put(String key,
                  Object value)
Adds a name/value pair to the context.
Parameters:
key - The name to key the provided value with.
value - The corresponding value.

remove

public Object remove(Object key)
Removes the value associated with the specified key from the context.
Parameters:
key - The name of the value to remove.
Returns:
The value that the key was mapped to, or null if unmapped.

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.