OpenJDK 1.22 · com.sun.org.apache.xerces.internal.xni.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.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: the value to which the key is mapped in the Augmentations structure; `null` if the key is not mapped to any value. getItem(String Identifier, can't be `null` key) Get information identified by a key from the Augmentations structure
public Enumeration<Object>	keys() Returns an enumeration of the keys in the Augmentations structure
public Object	Returns: the previous value of the specified key in the Augmentations structure, or `null` if it did not have one. putItem(String Identifier, can't be `null` key, Object Additional information item) Add additional information identified by a key to the Augmentations structure.
public void	removeAllItems() Remove all objects from the Augmentations structure.
public Object	Returns: the previous value of the specified key in the Augmentations structure, or `null` if it did not have one. removeItem(String Identifier, can't be `null` key) Remove additional info from the Augmentations structure

Method Detail

getItem back to summary

getItem	back to summary
public Object getItem(String key) Get information identified by a key from the Augmentations structure Parameters key:String Identifier, can't be `null` Returns:Object the value to which the key is mapped in the Augmentations structure; `null` if the key is not mapped to any value.

public Object getItem(String key)

Get information identified by a key from the Augmentations structure

Parameters

key:String: Identifier, can't be null

Returns:Object

the value to which the key is mapped in the Augmentations structure; null if the key is not mapped to any value.

keys	back to summary
public Enumeration<Object> keys() Returns an enumeration of the keys in the Augmentations structure

putItem back to summary

putItem	back to summary
public Object putItem(String key, Object item) Add additional information identified by a key to the Augmentations structure. Parameters key:String Identifier, can't be `null` item:Object Additional information Returns:Object the previous value of the specified key in the Augmentations structure, or `null` if it did not have one.

public Object putItem(String key, Object item)

Add additional information identified by a key to the Augmentations structure.

Parameters

key:String: Identifier, can't be null
item:Object: Additional information

Returns:Object

the previous value of the specified key in the Augmentations structure, or null if it did not have one.

removeAllItems	back to summary
public void removeAllItems() Remove all objects from the Augmentations structure.

removeItem back to summary

removeItem	back to summary
public Object removeItem(String key) Remove additional info from the Augmentations structure Parameters key:String Identifier, can't be `null` Returns:Object the previous value of the specified key in the Augmentations structure, or `null` if it did not have one.

public Object removeItem(String key)

Remove additional info from the Augmentations structure

Parameters

key:String: Identifier, can't be null

Returns:Object

the previous value of the specified key in the Augmentations structure, or null if it did not have one.

public Interface Augmentations

Method Summary

Method Detail