com.openexchange.messaging
Interface ContentDisposition

All Superinterfaces:

MessagingHeader, ParameterizedMessagingHeader

public interface ContentDisposition
extends ParameterizedMessagingHeader

ContentDisposition - The Content-Disposition header.

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

Field Summary

static java.lang.String	ATTACHMENT The constant for "attachment" disposition.
static java.lang.String	INLINE The constant for "inline" disposition.

Method Summary

boolean	containsFilenameParameter() Checks if "filename" parameter is present.
java.lang.String	getDisposition() Gets the disposition.
java.lang.String	getFilenameParameter() Gets "filename" parameter.
boolean	isAttachment() Checks if disposition is attachment
boolean	isInline() Checks if disposition is inline
void	setContentDispositio(ContentDisposition contentDisposition) Applies given content disposition to this content disposition
void	setContentDisposition(java.lang.String contentDisposition) Sets the Content-Disposition.
void	setDisposition(java.lang.String disposition) Sets the disposition.
void	setFilenameParameter(java.lang.String filename) Sets "filename" parameter.

Methods inherited from interface com.openexchange.messaging.ParameterizedMessagingHeader

addParameter, containsParameter, getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface com.openexchange.messaging.MessagingHeader

getHeaderType, getName, getValue

Field Detail

INLINE

static final java.lang.String INLINE

The constant for "inline" disposition.

See Also:

Constant Field Values

ATTACHMENT

static final java.lang.String ATTACHMENT

The constant for "attachment" disposition.

See Also:

Constant Field Values

Method Detail

setContentDispositio

void setContentDispositio(ContentDisposition contentDisposition)

Applies given content disposition to this content disposition

Parameters:

contentDisposition - The content disposition to apply

getDisposition

java.lang.String getDisposition()

Gets the disposition.

Returns:

The disposition

See Also:

INLINE, ATTACHMENT

setDisposition

void setDisposition(java.lang.String disposition)

Sets the disposition.

Parameters:

disposition - The disposition

See Also:

INLINE, ATTACHMENT

setFilenameParameter

void setFilenameParameter(java.lang.String filename)

Sets "filename" parameter.

Parameters:

filename - The file name; e.g. "sometext.txt"

getFilenameParameter

java.lang.String getFilenameParameter()

Gets "filename" parameter.

Returns:

The "filename" parameter value or null if not present

containsFilenameParameter

boolean containsFilenameParameter()

Checks if "filename" parameter is present.

Returns:

true if "filename" parameter is present, false otherwise if absent

setContentDisposition

void setContentDisposition(java.lang.String contentDisposition)
                           throws MessagingException

Sets the Content-Disposition.

Parameters:

contentDisposition - The Content-Disposition as a string

Throws:

MessagingException - If applying Content-Disposition fails

isInline

boolean isInline()

Checks if disposition is inline

Returns:

true if disposition is inline; otherwise false

See Also:

INLINE

isAttachment

boolean isAttachment()

Checks if disposition is attachment

Returns:

true if disposition is attachment; otherwise false

See Also:

ATTACHMENT