com.openexchange.messaging
Interface ParameterizedMessagingMessage

All Superinterfaces:

MessagingContent, MessagingMessage, MessagingPart, java.io.Serializable

public interface ParameterizedMessagingMessage
extends MessagingMessage

ParameterizedMessagingMessage - Extends MessagingMessage by the capability to carry parameters.

Author:

Thorben Betten

Field Summary

Fields inherited from interface com.openexchange.messaging.MessagingMessage

FLAG_ANSWERED, FLAG_DELETED, FLAG_DRAFT, FLAG_FLAGGED, FLAG_FORWARDED, FLAG_READ_ACK, FLAG_RECENT, FLAG_SEEN, FLAG_SPAM, FLAG_USER, USER_FORWARDED, USER_READ_ACK

Fields inherited from interface com.openexchange.messaging.MessagingPart

ATTACHMENT, INLINE

Method Summary

void	clearParameters() Clears all parameters associated with this message.
boolean	containsParameter(java.lang.String name) Checks if this message contains denoted parameter.
java.lang.Object	getParameter(java.lang.String name) Gets the associated parameter value.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Gets all parameters of this message as a map.
void	putParameter(java.lang.String name, java.lang.Object value) Puts specified parameter (and thus overwrites any existing parameter)
boolean	putParameterIfAbsent(java.lang.String name, java.lang.Object value) Puts specified parameter if not already present.

Methods inherited from interface com.openexchange.messaging.MessagingMessage

getColorLabel, getFlags, getFolder, getId, getPicture, getReceivedDate, getThreadLevel, getUrl, getUserFlags

Methods inherited from interface com.openexchange.messaging.MessagingPart

getContent, getContentType, getDisposition, getFileName, getFirstHeader, getHeader, getHeaders, getSectionId, getSize, writeTo

Method Detail

getParameters

java.util.Map<java.lang.String,java.lang.Object> getParameters()

Gets all parameters of this message as a map.

Note: Any modifications applied to returned map will also be reflected in message's parameters.

Returns:

The parameters as a map

getParameter

java.lang.Object getParameter(java.lang.String name)

Gets the associated parameter value.

Parameters:

name - The parameter name

Returns:

The parameter value or null if absent

putParameter

void putParameter(java.lang.String name,
                  java.lang.Object value)

Puts specified parameter (and thus overwrites any existing parameter)

Parameters:

name - The parameter name

value - The parameter value

putParameterIfAbsent

boolean putParameterIfAbsent(java.lang.String name,
                             java.lang.Object value)

Puts specified parameter if not already present.

Parameters:

name - The parameter name

value - The parameter value

Returns:

true if parameter has been put; otherwise false if already present

clearParameters

void clearParameters()

Clears all parameters associated with this message.

containsParameter

boolean containsParameter(java.lang.String name)

Checks if this message contains denoted parameter.

Parameters:

name - The parameter name

Returns:

true if such a parameter exists; false if absent