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