com.openexchange.messaging
Interface ParameterizedMessagingHeader

All Superinterfaces:

MessagingHeader

All Known Subinterfaces:

ContentDisposition, ContentType

public interface ParameterizedMessagingHeader
extends MessagingHeader

ParameterizedMessagingHeader - A header which is capable to hold parameters.

Since:

Open-Xchange v6.16

Author:

Thorben Betten

Nested Class Summary

Nested classes/interfaces inherited from interface com.openexchange.messaging.MessagingHeader

MessagingHeader.HeaderType, MessagingHeader.KnownHeader

Method Summary

void	addParameter(java.lang.String key, java.lang.String value) Adds specified value to given parameter name.
boolean	containsParameter(java.lang.String key) Checks if parameter is present
java.lang.String	getParameter(java.lang.String key) Gets specified parameter's value
java.util.Iterator<java.lang.String>	getParameterNames() Gets all parameter names wrapped in an Iterator
java.lang.String	removeParameter(java.lang.String key) Removes specified parameter and returns its value
void	setParameter(java.lang.String key, java.lang.String value) Sets the given parameter.

Methods inherited from interface com.openexchange.messaging.MessagingHeader

getHeaderType, getName, getValue

Method Detail

addParameter

void addParameter(java.lang.String key,
                  java.lang.String value)

Adds specified value to given parameter name. If existing, the parameter is treated as a contiguous parameter according to RFC2231.

Parameters:

key - The parameter name

value - The parameter value to add

setParameter

void setParameter(java.lang.String key,
                  java.lang.String value)

Sets the given parameter. Existing value is overwritten.

Parameters:

key - The parameter name

value - The parameter value

getParameter

java.lang.String getParameter(java.lang.String key)

Gets specified parameter's value

Parameters:

key - The parameter name

Returns:

The parameter's value or null if not existing

removeParameter

java.lang.String removeParameter(java.lang.String key)

Removes specified parameter and returns its value

Parameters:

key - The parameter name

Returns:

The parameter's value or null if not existing

containsParameter

boolean containsParameter(java.lang.String key)

Checks if parameter is present

Parameters:

key - the parameter name

Returns:

true if parameter is present; otherwise false

getParameterNames

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

Gets all parameter names wrapped in an Iterator

Returns:

All parameter names wrapped in an Iterator