|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
void |
clear()
Remove all objects from the Augmentations structure. |
java.lang.Object |
getItem(java.lang.String key)
Get information identified by a key from the Augmentations structure |
java.util.Enumeration |
keys()
Returns an enumeration of the keys in the Augmentations structure |
java.lang.Object |
putItem(java.lang.String key,
java.lang.Object item)
Add additional information identified by a key to the Augmentations structure. |
java.lang.Object |
removeItem(java.lang.String key)
Remove additional info from the Augmentations structure |
Method Detail |
public java.lang.Object putItem(java.lang.String key, java.lang.Object item)
key
- Identifier, can't be null
item
- Additional informationnull
if it did not have one.public java.lang.Object getItem(java.lang.String key)
key
- Identifier, can't be null
null
if the key is not mapped to any value.public java.lang.Object removeItem(java.lang.String key)
key
- Identifier, can't be null
null
if it did not have one.public java.util.Enumeration keys()
public void clear()
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81b |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |