Package org.apache.velocity.context

Class ChainedInternalContextAdapter

java.lang.Object
org.apache.velocity.context.ChainedInternalContextAdapter
All Implemented Interfaces:
Context, InternalContextAdapter, InternalEventContext, InternalWrapperContext
Direct Known Subclasses:
EvaluateContext, Foreach.NullHolderContext, ProxyVMContext
public abstract class ChainedInternalContextAdapter extends Object implements InternalContextAdapter
This is an abstract internal-use-only context implementation to be used as a subclass for other internal-use-only contexts that wrap other internal-use-only contexts. We use this context to make it easier to chain an existing context as part of a new context implementation. It just delegates everything to the inner/parent context. Subclasses then only need to override the methods relevant to them.
Since:
1.6
Version:
$Id: ChainedInternalContextAdapter.java 685724 2008-08-13 23:12:12Z nbubna $
Author:
Nathan Bubna

  • Field Details

  • Constructor Details

    • ChainedInternalContextAdapter

      public ChainedInternalContextAdapter(InternalContextAdapter inner)
      CTOR, wraps an ICA
      Parameters:
      inner - context

  • Method Details

    • getInternalUserContext

      public Context getInternalUserContext()
      Return the inner / user context.
      Specified by:
      getInternalUserContext in interface InternalWrapperContext
      Returns:
      The inner / user context.

    • getBaseContext

      public InternalContextAdapter getBaseContext()
      Description copied from interface: InternalWrapperContext
      Returns the base full context impl.
      Specified by:
      getBaseContext in interface InternalWrapperContext
      Returns:
      The base full context impl.
      See Also:

    • get

      public Object get(String key)
      Retrieves from parent context.
      Specified by:
      get in interface Context
      Parameters:
      key - name of item to get
      Returns:
      stored object or null

    • put

      public Object put(String key, Object value)
      Put method also stores values in parent context
      Specified by:
      put in interface Context
      Parameters:
      key - name of item to set
      value - object to set to key
      Returns:
      old stored object

    • containsKey

      public boolean containsKey(Object key)
      Description copied from interface: Context
      Indicates whether the specified key is in the context.
      Specified by:
      containsKey in interface Context
      Parameters:
      key - The key to look for.
      Returns:
      Whether the key is in the context.
      See Also:

    • getKeys

      public Object[] getKeys()
      Description copied from interface: Context
      Get all the keys for the values in the context.
      Specified by:
      getKeys in interface Context
      Returns:
      All the keys for the values in the context.
      See Also:

    • remove

      public Object remove(Object key)
      Description copied from interface: Context
      Removes the value associated with the specified key from the context.
      Specified by:
      remove in interface Context
      Parameters:
      key - The name of the value to remove.
      Returns:
      The value that the key was mapped to, or null if unmapped.
      See Also:

    • pushCurrentTemplateName

      public void pushCurrentTemplateName(String s)
      See Also:
      • InternalHousekeepingContext.pushCurrentTemplateName(java.lang.String)

    • popCurrentTemplateName

      public void popCurrentTemplateName()
      See Also:
      • InternalHousekeepingContext.popCurrentTemplateName()

    • getCurrentTemplateName

      public String getCurrentTemplateName()
      See Also:
      • InternalHousekeepingContext.getCurrentTemplateName()

    • getTemplateNameStack

      public Object[] getTemplateNameStack()
      See Also:
      • InternalHousekeepingContext.getTemplateNameStack()

    • pushCurrentMacroName

      public void pushCurrentMacroName(String s)
      See Also:
      • InternalHousekeepingContext.pushCurrentMacroName(java.lang.String)

    • popCurrentMacroName

      public void popCurrentMacroName()
      See Also:
      • InternalHousekeepingContext.popCurrentMacroName()

    • getCurrentMacroName

      public String getCurrentMacroName()
      See Also:
      • InternalHousekeepingContext.getCurrentMacroName()

    • getCurrentMacroCallDepth

      public int getCurrentMacroCallDepth()
      See Also:
      • InternalHousekeepingContext.getCurrentMacroCallDepth()

    • getMacroNameStack

      public Object[] getMacroNameStack()
      See Also:
      • InternalHousekeepingContext.getMacroNameStack()

    • icacheGet

      public IntrospectionCacheData icacheGet(Object key)
      See Also:
      • InternalHousekeepingContext.icacheGet(java.lang.Object)

    • localPut

      public Object localPut(String key, Object value)
      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 interface InternalWrapperContext
      Parameters:
      key - name of item to set.
      value - object to set to key.
      Returns:
      old stored object
      See Also:

    • icachePut

      public void icachePut(Object key, IntrospectionCacheData o)
      See Also:
      • InternalHousekeepingContext.icachePut(java.lang.Object, org.apache.velocity.util.introspection.IntrospectionCacheData)

    • setMacroLibraries

      public void setMacroLibraries(List macroLibraries)
      See Also:
      • InternalHousekeepingContext.setMacroLibraries(List)

    • getMacroLibraries

      public List getMacroLibraries()
      See Also:
      • InternalHousekeepingContext.getMacroLibraries()

    • attachEventCartridge

      public EventCartridge attachEventCartridge(EventCartridge ec)
      Specified by:
      attachEventCartridge in interface InternalEventContext
      Returns:
      The old EventCartridge.
      See Also:

    • getEventCartridge

      public EventCartridge getEventCartridge()
      Specified by:
      getEventCartridge in interface InternalEventContext
      Returns:
      The current EventCartridge.
      See Also:

    • setCurrentResource

      public void setCurrentResource(Resource r)
      See Also:
      • InternalHousekeepingContext.setCurrentResource(org.apache.velocity.runtime.resource.Resource)

    • getCurrentResource

      public Resource getCurrentResource()
      See Also:
      • InternalHousekeepingContext.getCurrentResource()