InternalContextAdapterImpl (Velocity 1.5-dev API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.velocity.context
Class InternalContextAdapterImpl

java.lang.Object
  org.apache.velocity.context.InternalContextAdapterImpl

All Implemented Interfaces:: Context, InternalContextAdapter, InternalEventContext, InternalWrapperContext

public final class InternalContextAdapterImpl
extends Object
implements InternalContextAdapter
extends Object
implements InternalContextAdapter

This adapter class is the container for all context types for internal use. The AST now uses this class rather than the app-level Context interface to allow flexibility in the future. Currently, we have two context interfaces which must be supported :

Context : used for application/template data access
InternalHousekeepingContext : used for internal housekeeping and caching
InternalWrapperContext : used for getting root cache context and other such.
InternalEventContext : for event handling.

This class implements the two interfaces to ensure that all methods are supported. When adding to the interfaces, or adding more context functionality, the interface is the primary definition, so alter that first and then all classes as necessary. As of this writing, this would be the only class affected by changes to InternalContext This class ensures that an InternalContextBase is available for internal use. If an application constructs their own Context-implementing object w/o subclassing AbstractContext, it may be that support for InternalContext is not available. Therefore, InternalContextAdapter will create an InternalContextBase if necessary for this support. Note that if this is necessary, internal information such as node-cache data will be lost from use to use of the context. This may or may not be important, depending upon application.

Version:: $Id: InternalContextAdapterImpl.java 151591 2005-02-06 15:42:19Z wglass $
Author:: Geir Magnusson Jr.

Constructor Summary
`InternalContextAdapterImpl(Context c)` CTOR takes a Context and wraps it, delegating all 'data' calls to it.

Method Summary
`EventCartridge`	`attachEventCartridge(EventCartridge ec)`
`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.
`boolean`	`getAllowRendering()` Checks to see if rendering should be allowed.
`InternalContextAdapter`	`getBaseContext()` Returns the base context that we are wrapping.
`Resource`	`getCurrentResource()` temporary fix to enable #include() to figure out current encoding.
`String`	`getCurrentTemplateName()` get the current template name
`EventCartridge`	`getEventCartridge()`
`Context`	`getInternalUserContext()` returns the user data context that we are wrapping
`Object[]`	`getKeys()` Get all the keys for the values in the context
`Object[]`	`getTemplateNameStack()` Returns the template name stack in form of an array.
`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`	`popCurrentTemplateName()` remove the current template name from stack
`void`	`pushCurrentTemplateName(String s)` set the current template name on top of stack
`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.
`void`	`setAllowRendering(boolean v)` Set whether rendering is allowed.
`void`	`setCurrentResource(Resource r)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

InternalContextAdapterImpl

public InternalContextAdapterImpl(Context c)

CTOR takes a Context and wraps it, delegating all 'data' calls to it. For support of internal contexts, it will create an InternalContextBase if need be.

Method Detail

pushCurrentTemplateName

public void pushCurrentTemplateName(String s)

set the current template name on top of stack

Parameters:: s - current template name

popCurrentTemplateName

public void popCurrentTemplateName()

remove the current template name from stack

getCurrentTemplateName

public String getCurrentTemplateName()

get the current template name

Returns:: String current template name

getTemplateNameStack

public Object[] getTemplateNameStack()

Returns the template name stack in form of an array.

Returns:: Object[] with the template name stack contents.

icacheGet

public IntrospectionCacheData icacheGet(Object key)

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

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

Parameters:: key - key; o - IntrospectionCacheData object to place in cache

setCurrentResource

public void setCurrentResource(Resource r)

getCurrentResource

public Resource getCurrentResource()

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

getAllowRendering

public boolean getAllowRendering()

Checks to see if rendering should be allowed. Defaults to true but will return false after a #stop directive.

Returns:: true if rendering is allowed, false if no rendering should occur

setAllowRendering

public void setAllowRendering(boolean v)

Set whether rendering is allowed. Defaults to true but is set to false after a #stop directive.