Package org.apache.velocity.example

Class TreeMapContext

java.lang.Object

org.apache.velocity.context.InternalContextBase

org.apache.velocity.context.AbstractContext

org.apache.velocity.example.TreeMapContext

All Implemented Interfaces:

Context, InternalEventContext, InternalHousekeepingContext

public class TreeMapContext
extends AbstractContext

Example context impl that uses a TreeMap Not much point other than to show how easy it is. This is unsupported, example code.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,Object>	context

Constructor Summary

Constructors

Constructor	Description
TreeMapContext()
TreeMapContext(Context inner)

Method Summary

Modifier and Type	Method	Description
boolean	internalContainsKey(String key)	Implement to determine if a key is in the storage.
Object	internalGet(String key)	Implement to return a value from the context storage.
String[]	internalGetKeys()	Implement to return an object array of key strings from your storage.
Object	internalPut(String key, Object value)	Implement to put a value into the context storage.
Object	internalRemove(String key)	Implement to remove an item from your storage.

Methods inherited from class org.apache.velocity.context.AbstractContext

containsKey, get, getChainedContext, getKeys, put, remove

Methods inherited from class org.apache.velocity.context.InternalContextBase

attachEventCartridge, getCurrentMacroCallDepth, getCurrentMacroName, getCurrentResource, getCurrentTemplateName, getEventCartridge, getMacroLibraries, getMacroNameStack, getTemplateNameStack, icacheGet, icachePut, popCurrentMacroName, popCurrentTemplateName, pushCurrentMacroName, pushCurrentTemplateName, setCurrentResource, setMacroLibraries

Methods inherited from class java.lang.Object

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

Field Details

context

private Map<String,Object> context

Constructor Details

TreeMapContext

public TreeMapContext()

TreeMapContext

public TreeMapContext(Context inner)

Method Details

internalGet

public Object internalGet(String key)

Description copied from class: AbstractContext

Implement to return a value from the context storage.

The implementation of this method is required for proper operation of a Context implementation in general Velocity use.

Specified by:

internalGet in class AbstractContext

Parameters:

key - key whose associated value is to be returned

Returns:

object stored in the context

internalPut

public Object internalPut(String key,
 Object value)

Description copied from class: AbstractContext

Implement to put a value into the context storage.

The implementation of this method is required for proper operation of a Context implementation in general Velocity use.

Specified by:

internalPut in class AbstractContext

Parameters:

key - key with which to associate the value

value - value to be associated with the key

Returns:

previously stored value if exists, or null

internalContainsKey

public boolean internalContainsKey(String key)

Description copied from class: AbstractContext

Implement to determine if a key is in the storage.

Currently, this method is not used internally by the Velocity engine.

Specified by:

internalContainsKey in class AbstractContext

Parameters:

key - key to test for existence

Returns:

true if found, false if not

internalGetKeys

public String[] internalGetKeys()

Description copied from class: AbstractContext

Implement to return an object array of key strings from your storage.

Currently, this method is not used internally by the Velocity engine.

Specified by:

internalGetKeys in class AbstractContext

Returns:

array of keys

internalRemove

public Object internalRemove(String key)

Description copied from class: AbstractContext

Implement to remove an item from your storage.

Currently, this method is not used internally by the Velocity engine.

Specified by:

internalRemove in class AbstractContext

Parameters:

key - key to remove

Returns:

object removed if exists, else null