File Doc Category Size Date Package
Augmentations.java API Doc Apache Xerces 3.0.1 3144 Fri Sep 14 20:33:54 BST 2007 org.apache.xerces.xni

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.

author: Elena Litani, IBM
version: $Id: Augmentations.java 447247 2006-09-18 05:23:52Z mrglavas $

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Object getItem(java.lang.String key)
Get information identified by a key from the Augmentations structure
param
key Identifier, can't be null
return
the value to which the key is mapped in the Augmentations structure; null if the key is not mapped to any value.
public java.util.Enumeration keys()
Returns an enumeration of the keys in the Augmentations structure
public java.lang.Object putItem(java.lang.String key, java.lang.Object item)
Add additional information identified by a key to the Augmentations structure.
param
key Identifier, can't be null
param
item Additional information
return
the previous value of the specified key in the Augmentations structure, or null if it did not have one.
public void removeAllItems()
Remove all objects from the Augmentations structure.
public java.lang.Object removeItem(java.lang.String key)
Remove additional info from the Augmentations structure
param
key Identifier, can't be null
return
the previous value of the specified key in the Augmentations structure, or null if it did not have one.