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:39 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. SearchTerm (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="SearchTerm (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/SearchTerm.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/SearchException.html" title="class in javax.mail.search"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../javax/mail/search/SentDateTerm.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/SearchTerm.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="SearchTerm.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.search</FONT>
  93. <BR>
  94. Class SearchTerm</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.search.SearchTerm</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/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm</A>, <A HREF="../../../javax/mail/search/AndTerm.html" title="class in javax.mail.search">AndTerm</A>, <A HREF="../../../javax/mail/search/ComparisonTerm.html" title="class in javax.mail.search">ComparisonTerm</A>, <A HREF="../../../javax/mail/search/FlagTerm.html" title="class in javax.mail.search">FlagTerm</A>, <A HREF="../../../javax/mail/search/NotTerm.html" title="class in javax.mail.search">NotTerm</A>, <A HREF="../../../javax/mail/search/OrTerm.html" title="class in javax.mail.search">OrTerm</A>, <A HREF="../../../javax/mail/search/StringTerm.html" title="class in javax.mail.search">StringTerm</A></DD>
  104. </DL>
  105. <HR>
  106. <DL>
  107. <DT><PRE>public abstract class <B>SearchTerm</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. Search criteria are expressed as a tree of search-terms, forming
  112.  a parse-tree for the search expression. <p>
  113.  
  114.  Search-terms are represented by this class. This is an abstract
  115.  class; subclasses implement specific match methods. <p>
  116.  
  117.  Search terms are serializable, which allows storing a search term
  118.  between sessions.
  119.  
  120.  <strong>Warning:</strong>
  121.  Serialized objects of this class may not be compatible with future
  122.  JavaMail API releases.  The current serialization support is
  123.  appropriate for short term storage. <p>
  124.  
  125.  <strong>Warning:</strong>
  126.  Search terms that include references to objects of type
  127.  <code>Message.RecipientType</code> will not be deserialized
  128.  correctly on JDK 1.1 systems.  While these objects will be deserialized
  129.  without throwing any exceptions, the resulting objects violate the
  130.  <i>type-safe enum</i> contract of the <code>Message.RecipientType</code>
  131.  class.  Proper deserialization of these objects depends on support
  132.  for the <code>readReplace</code> method, added in JDK 1.2.
  133. <P>
  134.  
  135. <P>
  136. <DL>
  137. <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#javax.mail.search.SearchTerm">Serialized Form</A></DL>
  138. <HR>
  139.  
  140. <P>
  141.  
  142. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  143.  
  144. <A NAME="constructor_summary"><!-- --></A>
  145. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  146. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  147. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  148. <B>Constructor Summary</B></FONT></TH>
  149. </TR>
  150. <TR BGCOLOR="white" CLASS="TableRowColor">
  151. <TD><CODE><B><A HREF="../../../javax/mail/search/SearchTerm.html#SearchTerm()">SearchTerm</A></B>()</CODE>
  152.  
  153. <BR>
  154. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  155. </TR>
  156. </TABLE>
  157. &nbsp;
  158. <!-- ========== METHOD SUMMARY =========== -->
  159.  
  160. <A NAME="method_summary"><!-- --></A>
  161. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  162. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  163. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  164. <B>Method Summary</B></FONT></TH>
  165. </TR>
  166. <TR BGCOLOR="white" CLASS="TableRowColor">
  167. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  168. <CODE>abstract &nbsp;boolean</CODE></FONT></TD>
  169. <TD><CODE><B><A HREF="../../../javax/mail/search/SearchTerm.html#match(javax.mail.Message)">match</A></B>(<A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;msg)</CODE>
  170.  
  171. <BR>
  172. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method applies a specific match criterion to the given
  173.  message and returns the result.</TD>
  174. </TR>
  175. </TABLE>
  176. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  177. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  178. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  179. <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>
  180. </TR>
  181. <TR BGCOLOR="white" CLASS="TableRowColor">
  182. <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#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>
  183. </TR>
  184. </TABLE>
  185. &nbsp;
  186. <P>
  187.  
  188. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  189.  
  190. <A NAME="constructor_detail"><!-- --></A>
  191. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  192. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  193. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  194. <B>Constructor Detail</B></FONT></TH>
  195. </TR>
  196. </TABLE>
  197.  
  198. <A NAME="SearchTerm()"><!-- --></A><H3>
  199. SearchTerm</H3>
  200. <PRE>
  201. public <B>SearchTerm</B>()</PRE>
  202. <DL>
  203. </DL>
  204.  
  205. <!-- ============ METHOD DETAIL ========== -->
  206.  
  207. <A NAME="method_detail"><!-- --></A>
  208. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  209. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  210. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  211. <B>Method Detail</B></FONT></TH>
  212. </TR>
  213. </TABLE>
  214.  
  215. <A NAME="match(javax.mail.Message)"><!-- --></A><H3>
  216. match</H3>
  217. <PRE>
  218. public abstract boolean <B>match</B>(<A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;msg)</PRE>
  219. <DL>
  220. <DD>This method applies a specific match criterion to the given
  221.  message and returns the result.
  222. <P>
  223. <DD><DL>
  224. </DL>
  225. </DD>
  226. <DD><DL>
  227. <DT><B>Parameters:</B><DD><CODE>msg</CODE> - The match criterion is applied on this message
  228. <DT><B>Returns:</B><DD>true, it the match succeeds, false if the match fails</DL>
  229. </DD>
  230. </DL>
  231. <!-- ========= END OF CLASS DATA ========= -->
  232. <HR>
  233.  
  234.  
  235. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  236. <A NAME="navbar_bottom"><!-- --></A>
  237. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  238. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  239. <TR>
  240. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  241. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  242. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  243.   <TR ALIGN="center" VALIGN="top">
  244.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  245.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  246.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  247.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SearchTerm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  248.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  249.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  250.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  251.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  252.   </TR>
  253. </TABLE>
  254. </TD>
  255. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  256. </EM>
  257. </TD>
  258. </TR>
  259.  
  260. <TR>
  261. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  262. &nbsp;<A HREF="../../../javax/mail/search/SearchException.html" title="class in javax.mail.search"><B>PREV CLASS</B></A>&nbsp;
  263. &nbsp;<A HREF="../../../javax/mail/search/SentDateTerm.html" title="class in javax.mail.search"><B>NEXT CLASS</B></A></FONT></TD>
  264. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  265.   <A HREF="../../../index.html?javax/mail/search/SearchTerm.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  266. &nbsp;<A HREF="SearchTerm.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  267. &nbsp;<SCRIPT type="text/javascript">
  268.   <!--
  269.   if(window==top) {
  270.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  271.   }
  272.   //-->
  273. </SCRIPT>
  274. <NOSCRIPT>
  275.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  276. </NOSCRIPT>
  277.  
  278.  
  279. </FONT></TD>
  280. </TR>
  281. <TR>
  282. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  283.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  284. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  285. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  286. </TR>
  287. </TABLE>
  288. <A NAME="skip-navbar_bottom"></A>
  289. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  290.  
  291. <HR>
  292. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  293. </BODY>
  294. </HTML>
  295.