javax.mail.internet

Class ParameterList

java.lang.Object

javax.mail.internet.ParameterList

public class ParameterList
extends Object

A list of MIME parameters. MIME parameters are name-value pairs associated with a MIME header.

Version:

1.4

Author:

Chris Burdess

Constructor Summary

Constructors

Constructor and Description
ParameterList() Constructor for an empty parameter list.
ParameterList(String s) Constructor with a parameter-list string.

Method Summary

Methods

Modifier and Type	Method and Description
String	get(String name) Returns the value of the specified parameter.
Enumeration	getNames() Returns the names of all parameters in this list.
void	remove(String name) Removes the specified parameter from this list.
void	set(String name, String value) Sets the specified parameter.
void	set(String name, String value, String charset) Sets the specified parameter.
int	size() Returns the number of parameters in this list.
String	toString() Returns the MIME string representation of this parameter list.
String	toString(int used) Returns the MIME string representation of this parameter list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterList

public ParameterList()

Constructor for an empty parameter list.

ParameterList

public ParameterList(String s)
              throws ParseException

Constructor with a parameter-list string.

Parameters:

s - the parameter-list string

Throws:

ParseException - if the parse fails

Method Detail

size

public int size()

Returns the number of parameters in this list.

get

public String get(String name)

Returns the value of the specified parameter. Parameter names are case insensitive.

Parameters:

name - the parameter name

set

public void set(String name,
       String value)

Sets the specified parameter.

Parameters:

name - the parameter name

value - the parameter value

set

public void set(String name,
       String value,
       String charset)

Sets the specified parameter.

Parameters:

name - the parameter name

value - the parameter value

charset - the character set to use to encode the value, if mail.mime.encodeparameters is true.

Since:

JavaMail 1.5

remove

public void remove(String name)

Removes the specified parameter from this list.

Parameters:

name - the parameter name

getNames

public Enumeration getNames()

Returns the names of all parameters in this list.

Returns:

an Enumeration of String

toString

public String toString()

Returns the MIME string representation of this parameter list.

Overrides:

toString in class Object

toString

public String toString(int used)

Returns the MIME string representation of this parameter list.

Parameters:

used - the number of character positions already used in the field into which the parameter list is to be inserted