javax.mail.internet
Class ParameterList
java.lang.Objectjavax.mail.internet.ParameterList
public class ParameterList
extends java.lang.Object
This class holds MIME parameters(attribute-value pairs).
String | get(String name)- Returns the value of the specified parameter.
|
Enumeration | getNames()- Return an enumeration of the names of all parameters in this list.
|
void | remove(String name)- Removes the specified parameter from this ParameterList.
|
void | set(String name, String value)- Set a parameter.
|
int | size()- Return the number of parameters in this list.
|
String | toString()- Convert this ParameterList into a MIME String.
|
String | toString(int used)- Convert this ParameterList into a MIME String.
|
ParameterList
public ParameterList()
No-arg Constructor.
ParameterList
public ParameterList(String s)
throws ParseException Constructor that takes a parameter-list string.
The String is parsed and the parameters are collected and stored
internally. A ParseException is thrown if the parse fails.
Note that an empty parameter-list string is valid and will be parsed
into an empty ParameterList.
s - the parameter-list string.
ParseException - if the parse fails.
get
public String get(String name)
Returns the value of the specified parameter.
Note that parameter names are case-insensitive.
name - parameter name.
- Value of the parameter.
Returns null if the parameter is not present.
getNames
public Enumeration getNames()
Return an enumeration of the names of all parameters in this list.
remove
public void remove(String name)
Removes the specified parameter from this ParameterList.
This method does nothing if the parameter is not present.
name - name of the parameter.
set
public void set(String name,
String value) Set a parameter.
If this parameter already exists, it is replaced by this new value.
name - name of the parameter.value - value of the parameter.
size
public int size()
Return the number of parameters in this list.
toString
public String toString()
Convert this ParameterList into a MIME String.
If this is an empty list, an empty string is returned.
toString
public String toString(int used)
Convert this ParameterList into a MIME String.
If this is an empty list, an empty string is returned.
The 'used' parameter specifies the number of character positions
already taken up in the field into which the resulting parameter
list is to be inserted. It's used to determine where to fold the
resulting parameter list.
used - number of character positions already used, in the field into
which the parameter list is to be inserted.