Subversion Repositories javautils

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
7 daniel-mar 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:39 PST 2009 -->
6
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7
<TITLE>
8
FromTerm (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="FromTerm (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/FromTerm.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/search/FromStringTerm.html" title="class in javax.mail.search"><B>PREV CLASS</B></A>&nbsp;
60
&nbsp;<A HREF="../../../javax/mail/search/HeaderTerm.html" title="class in javax.mail.search"><B>NEXT CLASS</B></A></FONT></TD>
61
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62
  <A HREF="../../../index.html?javax/mail/search/FromTerm.html" target="_top"><B>FRAMES</B></A>  &nbsp;
63
&nbsp;<A HREF="FromTerm.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;<A HREF="#fields_inherited_from_class_javax.mail.search.AddressTerm">FIELD</A>&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.search</FONT>
93
<BR>
94
Class FromTerm</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 "><A HREF="../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">javax.mail.search.SearchTerm</A>
98
      <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">javax.mail.search.AddressTerm</A>
99
          <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.mail.search.FromTerm</B>
100
</PRE>
101
<DL>
102
<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>
103
</DL>
104
<HR>
105
<DL>
106
<DT><PRE>public final class <B>FromTerm</B><DT>extends <A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm</A></DL>
107
</PRE>
108
 
109
<P>
110
This class implements comparisons for the From Address header.
111
<P>
112
 
113
<P>
114
<DL>
115
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#javax.mail.search.FromTerm">Serialized Form</A></DL>
116
<HR>
117
 
118
<P>
119
<!-- =========== FIELD SUMMARY =========== -->
120
 
121
<A NAME="field_summary"><!-- --></A>
122
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125
<B>Field Summary</B></FONT></TH>
126
</TR>
127
</TABLE>
128
&nbsp;<A NAME="fields_inherited_from_class_javax.mail.search.AddressTerm"><!-- --></A>
129
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
131
<TH ALIGN="left"><B>Fields inherited from class javax.mail.search.<A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm</A></B></TH>
132
</TR>
133
<TR BGCOLOR="white" CLASS="TableRowColor">
134
<TD><CODE><A HREF="../../../javax/mail/search/AddressTerm.html#address">address</A></CODE></TD>
135
</TR>
136
</TABLE>
137
&nbsp;
138
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
139
 
140
<A NAME="constructor_summary"><!-- --></A>
141
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
143
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
144
<B>Constructor Summary</B></FONT></TH>
145
</TR>
146
<TR BGCOLOR="white" CLASS="TableRowColor">
147
<TD><CODE><B><A HREF="../../../javax/mail/search/FromTerm.html#FromTerm(javax.mail.Address)">FromTerm</A></B>(<A HREF="../../../javax/mail/Address.html" title="class in javax.mail">Address</A>&nbsp;address)</CODE>
148
 
149
<BR>
150
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor</TD>
151
</TR>
152
</TABLE>
153
&nbsp;
154
<!-- ========== METHOD SUMMARY =========== -->
155
 
156
<A NAME="method_summary"><!-- --></A>
157
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
159
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
160
<B>Method Summary</B></FONT></TH>
161
</TR>
162
<TR BGCOLOR="white" CLASS="TableRowColor">
163
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164
<CODE>&nbsp;boolean</CODE></FONT></TD>
165
<TD><CODE><B><A HREF="../../../javax/mail/search/FromTerm.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;obj)</CODE>
166
 
167
<BR>
168
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Equality comparison.</TD>
169
</TR>
170
<TR BGCOLOR="white" CLASS="TableRowColor">
171
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172
<CODE>&nbsp;boolean</CODE></FONT></TD>
173
<TD><CODE><B><A HREF="../../../javax/mail/search/FromTerm.html#match(javax.mail.Message)">match</A></B>(<A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;msg)</CODE>
174
 
175
<BR>
176
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The address comparator.</TD>
177
</TR>
178
</TABLE>
179
&nbsp;<A NAME="methods_inherited_from_class_javax.mail.search.AddressTerm"><!-- --></A>
180
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
182
<TH ALIGN="left"><B>Methods inherited from class javax.mail.search.<A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm</A></B></TH>
183
</TR>
184
<TR BGCOLOR="white" CLASS="TableRowColor">
185
<TD><CODE><A HREF="../../../javax/mail/search/AddressTerm.html#getAddress()">getAddress</A>, <A HREF="../../../javax/mail/search/AddressTerm.html#hashCode()">hashCode</A>, <A HREF="../../../javax/mail/search/AddressTerm.html#match(javax.mail.Address)">match</A></CODE></TD>
186
</TR>
187
</TABLE>
188
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
189
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
191
<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>
192
</TR>
193
<TR BGCOLOR="white" CLASS="TableRowColor">
194
<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#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#toString()" title="class or interface in java.lang">toString</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>
195
</TR>
196
</TABLE>
197
&nbsp;
198
<P>
199
 
200
<!-- ========= CONSTRUCTOR DETAIL ======== -->
201
 
202
<A NAME="constructor_detail"><!-- --></A>
203
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
205
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
206
<B>Constructor Detail</B></FONT></TH>
207
</TR>
208
</TABLE>
209
 
210
<A NAME="FromTerm(javax.mail.Address)"><!-- --></A><H3>
211
FromTerm</H3>
212
<PRE>
213
public <B>FromTerm</B>(<A HREF="../../../javax/mail/Address.html" title="class in javax.mail">Address</A>&nbsp;address)</PRE>
214
<DL>
215
<DD>Constructor
216
<P>
217
<DL>
218
<DT><B>Parameters:</B><DD><CODE>address</CODE> - The Address to be compared</DL>
219
</DL>
220
 
221
<!-- ============ METHOD DETAIL ========== -->
222
 
223
<A NAME="method_detail"><!-- --></A>
224
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
225
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
226
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
227
<B>Method Detail</B></FONT></TH>
228
</TR>
229
</TABLE>
230
 
231
<A NAME="match(javax.mail.Message)"><!-- --></A><H3>
232
match</H3>
233
<PRE>
234
public boolean <B>match</B>(<A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;msg)</PRE>
235
<DL>
236
<DD>The address comparator.
237
<P>
238
<DD><DL>
239
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/mail/search/SearchTerm.html#match(javax.mail.Message)">match</A></CODE> in class <CODE><A HREF="../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm</A></CODE></DL>
240
</DD>
241
<DD><DL>
242
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The address comparison is applied to this Message
243
<DT><B>Returns:</B><DD>true if the comparison succeeds, otherwise false</DL>
244
</DD>
245
</DL>
246
<HR>
247
 
248
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
249
equals</H3>
250
<PRE>
251
public 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;obj)</PRE>
252
<DL>
253
<DD>Equality comparison.
254
<P>
255
<DD><DL>
256
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/mail/search/AddressTerm.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm</A></CODE></DL>
257
</DD>
258
<DD><DL>
259
</DL>
260
</DD>
261
</DL>
262
<!-- ========= END OF CLASS DATA ========= -->
263
<HR>
264
 
