This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.mail.internet
class ParameterList

javax.mail.internet.ParameterList 
public class ParameterList
extends Object

This class holds MIME parameters (attribute-value pairs). The mail.mime.encodeparameters and mail.mime.decodeparameters System properties control whether encoded parameters, as specified by RFC 2231, are supported. By default, such encoded parameters are not supported.

Also, in the current implementation, setting the System property mail.mime.decodeparameters.strict to "true" will cause a ParseException to be thrown for errors detected while decoding encoded parameters. By default, if any decoding errors occur, the original (undecoded) string is used.

See Also (auto-generated):

MimeBodyPart

Constructor Summary
ParameterList()

          No-arg Constructor.
ParameterList(String s)

          Constructor that takes a parameter-list string.
 
Method Summary
 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.
 void
set(String name, String value, String charset)

          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.
 

Constructor Detail

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.

Parameters:
s - the parameter-list string.
Throws:
ParseException - if the parse fails.
Method Detail

get

public String get(String name)
Returns the value of the specified parameter. Note that parameter names are case-insensitive.

Parameters:
name - parameter name.
Returns:
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.

Returns:
Enumeration of all parameter names 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.

Parameters:
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.

Parameters:
name - name of the parameter.
value - value of the parameter.

set

public void set(String name,
                String value,
                String charset)
Set a parameter. If this parameter already exists, it is replaced by this new value. If the mail.mime.encodeparameters System property is true, and the parameter value is non-ASCII, it will be encoded with the specified charset, as specified by RFC 2231.

Parameters:
name - name of the parameter.
value - value of the parameter.
charset - charset of the parameter value.

size

public int size()
Return the number of parameters in this list.

Returns:
number of parameters.

toString

public String toString()
Convert this ParameterList into a MIME String. If this is an empty list, an empty string is returned.

Overrides:
toString in class Object
Returns:
String

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.

Parameters:
used - number of character positions already used, in the field into which the parameter list is to be inserted.
Returns:
String
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.