com.openexchange.mail.mime

Class ParameterizedHeader

java.lang.Object

com.openexchange.mail.mime.ParameterizedHeader

All Implemented Interfaces:

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

Direct Known Subclasses:

ContentDisposition, ContentType

public abstract class ParameterizedHeader
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ParameterizedHeader>

ParameterizedHeader - Super class for headers which can hold a parameter list such as Content-Type.

Author:

Thorben Betten

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(java.lang.String key, java.lang.String value) Adds specified value to given parameter name.
void	clearParameters() Clears all parameters contained in this parameterized header.
int	compareTo(ParameterizedHeader other)
boolean	containsParameter(java.lang.String key) Checks if parameter is present
boolean	equals(java.lang.Object obj)
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
int	hashCode()
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 class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

compareTo

public int compareTo(ParameterizedHeader other)

Specified by:

compareTo in interface java.lang.Comparable<ParameterizedHeader>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

addParameter

public 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

public 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

public 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

public 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

public 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

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

Gets all parameter names wrapped in an Iterator

Returns:

All parameter names wrapped in an Iterator

clearParameters

public void clearParameters()

Clears all parameters contained in this parameterized header.