InternalContextAdapterImpl (bboss-velocity 6.1.5 API)

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

所有已实现的接口:

Context, InternalContextAdapter, InternalEventContext, InternalWrapperContext
```
public final class InternalContextAdapterImpl
extends java.lang.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.

构造器概要

构造器
构造器和说明

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

构造器
构造器和说明
`InternalContextAdapterImpl(Context c)` CTOR takes a Context and wraps it, delegating all 'data' calls to it.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.
`InternalContextAdapter`	`getBaseContext()` Returns the base context that we are wrapping.
`int`	`getCurrentMacroCallDepth()` get the current macro call depth
`java.lang.String`	`getCurrentMacroName()` get the current macro name
`Resource`	`getCurrentResource()` temporary fix to enable #include() to figure out current encoding.
`java.lang.String`	`getCurrentTemplateName()` get the current template name
`EventCartridge`	`getEventCartridge()`
`Context`	`getInternalUserContext()` returns the user data context that we are wrapping
`java.lang.Object[]`	`getKeys()` Get all the keys for the values in the context.
`java.util.List`	`getMacroLibraries()` Get the macro library list for the current template.
`java.lang.Object[]`	`getMacroNameStack()` Returns the macro name stack in form of an array.
`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
`java.lang.Object`	`localPut(java.lang.String key, java.lang.Object value)` Allows callers to explicitly put objects in the local context.
`void`	`popCurrentMacroName()` remove the current macro name from stack
`void`	`popCurrentTemplateName()` remove the current template name from stack
`void`	`pushCurrentMacroName(java.lang.String s)` set the current macro name on top of stack
`void`	`pushCurrentTemplateName(java.lang.String s)` set the current template name on top of stack
`java.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)` Set the macro library list for the current template.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - 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.
    
    参数:
    
    c -
- 方法详细资料
  - pushCurrentTemplateName
```
public void pushCurrentTemplateName(java.lang.String s)
```
    set the current template name on top of stack
    
    参数:
    
    s - current template name
    
    另请参阅:
    
    InternalHousekeepingContext.pushCurrentTemplateName(java.lang.String)
  - popCurrentTemplateName
```
public void popCurrentTemplateName()
```
    remove the current template name from stack
    
    另请参阅:
    
    InternalHousekeepingContext.popCurrentTemplateName()
  - getCurrentTemplateName
```
public java.lang.String getCurrentTemplateName()
```
    get the current template name
    
    返回:
    
    String current template name
    
    另请参阅:
    
    InternalHousekeepingContext.getCurrentTemplateName()
  - getTemplateNameStack
```
public java.lang.Object[] getTemplateNameStack()
```
    Returns the template name stack in form of an array.
    
    返回:
    
    Object[] with the template name stack contents.
    
    另请参阅:
    
    InternalHousekeepingContext.getTemplateNameStack()
  - pushCurrentMacroName
```
public void pushCurrentMacroName(java.lang.String s)
```
    set the current macro name on top of stack
    
    参数:
    
    s - current macro name
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.pushCurrentMacroName(java.lang.String)
  - popCurrentMacroName
```
public void popCurrentMacroName()
```
    remove the current macro name from stack
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.popCurrentMacroName()
  - getCurrentMacroName
```
public java.lang.String getCurrentMacroName()
```
    get the current macro name
    
    返回:
    
    String current macro name
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.getCurrentMacroName()
  - getCurrentMacroCallDepth
```
public int getCurrentMacroCallDepth()
```
    get the current macro call depth
    
    返回:
    
    int current macro call depth
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.getCurrentMacroCallDepth()
  - getMacroNameStack
```
public java.lang.Object[] getMacroNameStack()
```
    Returns the macro name stack in form of an array.
    
    返回:
    
    Object[] with the macro name stack contents.
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.getMacroNameStack()
  - icacheGet
```
public IntrospectionCacheData icacheGet(java.lang.Object key)
```
    returns an IntrospectionCache Data (@see IntrospectionCacheData) object if exists for the key
    
    参数:
    
    key - key to find in cache
    
    返回:
    
    cache object
    
    另请参阅:
    
    InternalHousekeepingContext.icacheGet(java.lang.Object)
  - icachePut
```
public void icachePut(java.lang.Object key,
                      IntrospectionCacheData o)
```
    places an IntrospectionCache Data (@see IntrospectionCacheData) element in the cache for specified key
    
    参数:
    
    key - key
    
    o - IntrospectionCacheData object to place in cache
    
    另请参阅:
    
    InternalHousekeepingContext.icachePut(java.lang.Object, bboss.org.apache.velocity.util.introspection.IntrospectionCacheData)
  - setCurrentResource