265
 
266
<!-- ======= START OF BOTTOM NAVBAR ====== -->
267
<A NAME="navbar_bottom"><!-- --></A>
268
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
269
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
270
<TR>
271
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
272
<A NAME="navbar_bottom_firstrow"><!-- --></A>
273
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
274
  <TR ALIGN="center" VALIGN="top">
275
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
276
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
277
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
278
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FromTerm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
279
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
280
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
281
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
282
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
283
  </TR>
284
</TABLE>
285
</TD>
286
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
287
</EM>
288
</TD>
289
</TR>
290
 
291
<TR>
292
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
293
&nbsp;<A HREF="../../../javax/mail/search/FromStringTerm.html" title="class in javax.mail.search"><B>PREV CLASS</B></A>&nbsp;
294
&nbsp;<A HREF="../../../javax/mail/search/HeaderTerm.html" title="class in javax.mail.search"><B>NEXT CLASS</B></A></FONT></TD>
295
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
296
  <A HREF="../../../index.html?javax/mail/search/FromTerm.html" target="_top"><B>FRAMES</B></A>  &nbsp;
297
&nbsp;<A HREF="FromTerm.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
298
&nbsp;<SCRIPT type="text/javascript">
299
  <!--
300
  if(window==top) {
301
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
302
  }
303
  //-->
304
</SCRIPT>
305
<NOSCRIPT>
306
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
307
</NOSCRIPT>
308
 
309
 
310
</FONT></TD>
311
</TR>
312
<TR>
313
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
314
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_javax.mail.search.AddressTerm">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
315
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
316
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
317
</TR>
318
</TABLE>
319
<A NAME="skip-navbar_bottom"></A>
320
<!-- ======== END OF BOTTOM NAVBAR ======= -->
321
 
322
<HR>
323
Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
324
</BODY>
325
</HTML>