com.sonicsw.xq
Interface XQHeader

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable, XQCloneable

public interface XQHeader
extends java.io.Serializable, XQCloneable

The XQHeader stores name/value pairs to represent header objects associated with a message part. XQHeader objects are accessible from XQParts.

See Also:

XQPart.getHeader()

Method Summary

java.util.Iterator<java.lang.String>	getKeys() Gets the list of all header fields.
java.lang.String	getValue(java.lang.String key) Gets the value of a header field, or null if it does not exist.
java.lang.String	remove(java.lang.String key) Removes the specified field from the header.
void	removeAll() Removes all entries from the header.
java.lang.String	setValue(java.lang.String key, java.lang.String value) Sets the value of a header field.
void	setValues(java.util.Map<java.lang.String,java.lang.String> map) Add zero or more fields to header.
boolean	valueExists(java.lang.String key) Check if a header field exists.

Methods inherited from interface com.sonicsw.xq.XQCloneable

clone

Method Detail

getValue

java.lang.String getValue(java.lang.String key)

Gets the value of a header field, or null if it does not exist.

Parameters:

key - The name of the header field.

Returns:

The value of the header field, or null.

setValue

java.lang.String setValue(java.lang.String key,
                          java.lang.String value)

Sets the value of a header field. Overwrites headers of the same name.

Parameters:

key - The name of the header field to set.

value - The value to set.

remove

java.lang.String remove(java.lang.String key)

Removes the specified field from the header.

Parameters:

key - The name of the header field to remove.

removeAll

void removeAll()

Removes all entries from the header.

valueExists

boolean valueExists(java.lang.String key)

Check if a header field exists.

Parameters:

key - The name of the header field to check.

Returns:

true if the header field exists, false otherwise.

getKeys

java.util.Iterator<java.lang.String> getKeys()

Gets the list of all header fields.

Returns:

The list of header fields.

setValues

void setValues(java.util.Map<java.lang.String,java.lang.String> map)

Add zero or more fields to header. The Map contains name, value pairs of header fields.

Parameters:

map - The fields to add to the header