Subversion Repositories javautils

Rev

Blame | Last modification | View Log | RSS feed

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_10) on Tue Nov 17 12:13:41 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. ParameterList (JavaMail API documentation)
  9. </TITLE>
  10.  
  11. <META NAME="date" CONTENT="2009-11-17">
  12.  
  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  14.  
  15. <SCRIPT type="text/javascript">
  16. function windowTitle()
  17. {
  18.     if (location.href.indexOf('is-external=true') == -1) {
  19.         parent.document.title="ParameterList (JavaMail API documentation)";
  20.     }
  21. }
  22. </SCRIPT>
  23. <NOSCRIPT>
  24. </NOSCRIPT>
  25.  
  26. </HEAD>
  27.  
  28. <BODY BGCOLOR="white" onload="windowTitle();">
  29. <HR>
  30.  
  31.  
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <A NAME="navbar_top"><!-- --></A>
  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  36. <TR>
  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  38. <A NAME="navbar_top_firstrow"><!-- --></A>
  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  40.   <TR ALIGN="center" VALIGN="top">
  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ParameterList.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  49.   </TR>
  50. </TABLE>
  51. </TD>
  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  53. </EM>
  54. </TD>
  55. </TR>
  56.  
  57. <TR>
  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59. &nbsp;<A HREF="../../../javax/mail/internet/NewsAddress.html" title="class in javax.mail.internet"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../javax/mail/internet/ParseException.html" title="class in javax.mail.internet"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../index.html?javax/mail/internet/ParameterList.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="ParameterList.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  64. &nbsp;<SCRIPT type="text/javascript">
  65.   <!--
  66.   if(window==top) {
  67.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  68.   }
  69.   //-->
  70. </SCRIPT>
  71. <NOSCRIPT>
  72.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  73. </NOSCRIPT>
  74.  
  75.  
  76. </FONT></TD>
  77. </TR>
  78. <TR>
  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  82. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  83. </TR>
  84. </TABLE>
  85. <A NAME="skip-navbar_top"></A>
  86. <!-- ========= END OF TOP NAVBAR ========= -->
  87.  
  88. <HR>
  89. <!-- ======== START OF CLASS DATA ======== -->
  90. <H2>
  91. <FONT SIZE="-1">
  92. javax.mail.internet</FONT>
  93. <BR>
  94. Class ParameterList</H2>
  95. <PRE>
  96. <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  97.   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.mail.internet.ParameterList</B>
  98. </PRE>
  99. <HR>
  100. <DL>
  101. <DT><PRE>public class <B>ParameterList</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
  102. </PRE>
  103.  
  104. <P>
  105. This class holds MIME parameters (attribute-value pairs).
  106.  The <code>mail.mime.encodeparameters</code> and
  107.  <code>mail.mime.decodeparameters</code> System properties
  108.  control whether encoded parameters, as specified by
  109.  <a href="http://www.ietf.org/rfc/rfc2231.txt">RFC 2231</a>,
  110.  are supported.  By default, such encoded parameters are not
  111.  supported. <p>
  112.  
  113.  Also, in the current implementation, setting the System property
  114.  <code>mail.mime.decodeparameters.strict</code> to <code>"true"</code>
  115.  will cause a <code>ParseException</code> to be thrown for errors
  116.  detected while decoding encoded parameters.  By default, if any
  117.  decoding errors occur, the original (undecoded) string is used. <p>
  118.  
  119.  The current implementation supports the System property
  120.  <code>mail.mime.parameters.strict</code>, which if set to false
  121.  when parsing a parameter list allows parameter values
  122.  to contain whitespace and other special characters without
  123.  being quoted; the parameter value ends at the next semicolon.
  124.  If set to true (the default), parameter values are required to conform
  125.  to the MIME specification and must be quoted if they contain whitespace
  126.  or special characters.
  127. <P>
  128.  
  129. <P>
  130. <HR>
  131.  
  132. <P>
  133.  
  134. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  135.  
  136. <A NAME="constructor_summary"><!-- --></A>
  137. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  138. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  139. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  140. <B>Constructor Summary</B></FONT></TH>
  141. </TR>
  142. <TR BGCOLOR="white" CLASS="TableRowColor">
  143. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#ParameterList()">ParameterList</A></B>()</CODE>
  144.  
  145. <BR>
  146. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;No-arg Constructor.</TD>
  147. </TR>
  148. <TR BGCOLOR="white" CLASS="TableRowColor">
  149. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#ParameterList(java.lang.String)">ParameterList</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;s)</CODE>
  150.  
  151. <BR>
  152. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that takes a parameter-list string.</TD>
  153. </TR>
  154. </TABLE>
  155. &nbsp;
  156. <!-- ========== METHOD SUMMARY =========== -->
  157.  
  158. <A NAME="method_summary"><!-- --></A>
  159. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  160. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  161. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  162. <B>Method Summary</B></FONT></TH>
  163. </TR>
  164. <TR BGCOLOR="white" CLASS="TableRowColor">
  165. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  166. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  167. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#get(java.lang.String)">get</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
  168.  
  169. <BR>
  170. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of the specified parameter.</TD>
  171. </TR>
  172. <TR BGCOLOR="white" CLASS="TableRowColor">
  173. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  174. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
  175. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#getNames()">getNames</A></B>()</CODE>
  176.  
  177. <BR>
  178. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an enumeration of the names of all parameters in this
  179.  list.</TD>
  180. </TR>
  181. <TR BGCOLOR="white" CLASS="TableRowColor">
  182. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  183. <CODE>&nbsp;void</CODE></FONT></TD>
  184. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#remove(java.lang.String)">remove</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
  185.  
  186. <BR>
  187. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the specified parameter from this ParameterList.</TD>
  188. </TR>
  189. <TR BGCOLOR="white" CLASS="TableRowColor">
  190. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  191. <CODE>&nbsp;void</CODE></FONT></TD>
  192. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#set(java.lang.String, java.lang.String)">set</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
  193.     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;value)</CODE>
  194.  
  195. <BR>
  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a parameter.</TD>
  197. </TR>
  198. <TR BGCOLOR="white" CLASS="TableRowColor">
  199. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  200. <CODE>&nbsp;void</CODE></FONT></TD>
  201. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#set(java.lang.String, java.lang.String, java.lang.String)">set</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
  202.     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;value,
  203.     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;charset)</CODE>
  204.  
  205. <BR>
  206. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a parameter.</TD>
  207. </TR>
  208. <TR BGCOLOR="white" CLASS="TableRowColor">
  209. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  210. <CODE>&nbsp;int</CODE></FONT></TD>
  211. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#size()">size</A></B>()</CODE>
  212.  
  213. <BR>
  214. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the number of parameters in this list.</TD>
  215. </TR>
  216. <TR BGCOLOR="white" CLASS="TableRowColor">
  217. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  218. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  219. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#toString()">toString</A></B>()</CODE>
  220.  
  221. <BR>
  222. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert this ParameterList into a MIME String.</TD>
  223. </TR>
  224. <TR BGCOLOR="white" CLASS="TableRowColor">
  225. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  226. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  227. <TD><CODE><B><A HREF="../../../javax/mail/internet/ParameterList.html#toString(int)">toString</A></B>(int&nbsp;used)</CODE>
  228.  
  229. <BR>
  230. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert this ParameterList into a MIME String.</TD>
  231. </TR>
  232. </TABLE>
  233. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  234. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  235. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  236. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
  237. </TR>
  238. <TR BGCOLOR="white" CLASS="TableRowColor">
  239. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  240. </TR>
  241. </TABLE>
  242. &nbsp;
  243. <P>
  244.  
  245. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  246.  
  247. <A NAME="constructor_detail"><!-- --></A>
  248. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  249. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  250. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  251. <B>Constructor Detail</B></FONT></TH>
  252. </TR>
  253. </TABLE>
  254.  
  255. <A NAME="ParameterList()"><!-- --></A><H3>
  256. ParameterList</H3>
  257. <PRE>
  258. public <B>ParameterList</B>()</PRE>
  259. <DL>
  260. <DD>No-arg Constructor.
  261. <P>
  262. </DL>
  263. <HR>
  264.  
  265. <A NAME="ParameterList(java.lang.String)"><!-- --></A><H3>
  266. ParameterList</H3>
  267. <PRE>
  268. public <B>ParameterList</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;s)
  269.               throws <A HREF="../../../javax/mail/internet/ParseException.html" title="class in javax.mail.internet">ParseException</A></PRE>
  270. <DL>
  271. <DD>Constructor that takes a parameter-list string. The String
  272.  is parsed and the parameters are collected and stored internally.
  273.  A ParseException is thrown if the parse fails.
  274.  Note that an empty parameter-list string is valid and will be
  275.  parsed into an empty ParameterList.
  276. <P>
  277. <DL>
  278. <DT><B>Parameters:</B><DD><CODE>s</CODE> - the parameter-list string.
  279. <DT><B>Throws:</B>
  280. <DD><CODE><A HREF="../../../javax/mail/internet/ParseException.html" title="class in javax.mail.internet">ParseException</A></CODE> - if the parse fails.</DL>
  281. </DL>
  282.  
  283. <!-- ============ METHOD DETAIL ========== -->
  284.  
  285. <A NAME="method_detail"><!-- --></A>
  286. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  287. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  288. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  289. <B>Method Detail</B></FONT></TH>
  290. </TR>
  291. </TABLE>
  292.  
  293. <A NAME="size()"><!-- --></A><H3>
  294. size</H3>
  295. <PRE>
  296. public int <B>size</B>()</PRE>
  297. <DL>
  298. <DD>Return the number of parameters in this list.
  299. <P>
  300. <DD><DL>
  301.  
  302. <DT><B>Returns:</B><DD>number of parameters.</DL>
  303. </DD>
  304. </DL>
  305. <HR>
  306.  
  307. <A NAME="get(java.lang.String)"><!-- --></A><H3>
  308. get</H3>
  309. <PRE>
  310. public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>get</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
  311. <DL>
  312. <DD>Returns the value of the specified parameter. Note that
  313.  parameter names are case-insensitive.
  314. <P>
  315. <DD><DL>
  316. <DT><B>Parameters:</B><DD><CODE>name</CODE> - parameter name.
  317. <DT><B>Returns:</B><DD>Value of the parameter. Returns
  318.                         <code>null</code> if the parameter is not
  319.                         present.</DL>
  320. </DD>
  321. </DL>
  322. <HR>
  323.  
  324. <A NAME="set(java.lang.String, java.lang.String)"><!-- --></A><H3>
  325. set</H3>
  326. <PRE>
  327. public void <B>set</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
  328.                 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
  329. <DL>
  330. <DD>Set a parameter. If this parameter already exists, it is
  331.  replaced by this new value.
  332. <P>
  333. <DD><DL>
  334. <DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the parameter.<DD><CODE>value</CODE> - value of the parameter.</DL>
  335. </DD>
  336. </DL>
  337. <HR>
  338.  
  339. <A NAME="set(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  340. set</H3>
  341. <PRE>
  342. public void <B>set</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
  343.                 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;value,
  344.                 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;charset)</PRE>
  345. <DL>
  346. <DD>Set a parameter. If this parameter already exists, it is
  347.  replaced by this new value.  If the
  348.  <code>mail.mime.encodeparameters</code> System property
  349.  is true, and the parameter value is non-ASCII, it will be
  350.  encoded with the specified charset, as specified by RFC 2231.
  351. <P>
  352. <DD><DL>
  353. <DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the parameter.<DD><CODE>value</CODE> - value of the parameter.<DD><CODE>charset</CODE> - charset of the parameter value.<DT><B>Since:</B></DT>
  354.   <DD>JavaMail 1.4</DD>
  355. </DL>
  356. </DD>
  357. </DL>
  358. <HR>
  359.  
  360. <A NAME="remove(java.lang.String)"><!-- --></A><H3>
  361. remove</H3>
  362. <PRE>
  363. public void <B>remove</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
  364. <DL>
  365. <DD>Removes the specified parameter from this ParameterList.
  366.  This method does nothing if the parameter is not present.
  367. <P>
  368. <DD><DL>
  369. <DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the parameter.</DL>
  370. </DD>
  371. </DL>
  372. <HR>
  373.  
  374. <A NAME="getNames()"><!-- --></A><H3>
  375. getNames</H3>
  376. <PRE>
  377. public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</A> <B>getNames</B>()</PRE>
  378. <DL>
  379. <DD>Return an enumeration of the names of all parameters in this
  380.  list.
  381. <P>
  382. <DD><DL>
  383.  
  384. <DT><B>Returns:</B><DD>Enumeration of all parameter names in this list.</DL>
  385. </DD>
  386. </DL>
  387. <HR>
  388.  
  389. <A NAME="toString()"><!-- --></A><H3>
  390. toString</H3>
  391. <PRE>
  392. public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
  393. <DL>
  394. <DD>Convert this ParameterList into a MIME String. If this is
  395.  an empty list, an empty string is returned.
  396. <P>
  397. <DD><DL>
  398. <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
  399. </DD>
  400. <DD><DL>
  401.  
  402. <DT><B>Returns:</B><DD>String</DL>
  403. </DD>
  404. </DL>
  405. <HR>
  406.  
  407. <A NAME="toString(int)"><!-- --></A><H3>
  408. toString</H3>
  409. <PRE>
  410. public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>(int&nbsp;used)</PRE>
  411. <DL>
  412. <DD>Convert this ParameterList into a MIME String. If this is
  413.  an empty list, an empty string is returned.
  414.    
  415.  The 'used' parameter specifies the number of character positions
  416.  already taken up in the field into which the resulting parameter
  417.  list is to be inserted. It's used to determine where to fold the
  418. resulting parameter list.
  419. <P>
  420. <DD><DL>
  421. <DT><B>Parameters:</B><DD><CODE>used</CODE> - number of character positions already used, in
  422.                  the field into which the parameter list is to
  423.                  be inserted.
  424. <DT><B>Returns:</B><DD>String</DL>
  425. </DD>
  426. </DL>
  427. <!-- ========= END OF CLASS DATA ========= -->
  428. <HR>
  429.  
  430.  
  431. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  432. <A NAME="navbar_bottom"><!-- --></A>
  433. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  434. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  435. <TR>
  436. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  437. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  438. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  439.  <TR ALIGN="center" VALIGN="top">
  440.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  441.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  442.  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  443.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ParameterList.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  444.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  445.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  446.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  447.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  448.  </TR>
  449. </TABLE>
  450. </TD>
  451. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  452. </EM>
  453. </TD>
  454. </TR>
  455.  
  456. <TR>
  457. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  458. &nbsp;<A HREF="../../../javax/mail/internet/NewsAddress.html" title="class in javax.mail.internet"><B>PREV CLASS</B></A>&nbsp;
  459. &nbsp;<A HREF="../../../javax/mail/internet/ParseException.html" title="class in javax.mail.internet"><B>NEXT CLASS</B></A></FONT></TD>
  460. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  461.  <A HREF="../../../index.html?javax/mail/internet/ParameterList.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  462. &nbsp;<A HREF="ParameterList.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  463. &nbsp;<SCRIPT type="text/javascript">
  464.  <!--
  465.  if(window==top) {
  466.    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  467.  }
  468.  //-->
  469. </SCRIPT>
  470. <NOSCRIPT>
  471.  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  472. </NOSCRIPT>
  473.  
  474.  
  475. </FONT></TD>
  476. </TR>
  477. <TR>
  478. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  479.  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  480. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  481. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  482. </TR>
  483. </TABLE>
  484. <A NAME="skip-navbar_bottom"></A>
  485. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  486.  
  487. <HR>
  488. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  489. </BODY>
  490. </HTML>
  491.