senselogic.sitevision.api.render.velocity

Interface VelocityContext

public interface VelocityContext

Name/Object mappings that can be used when rendering a Velocity template.

An instance of the Sitevision class implementing this interface can be obtained via a getVelocityContext method in VelocityRenderer.

Since:

Sitevision 3.0

Author:

Magnus Lövgren

See Also:

VelocityRenderer

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String aKey) Checks whether a name has a mapping or not.
Object	get(String aKey) Returns the mapped object for a specified name.
String[]	getKeys() Returns all names.
void	put(String aKey, Object anObject) Adds a Name/Object mapping to the context.
Object	remove(String aKey) Removes a Name/Object mapping.

Method Detail

put

void put(String aKey,
         Object anObject)

Adds a Name/Object mapping to the context. Null key mappings will be ignored.

Parameters:

aKey - a name, not null

anObject - an object

get

Object get(String aKey)

Returns the mapped object for a specified name.

Parameters:

aKey - the name.

Returns:

the Object mapped for aKey, or null if no mapping for aKey exist

containsKey

boolean containsKey(String aKey)

Checks whether a name has a mapping or not.

Parameters:

aKey - the name

Returns:

true if an Object is mapped for aKey, false otherwise

getKeys

String[] getKeys()

Returns all names.

Returns:

all names.

remove

Object remove(String aKey)

Removes a Name/Object mapping.

Parameters:

aKey - the name.

Returns:

the Object mapped to aKey, or null if no mapping for aKey exist