com.openexchange.mail.mime

Class ContentDisposition

java.lang.Object

com.openexchange.mail.mime.ParameterizedHeader

com.openexchange.mail.mime.ContentDisposition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParameterizedHeader>

public final class ContentDisposition
extends ParameterizedHeader

ContentDisposition

Author:

Thorben Betten

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContentDisposition() Initializes a new ContentDisposition
ContentDisposition(java.lang.String contentDisp) Initializes a new ContentDisposition

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ParameterizedHeader other)
boolean	containsFilenameParameter()
boolean	equals(java.lang.Object obj)
java.lang.String	getDisposition()
java.lang.String	getFilenameParameter()
int	hashCode()
boolean	isAttachment() Checks if disposition is attachment
boolean	isInline() Checks if disposition is inline
void	setAttachment() Sets the disposition to "attachment".
void	setContentDisposition(ContentDisposition contentDisp) Applies given content disposition to this content disposition
void	setContentDisposition(java.lang.String contentDisp) Sets Content-Disposition
void	setDisposition(java.lang.String disposition) Sets disposition
void	setFilenameParameter(java.lang.String filename) Sets filename parameter
void	setInline() Sets the disposition to "inline".
java.lang.String	toString()
java.lang.String	toString(boolean skipEmptyParams) Returns a RFC2045 style (ASCII-only) string representation of this content disposition.

Methods inherited from class com.openexchange.mail.mime.ParameterizedHeader

addParameter, clearParameters, containsParameter, getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContentDisposition

public ContentDisposition()

Initializes a new ContentDisposition

ContentDisposition

public ContentDisposition(java.lang.String contentDisp)
                   throws com.openexchange.exception.OXException

Initializes a new ContentDisposition

Parameters:

contentDisp - The content disposition

Throws:

com.openexchange.exception.OXException - If content disposition cannot be parsed

Method Detail

compareTo

public int compareTo(ParameterizedHeader other)

Specified by:

compareTo in interface java.lang.Comparable<ParameterizedHeader>

Overrides:

compareTo in class ParameterizedHeader

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterizedHeader

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ParameterizedHeader

setContentDisposition

public void setContentDisposition(ContentDisposition contentDisp)

Applies given content disposition to this content disposition

Parameters:

contentDisp - The content disposition to apply

getDisposition

public java.lang.String getDisposition()

Returns:

disposition

setDisposition

public void setDisposition(java.lang.String disposition)

Sets disposition

setInline

public void setInline()

Sets the disposition to "inline".

setAttachment

public void setAttachment()

Sets the disposition to "attachment".

setFilenameParameter

public void setFilenameParameter(java.lang.String filename)

Sets filename parameter

getFilenameParameter

public java.lang.String getFilenameParameter()

Returns:

the filename value or null if not present

containsFilenameParameter

public boolean containsFilenameParameter()

Returns:

true if filename parameter is present, false otherwise

setContentDisposition

public void setContentDisposition(java.lang.String contentDisp)
                           throws com.openexchange.exception.OXException

Sets Content-Disposition

Throws:

com.openexchange.exception.OXException

isInline

public boolean isInline()

Checks if disposition is inline

Returns:

true if disposition is inline; otherwise false

isAttachment

public boolean isAttachment()

Checks if disposition is attachment

Returns:

true if disposition is attachment; otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean skipEmptyParams)

Returns a RFC2045 style (ASCII-only) string representation of this content disposition.

Parameters:

skipEmptyParams - true to skip empty parameters; otherwise false

Returns:

A RFC2045 style (ASCII-only) string representation of this content disposition