InternalContextAdapter (Velocity 1.4 API)
Keywords: org.apache.velocity.context.InternalContextAdapter interface

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
Interface InternalContextAdapter

All Superinterfaces:
  Context, InternalEventContext, InternalHousekeepingContext, InternalWrapperContext

All Known Implementing Classes:
  InternalContextAdapterImpl, VMContext

public interface InternalContextAdapter
extends InternalHousekeepingContext, Context, InternalWrapperContext, InternalEventContext

interface to bring all necessary internal and user contexts together. this is what the AST expects to deal with. If anything new comes along, add it here. I will rename soon :)

Version:
  $Id: InternalContextAdapter.java,v 1.5.4.1 2004/03/03 23:22:54 geirm Exp $
Author:
  Geir Magnusson Jr.

Method Summary
`Resource` | `getCurrentResource()` temporary fix to enable #include() to figure out current encoding.
`java.lang.String` | `getCurrentTemplateName()` get the current template name
`java.lang.Object[]` | `getTemplateNameStack()` Returns the template name stack in form of an array.
`IntrospectionCacheData` | `icacheGet(java.lang.Object key)` returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the key
`void` | `icachePut(java.lang.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(java.lang.String s)` set the current template name on top of stack
`void` | `setCurrentResource(Resource r)`

Methods inherited from interface org.apache.velocity.context.Context
`containsKey, get, getKeys, put, remove`

Methods inherited from interface org.apache.velocity.context.InternalWrapperContext
`getBaseContext, getInternalUserContext`

Methods inherited from interface org.apache.velocity.context.InternalEventContext
`attachEventCartridge, getEventCartridge`

Method Detail

### 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()

  Returns the template name stack in form of an array.

  Returns:
    Object[] with the template 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` - key
    `o` - IntrospectionCacheData object to place in cache

### getCurrentResource

    public Resource getCurrentResource()

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

### setCurrentResource

    public void setCurrentResource(Resource r)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 Apache Software Foundation. All Rights Reserved.