org.apache.xerces.xni
Interface Augmentations
public interface Augmentations
The Augmentations interface defines a table of additional data that may
be passed along the document pipeline. The information can contain extra
arguments or infoset augmentations, for example PSVI. This additional
information is identified by a String key.
Note:
Methods that receive Augmentations are required to copy the information
if it is to be saved for use beyond the scope of the method.
The Augmentations content is volatile, and maybe modified by any method in
any component in the pipeline. Therefore, methods passed this structure
should not save any reference to the structure.
$Id: Augmentations.java 447247 2006-09-18 05:23:52Z mrglavas $ Object | getItem(String key) - Get information identified by a key from the Augmentations structure
|
Enumeration | keys() - Returns an enumeration of the keys in the Augmentations structure
|
Object | putItem(String key, Object item) - Add additional information identified by a key to the Augmentations structure.
|
void | removeAllItems() - Remove all objects from the Augmentations structure.
|
Object | removeItem(String key) - Remove additional info from the Augmentations structure
|
getItem
public Object getItem(String key)
Get information identified by a key from the Augmentations structure
key
- Identifier, can't be null
- the value to which the key is mapped in the Augmentations structure;
null
if the key is not mapped to any value.
keys
public Enumeration keys()
Returns an enumeration of the keys in the Augmentations structure
putItem
public Object putItem(String key,
Object item)
Add additional information identified by a key to the Augmentations structure.
key
- Identifier, can't be null
item
- Additional information
- the previous value of the specified key in the Augmentations structure,
or
null
if it did not have one.
removeAllItems
public void removeAllItems()
Remove all objects from the Augmentations structure.
removeItem
public Object removeItem(String key)
Remove additional info from the Augmentations structure
key
- Identifier, can't be null
- the previous value of the specified key in the Augmentations structure,
or
null
if it did not have one.
Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.