source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/email/EmailAddress.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 12.9 KB
Line 
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.4.2_13) on Mon Oct 01 14:33:23 NZST 2007 -->
6<TITLE>
7EmailAddress (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.email.EmailAddress class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="EmailAddress (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html" title="class in org.apache.tools.ant.taskdefs.email"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="EmailAddress.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.email</FONT>
85<BR>
86Class EmailAddress</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.email.EmailAddress</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>EmailAddress</B><DT>extends java.lang.Object</DL>
94
95<P>
96Holds an email address.
97<P>
98
99<P>
100<DL>
101<DT><B>Since:</B></DT>
102 <DD>Ant 1.5</DD>
103</DL>
104<HR>
105
106<P>
107<!-- ======== NESTED CLASS SUMMARY ======== -->
108
109
110<!-- =========== FIELD SUMMARY =========== -->
111
112
113<!-- ======== CONSTRUCTOR SUMMARY ======== -->
114
115<A NAME="constructor_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Constructor Summary</B></FONT></TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#EmailAddress()">EmailAddress</A></B>()</CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an empty email address</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#EmailAddress(java.lang.String)">EmailAddress</A></B>(java.lang.String&nbsp;email)</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new email address based on the given string</TD>
132</TR>
133</TABLE>
134&nbsp;
135<!-- ========== METHOD SUMMARY =========== -->
136
137<A NAME="method_summary"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140<TD COLSPAN=2><FONT SIZE="+2">
141<B>Method Summary</B></FONT></TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#getAddress()">getAddress</A></B>()</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the address</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#getName()">getName</A></B>()</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the display name</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;void</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#setAddress(java.lang.String)">setAddress</A></B>(java.lang.String&nbsp;address)</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the email address</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the personal / display name of the address</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html#toString()">toString</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a string "name &lt;address&gt;" or "address"</TD>
182</TR>
183</TABLE>
184&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
187<TD><B>Methods inherited from class java.lang.Object</B></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
191</TR>
192</TABLE>
193&nbsp;
194<P>
195
196<!-- ============ FIELD DETAIL =========== -->
197
198
199<!-- ========= CONSTRUCTOR DETAIL ======== -->
200
201<A NAME="constructor_detail"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204<TD COLSPAN=1><FONT SIZE="+2">
205<B>Constructor Detail</B></FONT></TD>
206</TR>
207</TABLE>
208
209<A NAME="EmailAddress()"><!-- --></A><H3>
210EmailAddress</H3>
211<PRE>
212public <B>EmailAddress</B>()</PRE>
213<DL>
214<DD>Creates an empty email address
215<P>
216</DL>
217<HR>
218
219<A NAME="EmailAddress(java.lang.String)"><!-- --></A><H3>
220EmailAddress</H3>
221<PRE>
222public <B>EmailAddress</B>(java.lang.String&nbsp;email)</PRE>
223<DL>
224<DD>Creates a new email address based on the given string
225<P>
226<DT><B>Parameters:</B><DD><CODE>email</CODE> - the email address (with or without <>)
227 Acceptable forms include:
228 address
229 <address>
230 name <address>
231 <address> name
232 (name) address
233 address (name)</DL>
234
235<!-- ============ METHOD DETAIL ========== -->
236
237<A NAME="method_detail"><!-- --></A>
238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
240<TD COLSPAN=1><FONT SIZE="+2">
241<B>Method Detail</B></FONT></TD>
242</TR>
243</TABLE>
244
245<A NAME="setName(java.lang.String)"><!-- --></A><H3>
246setName</H3>
247<PRE>
248public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
249<DL>
250<DD>Sets the personal / display name of the address
251<P>
252<DD><DL>
253<DT><B>Parameters:</B><DD><CODE>name</CODE> - the display name</DL>
254</DD>
255</DL>
256<HR>
257
258<A NAME="setAddress(java.lang.String)"><!-- --></A><H3>
259setAddress</H3>
260<PRE>
261public void <B>setAddress</B>(java.lang.String&nbsp;address)</PRE>
262<DL>
263<DD>Sets the email address
264<P>
265<DD><DL>
266<DT><B>Parameters:</B><DD><CODE>address</CODE> - the actual email address (without <>)</DL>
267</DD>
268</DL>
269<HR>
270
271<A NAME="toString()"><!-- --></A><H3>
272toString</H3>
273<PRE>
274public java.lang.String <B>toString</B>()</PRE>
275<DL>
276<DD>Constructs a string "name &lt;address&gt;" or "address"
277<P>
278<DD><DL>
279
280<DT><B>Returns:</B><DD>a string representation of the address</DL>
281</DD>
282</DL>
283<HR>
284
285<A NAME="getAddress()"><!-- --></A><H3>
286getAddress</H3>
287<PRE>
288public java.lang.String <B>getAddress</B>()</PRE>
289<DL>
290<DD>Returns the address
291<P>
292<DD><DL>
293
294<DT><B>Returns:</B><DD>the address part</DL>
295</DD>
296</DL>
297<HR>
298
299<A NAME="getName()"><!-- --></A><H3>
300getName</H3>
301<PRE>
302public java.lang.String <B>getName</B>()</PRE>
303<DL>
304<DD>Returns the display name
305<P>
306<DD><DL>
307
308<DT><B>Returns:</B><DD>the display name part</DL>
309</DD>
310</DL>
311<!-- ========= END OF CLASS DATA ========= -->
312<HR>
313
314
315<!-- ======= START OF BOTTOM NAVBAR ====== -->
316<A NAME="navbar_bottom"><!-- --></A>
317<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
318<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
319<TR>
320<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
321<A NAME="navbar_bottom_firstrow"><!-- --></A>
322<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
323 <TR ALIGN="center" VALIGN="top">
324 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
325 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
326 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
327 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
329 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
330 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
331 </TR>
332</TABLE>
333</TD>
334<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
335</EM>
336</TD>
337</TR>
338
339<TR>
340<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
341&nbsp;PREV CLASS&nbsp;
342&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html" title="class in org.apache.tools.ant.taskdefs.email"><B>NEXT CLASS</B></A></FONT></TD>
343<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
344 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
345&nbsp;<A HREF="EmailAddress.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
346&nbsp;<SCRIPT type="text/javascript">
347 <!--
348 if(window==top) {
349 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
350 }
351 //-->
352</SCRIPT>
353<NOSCRIPT>
354 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
355</NOSCRIPT>
356
357</FONT></TD>
358</TR>
359<TR>
360<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
361 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
362<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
363DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
364</TR>
365</TABLE>
366<A NAME="skip-navbar_bottom"></A>
367<!-- ======== END OF BOTTOM NAVBAR ======= -->
368
369<HR>
370Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
371</BODY>
372</HTML>
Note: See TracBrowser for help on using the repository browser.