Package org.apache.velocity.context
Class InternalContextAdapterImpl
java.lang.Object
org.apache.velocity.context.InternalContextAdapterImpl
- All Implemented Interfaces:
Context
,InternalContextAdapter
,InternalEventContext
,InternalHousekeepingContext
,InternalWrapperContext
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.
- Version:
- $Id: InternalContextAdapterImpl.java 731266 2009-01-04 15:11:20Z byron $
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) Context
the user data Context that we are wrapping(package private) InternalHousekeepingContext
the ICB we are wrapping.(package private) InternalEventContext
The InternalEventContext that we are wrapping. -
Constructor Summary
ConstructorsConstructorDescriptionCTOR takes a Context and wraps it, delegating all 'data' calls to it. -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsKey
(Object key) Indicates whether the specified key is in the context.Gets the value corresponding to the provided key from the context.Returns the base context that we are wrapping.int
get the current macro call depthget the current macro nametemporary fix to enable #include() to figure out current encoding.get the current template namereturns the user data context that we are wrappingObject[]
getKeys()
Get all the keys for the values in the context.Get the macro library list for the current template.Object[]
Returns the macro name stack in form of an array.Object[]
Returns the template name stack in form of an array.returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the keyvoid
icachePut
(Object key, IntrospectionCacheData o) places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified keyAllows callers to explicitly put objects in the local context.void
remove the current macro name from stackvoid
remove the current template name from stackvoid
set the current macro name on top of stackvoid
set the current template name on top of stackAdds a name/value pair to the context.Removes the value associated with the specified key from the context.void
void
setMacroLibraries
(List macroLibraries) Set the macro library list for the current template.
-
Field Details
-
context
Context contextthe user data Context that we are wrapping -
icb
the ICB we are wrapping. We may need to make one if the user data context implementation doesn't support one. The default AbstractContext-derived VelocityContext does, and it's recommended that people derive new contexts from AbstractContext rather than piecing things together -
iec
The InternalEventContext that we are wrapping. If the context passed to us doesn't support it, no biggie. We don't make it for them - since its a user context thing, nothing gained by making one for them now
-
-
Constructor Details
-
InternalContextAdapterImpl
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.- Parameters:
c
-
-
-
Method Details
-
pushCurrentTemplateName
Description copied from interface:InternalHousekeepingContext
set the current template name on top of stack- Specified by:
pushCurrentTemplateName
in interfaceInternalHousekeepingContext
- Parameters:
s
- current template name- See Also:
-
popCurrentTemplateName
public void popCurrentTemplateName()Description copied from interface:InternalHousekeepingContext
remove the current template name from stack- Specified by:
popCurrentTemplateName
in interfaceInternalHousekeepingContext
- See Also:
-
getCurrentTemplateName
Description copied from interface:InternalHousekeepingContext
get the current template name- Specified by:
getCurrentTemplateName
in interfaceInternalHousekeepingContext
- Returns:
- String current template name
- See Also:
-
getTemplateNameStack
Description copied from interface:InternalHousekeepingContext
Returns the template name stack in form of an array.- Specified by:
getTemplateNameStack
in interfaceInternalHousekeepingContext
- Returns:
- Object[] with the template name stack contents.
- See Also:
-
pushCurrentMacroName
Description copied from interface:InternalHousekeepingContext
set the current macro name on top of stack- Specified by:
pushCurrentMacroName
in interfaceInternalHousekeepingContext
- Parameters:
s
- current macro name- Since:
- 1.6
- See Also:
-
popCurrentMacroName
public void popCurrentMacroName()Description copied from interface:InternalHousekeepingContext
remove the current macro name from stack- Specified by:
popCurrentMacroName
in interfaceInternalHousekeepingContext
- Since:
- 1.6
- See Also:
-
getCurrentMacroName
Description copied from interface:InternalHousekeepingContext
get the current macro name- Specified by:
getCurrentMacroName
in interfaceInternalHousekeepingContext
- Returns:
- String current macro name
- Since:
- 1.6
- See Also:
-
getCurrentMacroCallDepth
public int getCurrentMacroCallDepth()Description copied from interface:InternalHousekeepingContext
get the current macro call depth- Specified by:
getCurrentMacroCallDepth
in interfaceInternalHousekeepingContext
- Returns:
- int current macro call depth
- Since:
- 1.6
- See Also:
-
getMacroNameStack
Description copied from interface:InternalHousekeepingContext
Returns the macro name stack in form of an array.- Specified by:
getMacroNameStack
in interfaceInternalHousekeepingContext
- Returns:
- Object[] with the macro name stack contents.
- Since:
- 1.6
- See Also:
-
icacheGet
Description copied from interface:InternalHousekeepingContext
returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the key- Specified by:
icacheGet
in interfaceInternalHousekeepingContext
- Parameters:
key
- key to find in cache- Returns:
- cache object
- See Also:
-
icachePut
Description copied from interface:InternalHousekeepingContext
places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified key- Specified by:
icachePut
in interfaceInternalHousekeepingContext
- Parameters:
key
- keyo
- IntrospectionCacheData object to place in cache- See Also:
-
setCurrentResource
- Specified by:
setCurrentResource
in interfaceInternalHousekeepingContext
- See Also:
-
getCurrentResource
Description copied from interface:InternalHousekeepingContext
temporary fix to enable #include() to figure out current encoding.- Specified by:
getCurrentResource
in interfaceInternalHousekeepingContext
- Returns:
- The current resource.
- See Also:
-
setMacroLibraries
Description copied from interface:InternalHousekeepingContext
Set the macro library list for the current template.- Specified by:
setMacroLibraries
in interfaceInternalHousekeepingContext
- Parameters:
macroLibraries
- list of macro libraries to set- Since:
- 1.6
- See Also:
-
getMacroLibraries
Description copied from interface:InternalHousekeepingContext
Get the macro library list for the current template.- Specified by:
getMacroLibraries
in interfaceInternalHousekeepingContext
- Returns:
- List of macro library names
- Since:
- 1.6
- See Also:
-
put
Description copied from interface:Context
Adds a name/value pair to the context. -
localPut
Description copied from interface:InternalWrapperContext
Allows callers to explicitly put objects in the local context. Objects added to the context through this method always end up in the top-level context of possible wrapped contexts.- Specified by:
localPut
in interfaceInternalWrapperContext
- Parameters:
key
- name of item to set.value
- object to set to key.- Returns:
- old stored object
- Since:
- 1.5
- See Also:
-
get
Description copied from interface:Context
Gets the value corresponding to the provided key from the context. -
containsKey
Description copied from interface:Context
Indicates whether the specified key is in the context.- Specified by:
containsKey
in interfaceContext
- Parameters:
key
- The key to look for.- Returns:
- Whether the key is in the context.
- See Also:
-
getKeys
Description copied from interface:Context
Get all the keys for the values in the context. -
remove
Description copied from interface:Context
Removes the value associated with the specified key from the context. -
getInternalUserContext
returns the user data context that we are wrapping- Specified by:
getInternalUserContext
in interfaceInternalWrapperContext
- Returns:
- The internal user data context.
-
getBaseContext
Returns the base context that we are wrapping. Here, its this, but for other thing like VM related context contortions, it can be something else- Specified by:
getBaseContext
in interfaceInternalWrapperContext
- Returns:
- The base context.
-
attachEventCartridge
- Specified by:
attachEventCartridge
in interfaceInternalEventContext
- Returns:
- The old EventCartridge.
- See Also:
-
getEventCartridge
- Specified by:
getEventCartridge
in interfaceInternalEventContext
- Returns:
- The current EventCartridge.
- See Also:
-