VelocityContext (bboss-velocity 6.1.5 API)

java.lang.Object
- bboss.org.apache.velocity.context.AbstractContext
- - bboss.org.apache.velocity.VelocityContext

所有已实现的接口:

Context, InternalEventContext, java.lang.Cloneable
```
public class VelocityContext
extends AbstractContext
implements java.lang.Cloneable
```
General purpose implemention of the application Context interface for general application use. This class should be used in place of the original Context class. This implementation uses a HashMap (@see java.util.HashMap ) for data storage. This context implementation cannot be shared between threads without those threads synchronizing access between them, as the HashMap is not synchronized, nor are some of the fundamentals of AbstractContext. If you need to share a Context between threads with simultaneous access for some reason, please create your own and extend the interface Context

另请参阅:

Context

构造器概要

构造器
构造器和说明
`VelocityContext()` Creates a new instance (with no inner context).
`VelocityContext(Context innerContext)` Chaining constructor, used when you want to wrap a context in another.
`VelocityContext(java.util.Map context)` Creates a new instance with the provided storage (and no inner context).
`VelocityContext(java.util.Map context, Context innerContext)` Initializes internal storage (never to `null`), and inner context.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`EventCartridge`	`attachEventCartridge(EventCartridge ec)`
`java.lang.Object`	`clone()` Clones this context object.
`java.util.Map`	`getContext()`
`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()`
`java.util.List`	`getMacroLibraries()` Get the macro library list for the current template.
`java.lang.Object[]`	`getMacroNameStack()` get the current macro name stack
`java.lang.Object[]`	`getTemplateNameStack()` get the current template name stack
`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
`boolean`	`internalContainsKey(java.lang.Object key)` determines if there is a value for the given key
`java.lang.Object`	`internalGet(java.lang.String key)` retrieves value for key from internal storage
`java.lang.Object[]`	`internalGetKeys()` returns array of keys
`java.lang.Object`	`internalPut(java.lang.String key, java.lang.Object value)` stores the value for key to internal storage
`java.lang.Object`	`internalRemove(java.lang.Object key)` remove a key/value pair from the internal storage
`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
`void`	`setCurrentResource(Resource r)`
`void`	`setMacroLibraries(java.util.List macroLibraries)` Set the macro library list for the current template.

从类继承的方法 bboss.org.apache.velocity.context.AbstractContext
containsKey, get, getChainedContext, getKeys, put, remove

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

- 构造器详细资料
  - VelocityContext
```
public VelocityContext()
```
    Creates a new instance (with no inner context).
  - VelocityContext
```
public VelocityContext(java.util.Map context)
```
    Creates a new instance with the provided storage (and no inner context).
    
    参数:
    
    context -
  - VelocityContext
```
public VelocityContext(Context innerContext)
```
    Chaining constructor, used when you want to wrap a context in another. The inner context will be 'read only' - put() calls to the wrapping context will only effect the outermost context
    
    参数:
    
    innerContext - The Context implementation to wrap.
  - VelocityContext
```
public VelocityContext(java.util.Map context,
                       Context innerContext)
```
    Initializes internal storage (never to null), and inner context.
    
    参数:
    
    context - Internal storage, or null to create default storage.
    
    innerContext - Inner context.
- 方法详细资料
  - internalGet
```
public java.lang.Object internalGet(java.lang.String key)
```
    retrieves value for key from internal storage
    
    指定者:
    
    internalGet 在类中 AbstractContext
    
    参数:
    
    key - name of value to get
    
    返回:
    
    value as object
  - internalPut
```
public java.lang.Object internalPut(java.lang.String key,
                                    java.lang.Object value)
```
    stores the value for key to internal storage
    
    指定者:
    
    internalPut 在类中 AbstractContext
    
    参数:
    
    key - name of value to store
    
    value - value to store
    
    返回:
    
    previous value of key as Object
  - internalContainsKey
```
public boolean internalContainsKey(java.lang.Object key)
```
    determines if there is a value for the given key
    
    指定者:
    
    internalContainsKey 在类中 AbstractContext
    
    参数:
    
    key - name of value to check
    
    返回:
    
    true if non-null value in store
  - internalGetKeys
```
public java.lang.Object[] internalGetKeys()
```
    returns array of keys
    
    指定者:
    
    internalGetKeys 在类中 AbstractContext
    
    返回:
    
    keys as []
  - internalRemove
```
public java.lang.Object internalRemove(java.lang.Object key)
```
    remove a key/value pair from the internal storage
    
    指定者:
    
    internalRemove 在类中 AbstractContext
    
    参数:
    
    key - name of value to remove
    
    返回:
    
    value removed
  - clone
```
public java.lang.Object clone()
```
    Clones this context object.
    
    覆盖:
    
    clone 在类中 java.lang.Object
    
    返回:
    
    A deep copy of this Context.
  - getContext
```
public java.util.Map getContext()
```
  - pushCurrentTemplateName
```
public void pushCurrentTemplateName(java.lang.String s)
```
    set the current template name on top of stack
    
    参数:
    
    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
    
    返回:
    
    String current template name
  - getTemplateNameStack
```
public java.lang.Object[] getTemplateNameStack()
```
    get the current template name stack
    
    返回:
    
    Object[] with the template name stack contents.
  - pushCurrentMacroName
```
public void pushCurrentMacroName(java.lang.String s)
```
    set the current macro name on top of stack
    
    参数:
    
    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
    
    返回:
    
    String current macro name
  - getCurrentMacroCallDepth
```
public int getCurrentMacroCallDepth()
```
    get the current macro call depth
    
    返回:
    
    int current macro call depth
  - getMacroNameStack
```
public java.lang.Object[] getMacroNameStack()
```
    get the current macro name stack
    
    返回:
    
    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
    
    参数:
    
    key - key to find in cache
    
    返回:
    
    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
    
    参数:
    
    key - key
    
    o - IntrospectionCacheData object to place in cache
  - 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
    
    另请参阅:
    
    InternalHousekeepingContext.setMacroLibraries(List)
  - getMacroLibraries
```
public java.util.List getMacroLibraries()
```
    Get the macro library list for the current template.
    
    返回:
    
    List of macro library names
    
    另请参阅:
    
    InternalHousekeepingContext.getMacroLibraries()
  - 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()

类 VelocityContext

构造器概要

方法概要

从类继承的方法 bboss.org.apache.velocity.context.AbstractContext

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

构造器详细资料

VelocityContext

VelocityContext

VelocityContext

VelocityContext

方法详细资料

internalGet

internalPut

internalContainsKey

internalGetKeys

internalRemove

clone

getContext

pushCurrentTemplateName

popCurrentTemplateName

getCurrentTemplateName

getTemplateNameStack

pushCurrentMacroName

popCurrentMacroName

getCurrentMacroName

getCurrentMacroCallDepth

getMacroNameStack

icacheGet

icachePut

setCurrentResource

getCurrentResource

setMacroLibraries

getMacroLibraries

attachEventCartridge

getEventCartridge