ParameterList (Java EE 5)

java.lang.Object
  javax.mail.internet.ParameterList

此类保存 MIME 参数（属性-值对）。mail.mime.encodeparameters 和 mail.mime.decodeparameters 系统属性控制是否支持 RFC 2231 指定的编码参数。默认情况下，不支持此类编码参数。

而且，在当前实现中将系统属性 mail.mime.decodeparameters.strict 设置为 "true" 将导致在解码已编码参数期间检测到错误时抛出 ParseException。默认情况下，如果发生任何解码错误，则使用原来的（未解码的）字符串。

version

1.17, 07/05/04

英文文档：

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.

Version:

1.17, 07/05/04

Author:

John Mani, Bill Shannon

---

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.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

public ParameterList()
无参数构造方法。

英文文档：

ParameterList

public ParameterList()

No-arg Constructor.

---

public ParameterList(String s) throws ParseException
带参数列表字符串的构造方法。String 被解析，参数将在内部收集和存储。如果解析失败，则抛出 ParseException。注意，空参数列表字符串是有效的，它将被解析为空 ParameterList。

s	参数列表字符串。
Throws	ParseException: 如果解析失败。

英文文档：

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

public int size()
返回此列表中的参数数量。

return

参数的数量。

英文文档：

size

public int size()

Return the number of parameters in this list.

Returns:

number of parameters.

---

public String get(String name)
返回指定参数的值。注意，参数名称不区分大小写。

name	参数名称。
return	参数值。如果此参数不存在，则返回 null。

英文文档：

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.

---

public void set(String name, String value)
设置参数。如果此参数已经存在，则使用此新值替代它。

name	参数名称。
value	参数值。

英文文档：

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.

---

public void set(String name, String value, String charset)
设置参数。如果此参数已经存在，则使用此新值替代它。如果 mail.mime.encodeparameters 系统属性为 true，且参数值为非 ASCII，则使用 RFC 2231 指定的字符集对此参数进行编码。

name	参数名称。
value	参数值。
charset	参数值的字符集。
since	en JavaMail 1.4

英文文档：

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.

Since:

JavaMail 1.4

---

public void remove(String name)
从此 ParameterList 中移除指定的参数。如果此参数不存在，则此方法不执行任何操作。

name

参数名称。

英文文档：

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.

---

public java.util.Enumeration<E> getNames()
返回此列表中所有参数名称的枚举。

return

此列表中所有参数名称的枚举。

英文文档：

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.

---

public String toString()
将此 ParameterList 转换为 MIME String。如果为空列表，则返回空字符串。

return

字符串

英文文档：

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

---

public String toString(int used)
将此 ParameterList 转换为 MIME String。如果为空列表，则返回空字符串。 'used' 参数指定要插入所得参数列表的字段中已经使用的字符位置编号。它用于确定折叠所得参数列表的位置。

used	要插入参数列表的字段中已经使用的字符位置编号。
return	字符串

英文文档：

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  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.