com.hcl.domino.mime

Interface MimeHeader

public interface MimeHeader

Represents a header within a MimeEntity.

Method Summary

Modifier and Type	Method and Description
MimeEntity	getEntity() Retrieves the entity that contains this header.
Map<String,String>	getParameters() Retrieves a view of the parameters of this header.
String	getValue()
void	remove() Removes this header from its containing entity.
void	setParameter(String parameterName, String value) Sets a parameter of this header, leaving the value intact.
void	setValue(String value) Sets the value of this header, leaving any parameters intact.
void	setValueAndParameters(String value) Sets the value of this header, including its parameters.

Method Detail

getEntity

MimeEntity getEntity()

Retrieves the entity that contains this header.

Returns:

the containing MimeEntity

getValue

String getValue()

Returns:

the value of this header, without any parameters

setValue

void setValue(String value)

Sets the value of this header, leaving any parameters intact.

Parameters:

value - the value to set

setValueAndParameters

void setValueAndParameters(String value)

Sets the value of this header, including its parameters.

Calling this method invalidates any objects returned by getParameters().

Parameters:

value - the value+parameter string to set

setParameter

void setParameter(String parameterName,
                  String value)

Sets a parameter of this header, leaving the value intact.

Parameters:

parameterName - the name of the parameter to set

value - the value of the parameter

getParameters

Map<String,String> getParameters()

Retrieves a view of the parameters of this header.

In practice, this map acts similarly to a LinkedHashMap in that parameters will be written in the header in the order that they're added.

Returns:

a mutable Map view of the parameters for this header

remove

void remove()

Removes this header from its containing entity.