org.apache.velocity
Class VelocityContext
- Cloneable, Context, Serializable, InternalEventContext, InternalHousekeepingContext, Serializable
public class VelocityContext
implements 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
$Id: VelocityContext.java,v 1.6.8.1 2004/03/03 22:27:36 geirm Exp $private Map | context - Storage for key/value pairs.
|
VelocityContext() - Creates a new instance (with no inner context).
|
VelocityContext(Map context) - Creates a new instance with the provided storage (and no inner
context).
|
VelocityContext(Map context, Context innerContext) - Initializes internal storage (never to
null ), and
inner context.
|
VelocityContext(Context innerContext) - Chaining constructor, used when you want to
wrap a context in another.
|
Object | clone() - Clones this context object.
|
boolean | internalContainsKey(Object key) - determines if there is a value for the
given key
|
Object | internalGet(String key) - retrieves value for key from internal
storage
|
Object[] | internalGetKeys() - returns array of keys
|
Object | internalPut(String key, Object value) - stores the value for key to internal
storage
|
Object | internalRemove(Object key) - remove a key/value pair from the
internal storage
|
containsKey , get , getChainedContext , getKeys , internalContainsKey , internalGet , internalGetKeys , internalPut , internalRemove , put , remove |
context
private Map context
Storage for key/value pairs.
VelocityContext
public VelocityContext()
Creates a new instance (with no inner context).
VelocityContext
public VelocityContext(Map context)
Creates a new instance with the provided storage (and no inner
context).
VelocityContext
public VelocityContext(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.
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.
clone
public Object clone()
Clones this context object.
- A deep copy of this
Context
.
internalContainsKey
public boolean internalContainsKey(Object key)
determines if there is a value for the
given key
- internalContainsKey in interface AbstractContext
key
- name of value to check
- true if non-null value in store
internalGet
public Object internalGet(String key)
retrieves value for key from internal
storage
- internalGet in interface AbstractContext
key
- name of value to get
internalPut
public Object internalPut(String key,
Object value)
stores the value for key to internal
storage
- internalPut in interface AbstractContext
key
- name of value to storevalue
- value to store
- previous value of key as Object
internalRemove
public Object internalRemove(Object key)
remove a key/value pair from the
internal storage
- internalRemove in interface AbstractContext
key
- name of value to remove
Copyright B) 2002 Apache Software Foundation. All Rights Reserved.