Package org.apache.velocity.context
Class AbstractContext
- java.lang.Object
-
- org.apache.velocity.context.AbstractContext
-
- All Implemented Interfaces:
Context
,InternalEventContext
- Direct Known Subclasses:
VelocityContext
public abstract class AbstractContext extends java.lang.Object implements Context
This class is the abstract base class for all conventional Velocity Context implementations. Simply extend this class and implement the abstract routines that access your preferred storage method. Takes care of context chaining. Also handles / enforces policy on null keys and values :- Null keys and values are accepted and basically dropped.
- If you place an object into the context with a null key, it will be ignored and logged.
- If you try to place a null into the context with any key, it will be dropped and logged.
- Version:
- $Id: AbstractContext.java 732250 2009-01-07 07:37:10Z byron $
- Author:
- Geir Magnusson Jr., Fedor Karpelevitch, Jason van Zyl
-
-
Constructor Summary
Constructors Constructor Description AbstractContext()
default CTORAbstractContext(Context inner)
Chaining constructor accepts a Context argument.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description EventCartridge
attachEventCartridge(EventCartridge ec)
boolean
containsKey(java.lang.Object key)
Indicates whether the specified key is in the context.java.lang.Object
get(java.lang.String key)
Gets the value corresponding to the provided key from the context.Context
getChainedContext()
returns innerContext if one is chainedint
getCurrentMacroCallDepth()
get the current macro call depthjava.lang.String
getCurrentMacroName()
get the current macro nameResource
getCurrentResource()
java.lang.String
getCurrentTemplateName()
get the current template nameEventCartridge
getEventCartridge()
java.lang.Object[]
getKeys()
Get all the keys for the values in the contextjava.util.List
getMacroLibraries()
java.lang.Object[]
getMacroNameStack()
get the current macro name stackjava.lang.Object[]
getTemplateNameStack()
get the current template name stackIntrospectionCacheData
icacheGet(java.lang.Object key)
returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the keyvoid
icachePut(java.lang.Object key, IntrospectionCacheData o)
places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified keyabstract boolean
internalContainsKey(java.lang.Object key)
Implement to determine if a key is in the storage.abstract java.lang.Object
internalGet(java.lang.String key)
Implement to return a value from the context storage.abstract java.lang.Object[]
internalGetKeys()
Implement to return an object array of key strings from your storage.abstract java.lang.Object
internalPut(java.lang.String key, java.lang.Object value)
Implement to put a value into the context storage.abstract java.lang.Object
internalRemove(java.lang.Object key)
I mplement to remove an item from your storage.void
popCurrentMacroName()
remove the current macro name from stackvoid
popCurrentTemplateName()
remove the current template name from stackvoid
pushCurrentMacroName(java.lang.String s)
set the current macro name on top of stackvoid
pushCurrentTemplateName(java.lang.String s)
set the current template name on top of stackjava.lang.Object
put(java.lang.String key, java.lang.Object value)
Adds a name/value pair to the context.java.lang.Object
remove(java.lang.Object key)
Removes the value associated with the specified key from the context.void
setCurrentResource(Resource r)
void
setMacroLibraries(java.util.List macroLibraries)
-
-
-
Constructor Detail
-
AbstractContext
public AbstractContext()
default CTOR
-
AbstractContext
public AbstractContext(Context inner)
Chaining constructor accepts a Context argument. It will relay get() operations into this Context in the even the 'local' get() returns null.- Parameters:
inner
- context to be chained
-
-
Method Detail
-
internalGet
public abstract java.lang.Object internalGet(java.lang.String key)
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.- Parameters:
key
- key whose associated value is to be returned- Returns:
- object stored in the context
-
internalPut
public abstract java.lang.Object internalPut(java.lang.String key, java.lang.Object value)
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.- Parameters:
key
- key with which to associate the valuevalue
- value to be associated with the key- Returns:
- previously stored value if exists, or null
-
internalContainsKey
public abstract boolean internalContainsKey(java.lang.Object key)
Implement to determine if a key is in the storage.
Currently, this method is not used internally by the Velocity engine.- Parameters:
key
- key to test for existance- Returns:
- true if found, false if not
-
internalGetKeys
public abstract java.lang.Object[] internalGetKeys()
Implement to return an object array of key strings from your storage.
Currently, this method is not used internally by the Velocity engine.- Returns:
- array of keys
-
internalRemove
public abstract java.lang.Object internalRemove(java.lang.Object key)
I mplement to remove an item from your storage.
Currently, this method is not used internally by the Velocity engine.- Parameters:
key
- key to remove- Returns:
- object removed if exists, else null
-
put
public java.lang.Object put(java.lang.String key, java.lang.Object value)
Adds a name/value pair to the context.
-
get
public java.lang.Object get(java.lang.String key)
Gets the value corresponding to the provided key from the context. Supports the chaining context mechanism. If the 'local' context doesn't have the value, we try to get it from the chained context.
-
containsKey
public boolean containsKey(java.lang.Object key)
Indicates whether the specified key is in the context. Provided for debugging purposes.- Specified by:
containsKey
in interfaceContext
- Parameters:
key
- The key to look for.- Returns:
- true if the key is in the context, false if not.
-
getKeys
public java.lang.Object[] getKeys()
Get all the keys for the values in the context
-
remove
public java.lang.Object remove(java.lang.Object key)
Removes the value associated with the specified key from the context.
-
getChainedContext
public Context getChainedContext()
returns innerContext if one is chained- Returns:
- Context if chained,
null
if not
-
pushCurrentTemplateName
public void pushCurrentTemplateName(java.lang.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 java.lang.String getCurrentTemplateName()
get the current template name- Returns:
- String current template name
-
getTemplateNameStack
public java.lang.Object[] getTemplateNameStack()
get the current template name stack- Returns:
- Object[] with the template name stack contents.
-
pushCurrentMacroName
public void pushCurrentMacroName(java.lang.String s)
set the current macro name on top of stack- Parameters:
s
- current macro name
-
popCurrentMacroName
public void popCurrentMacroName()
remove the current macro name from stack
-
getCurrentMacroName
public java.lang.String getCurrentMacroName()
get the current macro name- Returns:
- String current macro name
-
getCurrentMacroCallDepth
public int getCurrentMacroCallDepth()
get the current macro call depth- Returns:
- int current macro call depth
-
getMacroNameStack
public java.lang.Object[] getMacroNameStack()
get the current macro name stack- Returns:
- Object[] with the macro name stack contents.
-
icacheGet
public IntrospectionCacheData icacheGet(java.lang.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(java.lang.Object key, IntrospectionCacheData o)
places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified key- Parameters:
key
- keyo
- IntrospectionCacheData object to place in cache
-
setCurrentResource
public void setCurrentResource(Resource r)
- See Also:
InternalHousekeepingContext.setCurrentResource(org.apache.velocity.runtime.resource.Resource)
-
getCurrentResource
public Resource getCurrentResource()
- See Also:
InternalHousekeepingContext.getCurrentResource()
-
setMacroLibraries
public void setMacroLibraries(java.util.List macroLibraries)
- See Also:
InternalHousekeepingContext.setMacroLibraries(List)
-
getMacroLibraries
public java.util.List getMacroLibraries()
- See Also:
InternalHousekeepingContext.getMacroLibraries()
-
attachEventCartridge
public EventCartridge attachEventCartridge(EventCartridge ec)
- Specified by:
attachEventCartridge
in interfaceInternalEventContext
- Returns:
- The old EventCartridge.
- See Also:
InternalEventContext.attachEventCartridge(org.apache.velocity.app.event.EventCartridge)
-
getEventCartridge
public EventCartridge getEventCartridge()
- Specified by:
getEventCartridge
in interfaceInternalEventContext
- Returns:
- The current EventCartridge.
- See Also:
InternalEventContext.getEventCartridge()
-
-