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:37 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. Address (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="Address (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/Address.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;PREV CLASS&nbsp;
  60. &nbsp;<A HREF="../../javax/mail/AuthenticationFailedException.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../index.html?javax/mail/Address.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="Address.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</FONT>
  93. <BR>
  94. Class Address</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.Address</B>
  98. </PRE>
  99. <DL>
  100. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
  101. </DL>
  102. <DL>
  103. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../javax/mail/internet/InternetAddress.html" title="class in javax.mail.internet">InternetAddress</A>, <A HREF="../../javax/mail/internet/NewsAddress.html" title="class in javax.mail.internet">NewsAddress</A></DD>
  104. </DL>
  105. <HR>
  106. <DL>
  107. <DT><PRE>public abstract class <B>Address</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><DT>implements <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
  108. </PRE>
  109.  
  110. <P>
  111. This abstract class models the addresses in a message.
  112.  Subclasses provide specific implementations.  Subclasses
  113.  will typically be serializable so that (for example) the
  114.  use of Address objects in search terms can be serialized
  115.  along with the search terms.
  116. <P>
  117.  
  118. <P>
  119. <DL>
  120. <DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.mail.Address">Serialized Form</A></DL>
  121. <HR>
  122.  
  123. <P>
  124.  
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126.  
  127. <A NAME="constructor_summary"><!-- --></A>
  128. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  129. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  130. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  131. <B>Constructor Summary</B></FONT></TH>
  132. </TR>
  133. <TR BGCOLOR="white" CLASS="TableRowColor">
  134. <TD><CODE><B><A HREF="../../javax/mail/Address.html#Address()">Address</A></B>()</CODE>
  135.  
  136. <BR>
  137. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  138. </TR>
  139. </TABLE>
  140. &nbsp;
  141. <!-- ========== METHOD SUMMARY =========== -->
  142.  
  143. <A NAME="method_summary"><!-- --></A>
  144. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  145. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  146. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  147. <B>Method Summary</B></FONT></TH>
  148. </TR>
  149. <TR BGCOLOR="white" CLASS="TableRowColor">
  150. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  151. <CODE>abstract &nbsp;boolean</CODE></FONT></TD>
  152. <TD><CODE><B><A HREF="../../javax/mail/Address.html#equals(java.lang.Object)">equals</A></B>(<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>&nbsp;address)</CODE>
  153.  
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The equality operator.</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>abstract &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>
  160. <TD><CODE><B><A HREF="../../javax/mail/Address.html#getType()">getType</A></B>()</CODE>
  161.  
  162. <BR>
  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a type string that identifies this address type.</TD>
  164. </TR>
  165. <TR BGCOLOR="white" CLASS="TableRowColor">
  166. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  167. <CODE>abstract &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>
  168. <TD><CODE><B><A HREF="../../javax/mail/Address.html#toString()">toString</A></B>()</CODE>
  169.  
  170. <BR>
  171. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a String representation of this address object.</TD>
  172. </TR>
  173. </TABLE>
  174. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  175. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  176. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  177. <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>
  178. </TR>
  179. <TR BGCOLOR="white" CLASS="TableRowColor">
  180. <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#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>
  181. </TR>
  182. </TABLE>
  183. &nbsp;
  184. <P>
  185.  
  186. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  187.  
  188. <A NAME="constructor_detail"><!-- --></A>
  189. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  190. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  191. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  192. <B>Constructor Detail</B></FONT></TH>
  193. </TR>
  194. </TABLE>
  195.  
  196. <A NAME="Address()"><!-- --></A><H3>
  197. Address</H3>
  198. <PRE>
  199. public <B>Address</B>()</PRE>
  200. <DL>
  201. </DL>
  202.  
  203. <!-- ============ METHOD DETAIL ========== -->
  204.  
  205. <A NAME="method_detail"><!-- --></A>
  206. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  207. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  208. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  209. <B>Method Detail</B></FONT></TH>
  210. </TR>
  211. </TABLE>
  212.  
  213. <A NAME="getType()"><!-- --></A><H3>
  214. getType</H3>
  215. <PRE>
  216. public abstract <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>getType</B>()</PRE>
  217. <DL>
  218. <DD>Return a type string that identifies this address type.
  219. <P>
  220. <DD><DL>
  221. </DL>
  222. </DD>
  223. <DD><DL>
  224.  
  225. <DT><B>Returns:</B><DD>address type<DT><B>See Also:</B><DD><A HREF="../../javax/mail/internet/InternetAddress.html" title="class in javax.mail.internet"><CODE>InternetAddress</CODE></A></DL>
  226. </DD>
  227. </DL>
  228. <HR>
  229.  
  230. <A NAME="toString()"><!-- --></A><H3>
  231. toString</H3>
  232. <PRE>
  233. public abstract <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>
  234. <DL>
  235. <DD>Return a String representation of this address object.
  236. <P>
  237. <DD><DL>
  238. <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>
  239. </DD>
  240. <DD><DL>
  241.  
  242. <DT><B>Returns:</B><DD>string representation of this address</DL>
  243. </DD>
  244. </DL>
  245. <HR>
  246.  
  247. <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
  248. equals</H3>
  249. <PRE>
  250. public abstract boolean <B>equals</B>(<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>&nbsp;address)</PRE>
  251. <DL>
  252. <DD>The equality operator.  Subclasses should provide an
  253.  implementation of this method that supports value equality
  254.  (do the two Address objects represent the same destination?),
  255.  not object reference equality.  A subclass must also provide
  256.  a corresponding implementation of the <code>hashCode</code>
  257.  method that preserves the general contract of
  258.  <code>equals</code> and <code>hashCode</code> - objects that
  259.  compare as equal must have the same hashCode.
  260. <P>
  261. <DD><DL>
  262. <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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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>
  263. </DD>
  264. <DD><DL>
  265. <DT><B>Parameters:</B><DD><CODE>address</CODE> - Address object</DL>
  266. </DD>
  267. </DL>
  268. <!-- ========= END OF CLASS DATA ========= -->
  269. <HR>
  270.  
  271.  
  272. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  273. <A NAME="navbar_bottom"><!-- --></A>
  274. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  275. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  276. <TR>
  277. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  278. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  279. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  280.   <TR ALIGN="center" VALIGN="top">
  281.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  282.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  283.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  284.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Address.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  285.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  286.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  287.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  288.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  289.   </TR>
  290. </TABLE>
  291. </TD>
  292. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  293. </EM>
  294. </TD>
  295. </TR>
  296.  
  297. <TR>
  298. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  299. &nbsp;PREV CLASS&nbsp;
  300. &nbsp;<A HREF="../../javax/mail/AuthenticationFailedException.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
  301. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  302.   <A HREF="../../index.html?javax/mail/Address.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  303. &nbsp;<A HREF="Address.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  304. &nbsp;<SCRIPT type="text/javascript">
  305.   <!--
  306.   if(window==top) {
  307.     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  308.   }
  309.   //-->
  310. </SCRIPT>
  311. <NOSCRIPT>
  312.   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  313. </NOSCRIPT>
  314.  
  315.  
  316. </FONT></TD>
  317. </TR>
  318. <TR>
  319. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  320.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  321. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  322. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  323. </TR>
  324. </TABLE>
  325. <A NAME="skip-navbar_bottom"></A>
  326. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  327.  
  328. <HR>
  329. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  330. </BODY>
  331. </HTML>
  332.