org.apache.velocity.context

Interface Context

All Known Subinterfaces:

InternalContextAdapter

All Known Implementing Classes:

AbstractContext, ChainedInternalContextAdapter, EvaluateContext, Foreach.NullHolderContext, InternalContextAdapterImpl, ProxyVMContext, VelocityContext

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 463298 2006-10-12 16:10:32Z henning $

Author:

Jason van Zyl, Geir Magnusson Jr.

See Also:

AbstractContext, VelocityContext

Method Summary

Methods

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

Method Detail

put

java.lang.Object put(java.lang.String key,
                   java.lang.Object value)

Adds a name/value pair to the context.

Parameters:

key - The name to key the provided value with.

value - The corresponding value.

Returns:

The old object or null if there was no old object.

get

java.lang.Object get(java.lang.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.

containsKey

boolean containsKey(java.lang.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.

getKeys

java.lang.Object[] getKeys()

Get all the keys for the values in the context.

Returns:

All the keys for the values in the context.

remove

java.lang.Object remove(java.lang.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.