public interface IDataArea
A DataArea
is a container for Container
attributes. The elements of a DataArea
are similar to
program variables and are scoped to the owning container.
Modifier and Type | Field and Description |
---|---|
static String |
ENGINE
The name of the
DataArea provided at the engine level. |
static String |
ENV
This will set a variable in the environment.
|
static String |
SYSTEM
This will set a variable in the system properties.
|
static String |
TEST
The name of the
DataArea provided for each test script. |
static String |
VIRTUALUSER
The name of the
DataArea provided for each virtual user. |
Modifier and Type | Method and Description |
---|---|
boolean |
containsKey(Object key)
Returns
true if there is a mapping for the specified key. |
boolean |
containsValue(Object value)
Returns
true if there is an entry for this value. |
Object |
get(Object key)
Retrieves an object from the current
DataArea . |
String |
getName()
Returns the name of the specified
DataArea . |
boolean |
isCacheable()
Returns the value of the dataArea's cacheable flag.
|
void |
lock()
Locks the entire
DataArea . |
void |
lock(Object key)
Locks the specified key.
|
Object |
put(Object key,
Object value)
Adds an object to the
DataArea . |
Object |
remove(Object key)
Removes the object with the given key from the
DataArea . |
void |
setCacheable(boolean flag)
Marks the dataArea as cacheable (or not).
|
static final String ENGINE
DataArea
provided at the engine level.static final String VIRTUALUSER
DataArea
provided for each virtual user.static final String TEST
DataArea
provided for each test script.static final String ENV
static final String SYSTEM
Object get(Object key)
DataArea
.
Returns the object value to which the key is currently
mapped or null if there is no mapping for this key.
Note that it is possible for the key to map to a null value.
Use the containsKey
method to distinguish between
these two cases.
key
- ObjectObject
that corresponds to the specified key.Object put(Object key, Object value)
DataArea
.
Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.
key
- Object to associate with value.value
- Object to be associated with key.boolean containsKey(Object key)
true
if there is a mapping for the specified key.key
- Objecttrue
if there is a mapping for the specified key.
false
if there is no mapping for this key.boolean containsValue(Object value)
true
if there is an entry for this value.value
- Objecttrue
if the DataArea
contains the specified value.
false
if this value is not in the DataArea
.String getName()
DataArea
.DataArea
name.Object remove(Object key)
DataArea
.key
- void lock()
DataArea
.
Causes subsequent put() and remove() calls to fail for this key.
void lock(Object key)
Causes subsequent put() and remove() calls to fail for this key.
key
- void setCacheable(boolean flag)
If a dataArea is cacheable then KAction.findDataArea() will only really search for a given dataArea once and will cache the result for future efficiency.<\p>
flag
- boolean isCacheable()
© Copyright IBM Corp. 2013. All rights reserved.