```
public void setCurrentResource(Resource r)
```
    另请参阅:
    
    InternalHousekeepingContext.setCurrentResource(bboss.org.apache.velocity.runtime.resource.Resource)
  - getCurrentResource
```
public Resource getCurrentResource()
```
    temporary fix to enable #include() to figure out current encoding.
    
    返回:
    
    The current resource.
    
    另请参阅:
    
    InternalHousekeepingContext.getCurrentResource()
  - setMacroLibraries
```
public void setMacroLibraries(java.util.List macroLibraries)
```
    Set the macro library list for the current template.
    
    参数:
    
    macroLibraries - list of macro libraries to set
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.setMacroLibraries(List)
  - getMacroLibraries
```
public java.util.List getMacroLibraries()
```
    Get the macro library list for the current template.
    
    返回:
    
    List of macro library names
    
    从以下版本开始:
    
    1.6
    
    另请参阅:
    
    InternalHousekeepingContext.getMacroLibraries()
  - put
```
public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
```
    从接口复制的说明: Context
    
    Adds a name/value pair to the context.
    
    指定者:
    
    put 在接口中 Context
    
    参数:
    
    key - The name to key the provided value with.
    
    value - The corresponding value.
    
    返回:
    
    The old object or null if there was no old object.
    
    另请参阅:
    
    Context.put(java.lang.String, java.lang.Object)
  - localPut
```
public java.lang.Object localPut(java.lang.String key,
                                 java.lang.Object value)
```
    从接口复制的说明: 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.
    
    指定者:
    
    localPut 在接口中 InternalWrapperContext
    
    参数:
    
    key - name of item to set.
    
    value - object to set to key.
    
    返回:
    
    old stored object
    
    从以下版本开始:
    
    1.5
    
    另请参阅:
    
    InternalWrapperContext.localPut(String, Object)
  - get
```
public java.lang.Object get(java.lang.String key)
```
    从接口复制的说明: Context
    
    Gets the value corresponding to the provided key from the context.
    
    指定者:
    
    get 在接口中 Context
    
    参数:
    
    key - The name of the desired value.
    
    返回:
    
    The value corresponding to the provided key.
    
    另请参阅:
    
    Context.get(java.lang.String)
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    从接口复制的说明: Context
    
    Indicates whether the specified key is in the context.
    
    指定者:
    
    containsKey 在接口中 Context
    
    参数:
    
    key - The key to look for.
    
    返回:
    
    Whether the key is in the context.
    
    另请参阅:
    
    Context.containsKey(java.lang.Object)
  - getKeys
```
public java.lang.Object[] getKeys()
```
    从接口复制的说明: Context
    
    Get all the keys for the values in the context.
    
    指定者:
    
    getKeys 在接口中 Context
    
    返回:
    
    All the keys for the values in the context.
    
    另请参阅:
    
    Context.getKeys()
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    从接口复制的说明: Context
    
    Removes the value associated with the specified key from the context.
    
    指定者:
    
    remove 在接口中 Context
    
    参数:
    
    key - The name of the value to remove.
    
    返回:
    
    The value that the key was mapped to, or null if unmapped.
    
    另请参阅:
    
    Context.remove(java.lang.Object)
  - getInternalUserContext
```
public Context getInternalUserContext()
```
    returns the user data context that we are wrapping
    
    指定者:
    
    getInternalUserContext 在接口中 InternalWrapperContext
    
    返回:
    
    The internal user data context.
  - getBaseContext
```
public InternalContextAdapter 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
    
    指定者:
    
    getBaseContext 在接口中 InternalWrapperContext
    
    返回:
    
    The base context.
  - attachEventCartridge
```
public EventCartridge attachEventCartridge(EventCartridge ec)
```
    指定者:
    
    attachEventCartridge 在接口中 InternalEventContext
    
    返回:
    
    The old EventCartridge.
    
    另请参阅:
    
    InternalEventContext.attachEventCartridge(bboss.org.apache.velocity.app.event.EventCartridge)
  - getEventCartridge
```
public EventCartridge getEventCartridge()
```
    指定者:
    
    getEventCartridge 在接口中 InternalEventContext
    
    返回:
    
    The current EventCartridge.
    
    另请参阅:
    
    InternalEventContext.getEventCartridge()

类 InternalContextAdapterImpl

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

InternalContextAdapterImpl

方法详细资料

pushCurrentTemplateName

popCurrentTemplateName

getCurrentTemplateName

getTemplateNameStack

pushCurrentMacroName

popCurrentMacroName

getCurrentMacroName

getCurrentMacroCallDepth

getMacroNameStack

icacheGet

icachePut

setCurrentResource

getCurrentResource

setMacroLibraries

getMacroLibraries

put

localPut

get

containsKey

getKeys

remove

getInternalUserContext

getBaseContext

attachEventCartridge

getEventCartridge