Package org.apache.velocity.context

Class InternalContextBase

java.lang.Object

org.apache.velocity.context.InternalContextBase

All Implemented Interfaces:

InternalEventContext, InternalHousekeepingContext

Direct Known Subclasses:

AbstractContext

class InternalContextBase
extends Object
implements InternalHousekeepingContext, InternalEventContext

class to encapsulate the 'stuff' for internal operation of velocity. We use the context as a thread-safe storage : we take advantage of the fact that it's a visitor of sorts to all nodes (that matter) of the AST during init() and render(). Currently, it carries the template name for namespace support, as well as node-local context data introspection caching. Note that this is not a public class. It is for package access only to keep application code from accessing the internals, as AbstractContext is derived from this.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
private Resource	currentResource	Current resource - used for carrying encoding and other information down into the rendering process
private EventCartridge	eventCartridge	EventCartridge we are to carry.
private Map<Object,IntrospectionCacheData>	introspectionCache	cache for node/context specific introspection information
private List<Template>	macroLibraries	List for holding the macro libraries.
private Stack<String>	macroNameStack	Velocimacro name stack.
private static final long	serialVersionUID	Version Id for serializable
private Stack<String>	templateNameStack	Template name stack.

Constructor Summary

Constructors

Constructor	Description
InternalContextBase()

Method Summary

Modifier and Type	Method	Description
EventCartridge	attachEventCartridge(EventCartridge ec)
int	getCurrentMacroCallDepth()	get the current macro call depth
String	getCurrentMacroName()	get the current macro name
Resource	getCurrentResource()	temporary fix to enable #include() to figure out current encoding.
String	getCurrentTemplateName()	get the current template name
EventCartridge	getEventCartridge()
List<Template>	getMacroLibraries()	Get the macro library list for the current template.
String[]	getMacroNameStack()	get the current macro name stack
String[]	getTemplateNameStack()	get the current template name stack
IntrospectionCacheData	icacheGet(Object key)	returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the key
void	icachePut(Object key, IntrospectionCacheData o)	places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified key
void	popCurrentMacroName()	remove the current macro name from stack
void	popCurrentTemplateName()	remove the current template name from stack
void	pushCurrentMacroName(String s)	set the current macro name on top of stack
void	pushCurrentTemplateName(String s)	set the current template name on top of stack
void	setCurrentResource(Resource r)
void	setMacroLibraries(List<Template> macroLibraries)	Set the macro library list for the current template.

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

Version Id for serializable

See Also:

• Constant Field Values

introspectionCache

private Map<Object,IntrospectionCacheData> introspectionCache

cache for node/context specific introspection information

templateNameStack

private Stack<String> templateNameStack

Template name stack. The stack top contains the current template name.

macroNameStack

private Stack<String> macroNameStack

Velocimacro name stack. The stack top contains the current macro name.

eventCartridge

private EventCartridge eventCartridge

EventCartridge we are to carry. Set by application

currentResource

private Resource currentResource

Current resource - used for carrying encoding and other information down into the rendering process

macroLibraries

private List<Template> macroLibraries

List for holding the macro libraries. Contains the macro library template name as strings.

Constructor Details

InternalContextBase

InternalContextBase()

Method Details

pushCurrentTemplateName

public void pushCurrentTemplateName(String s)

set the current template name on top of stack

Specified by:

pushCurrentTemplateName in interface InternalHousekeepingContext

Parameters:

s - current template name

popCurrentTemplateName

public void popCurrentTemplateName()

remove the current template name from stack

Specified by:

popCurrentTemplateName in interface InternalHousekeepingContext

getCurrentTemplateName

public String getCurrentTemplateName()

get the current template name

Specified by:

getCurrentTemplateName in interface InternalHousekeepingContext

Returns:

String current template name

getTemplateNameStack

public String[] getTemplateNameStack()

get the current template name stack

Specified by:

getTemplateNameStack in interface InternalHousekeepingContext

Returns:

String[] with the template name stack contents.

pushCurrentMacroName

public void pushCurrentMacroName(String s)

set the current macro name on top of stack

Specified by:

pushCurrentMacroName in interface InternalHousekeepingContext

Parameters:

s - current macro name

popCurrentMacroName

public void popCurrentMacroName()

remove the current macro name from stack

Specified by:

popCurrentMacroName in interface InternalHousekeepingContext

getCurrentMacroName

public String getCurrentMacroName()

get the current macro name

Specified by:

getCurrentMacroName in interface InternalHousekeepingContext

Returns:

String current macro name

getCurrentMacroCallDepth

public int getCurrentMacroCallDepth()

get the current macro call depth

Specified by:

getCurrentMacroCallDepth in interface InternalHousekeepingContext

Returns:

int current macro call depth

getMacroNameStack

public String[] getMacroNameStack()

get the current macro name stack

Specified by:

getMacroNameStack in interface InternalHousekeepingContext

Returns:

String[] with the macro name stack contents.

icacheGet

public IntrospectionCacheData icacheGet(Object key)

returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the key

Specified by:

icacheGet in interface InternalHousekeepingContext

Parameters:

key - key to find in cache

Returns:

cache object

icachePut

public void icachePut(Object key,
 IntrospectionCacheData o)

places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified key

Specified by:

icachePut in interface InternalHousekeepingContext

Parameters:

key - key

o - IntrospectionCacheData object to place in cache

setCurrentResource

public void setCurrentResource(Resource r)

Specified by:

setCurrentResource in interface InternalHousekeepingContext

Parameters:

r -

See Also:

• InternalHousekeepingContext.setCurrentResource(org.apache.velocity.runtime.resource.Resource)

getCurrentResource

public Resource getCurrentResource()

Description copied from interface: InternalHousekeepingContext

temporary fix to enable #include() to figure out current encoding.

Specified by:

getCurrentResource in interface InternalHousekeepingContext

Returns:

The current resource.

See Also:

• InternalHousekeepingContext.getCurrentResource()

setMacroLibraries

public void setMacroLibraries(List<Template> macroLibraries)

Description copied from interface: InternalHousekeepingContext

Set the macro library list for the current template.

Specified by:

setMacroLibraries in interface InternalHousekeepingContext

Parameters:

macroLibraries - list of macro libraries to set

See Also:

• InternalHousekeepingContext.setMacroLibraries(List)

getMacroLibraries

public List<Template> getMacroLibraries()

Description copied from interface: InternalHousekeepingContext

Get the macro library list for the current template.

Specified by:

getMacroLibraries in interface InternalHousekeepingContext

Returns:

List of macro library names

See Also:

• InternalHousekeepingContext.getMacroLibraries()

attachEventCartridge

public EventCartridge attachEventCartridge(EventCartridge ec)

Specified by:

attachEventCartridge in interface InternalEventContext

Parameters:

ec -

Returns:

The old EventCartridge.

See Also:

• InternalEventContext.attachEventCartridge(org.apache.velocity.app.event.EventCartridge)

getEventCartridge

public EventCartridge getEventCartridge()

Specified by:

getEventCartridge in interface InternalEventContext

Returns:

The current EventCartridge.

See Also:

• InternalEventContext.getEventCartridge()