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. Flags (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="Flags (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/Flags.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/FetchProfile.Item.html" title="class in javax.mail"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../javax/mail/Flags.Flag.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/Flags.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="Flags.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;<A HREF="#nested_class_summary">NESTED</A>&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 Flags</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.Flags</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>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD>
  101. </DL>
  102. <HR>
  103. <DL>
  104. <DT><PRE>public class <B>Flags</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/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <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>
  105. </PRE>
  106.  
  107. <P>
  108. The Flags class represents the set of flags on a Message.  Flags
  109.  are composed of predefined system flags, and user defined flags. <p>
  110.  
  111.  A System flag is represented by the <code>Flags.Flag</code>
  112.  inner class. A User defined flag is represented as a String.
  113.  User flags are case-independent. <p>
  114.  
  115.  A set of standard system flags are predefined.  Most folder
  116.  implementations are expected to support these flags.  Some
  117.  implementations may also support arbitrary user-defined flags.  The
  118.  <code>getPermanentFlags</code> method on a Folder returns a Flags
  119.  object that holds all the flags that are supported by that folder
  120.  implementation. <p>
  121.  
  122.  A Flags object is serializable so that (for example) the
  123.  use of Flags objects in search terms can be serialized
  124.  along with the search terms. <p>
  125.  
  126.  <strong>Warning:</strong>
  127.  Serialized objects of this class may not be compatible with future
  128.  JavaMail API releases.  The current serialization support is
  129.  appropriate for short term storage. <p>
  130.  
  131.  The below code sample illustrates how to set, examine and get the
  132.  flags for a message. <p>
  133.  <pre>
  134.  
  135.  Message m = folder.getMessage(1);
  136.  m.setFlag(Flags.Flag.DELETED, true); // set the DELETED flag
  137.  
  138.  // Check if DELETED flag is set of this message
  139.  if (m.isSet(Flags.Flag.DELETED))
  140.         System.out.println("DELETED message");
  141.  
  142.  // Examine ALL system flags for this message
  143.  Flags flags = m.getFlags();
  144.  Flags.Flag[] sf = flags.getSystemFlags();
  145.  for (int i = 0; i < sf.length; i++) {
  146.         if (sf[i] == Flags.Flag.DELETED)
  147.             System.out.println("DELETED message");
  148.         else if (sf[i] == Flags.Flag.SEEN)
  149.             System.out.println("SEEN message");
  150.       ......
  151.       ......
  152.  }
  153.  </pre>
  154.  <p>
  155. <P>
  156.  
  157. <P>
  158. <DL>
  159. <DT><B>See Also:</B><DD><A HREF="../../javax/mail/Folder.html#getPermanentFlags()"><CODE>Folder.getPermanentFlags()</CODE></A>,
  160. <A HREF="../../serialized-form.html#javax.mail.Flags">Serialized Form</A></DL>
  161. <HR>
  162.  
  163. <P>
  164. <!-- ======== NESTED CLASS SUMMARY ======== -->
  165.  
  166. <A NAME="nested_class_summary"><!-- --></A>
  167. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  168. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  169. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  170. <B>Nested Class Summary</B></FONT></TH>
  171. </TR>
  172. <TR BGCOLOR="white" CLASS="TableRowColor">
  173. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  174. <CODE>static&nbsp;class</CODE></FONT></TD>
  175. <TD><CODE><B><A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A></B></CODE>
  176.  
  177. <BR>
  178. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This inner class represents an individual system flag.</TD>
  179. </TR>
  180. </TABLE>
  181. &nbsp;
  182. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  183.  
  184. <A NAME="constructor_summary"><!-- --></A>
  185. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  186. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  187. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  188. <B>Constructor Summary</B></FONT></TH>
  189. </TR>
  190. <TR BGCOLOR="white" CLASS="TableRowColor">
  191. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#Flags()">Flags</A></B>()</CODE>
  192.  
  193. <BR>
  194. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an empty Flags object.</TD>
  195. </TR>
  196. <TR BGCOLOR="white" CLASS="TableRowColor">
  197. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#Flags(javax.mail.Flags.Flag)">Flags</A></B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</CODE>
  198.  
  199. <BR>
  200. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Flags object initialized with the given system flag.</TD>
  201. </TR>
  202. <TR BGCOLOR="white" CLASS="TableRowColor">
  203. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#Flags(javax.mail.Flags)">Flags</A></B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;flags)</CODE>
  204.  
  205. <BR>
  206. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Flags object initialized with the given flags.</TD>
  207. </TR>
  208. <TR BGCOLOR="white" CLASS="TableRowColor">
  209. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#Flags(java.lang.String)">Flags</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;flag)</CODE>
  210.  
  211. <BR>
  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Flags object initialized with the given user flag.</TD>
  213. </TR>
  214. </TABLE>
  215. &nbsp;
  216. <!-- ========== METHOD SUMMARY =========== -->
  217.  
  218. <A NAME="method_summary"><!-- --></A>
  219. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  220. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  221. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  222. <B>Method Summary</B></FONT></TH>
  223. </TR>
  224. <TR BGCOLOR="white" CLASS="TableRowColor">
  225. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  226. <CODE>&nbsp;void</CODE></FONT></TD>
  227. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#add(javax.mail.Flags.Flag)">add</A></B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</CODE>
  228.  
  229. <BR>
  230. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add the specified system flag to this Flags object.</TD>
  231. </TR>
  232. <TR BGCOLOR="white" CLASS="TableRowColor">
  233. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  234. <CODE>&nbsp;void</CODE></FONT></TD>
  235. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#add(javax.mail.Flags)">add</A></B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;f)</CODE>
  236.  
  237. <BR>
  238. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add all the flags in the given Flags object to this
  239.  Flags object.</TD>
  240. </TR>
  241. <TR BGCOLOR="white" CLASS="TableRowColor">
  242. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  243. <CODE>&nbsp;void</CODE></FONT></TD>
  244. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#add(java.lang.String)">add</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;flag)</CODE>
  245.  
  246. <BR>
  247. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add the specified user flag to this Flags object.</TD>
  248. </TR>
  249. <TR BGCOLOR="white" CLASS="TableRowColor">
  250. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  251. <CODE>&nbsp;<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></FONT></TD>
  252. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#clone()">clone</A></B>()</CODE>
  253.  
  254. <BR>
  255. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a clone of this Flags object.</TD>
  256. </TR>
  257. <TR BGCOLOR="white" CLASS="TableRowColor">
  258. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  259. <CODE>&nbsp;boolean</CODE></FONT></TD>
  260. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#contains(javax.mail.Flags.Flag)">contains</A></B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</CODE>
  261.  
  262. <BR>
  263. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether the specified system flag is present in this Flags object.</TD>
  264. </TR>
  265. <TR BGCOLOR="white" CLASS="TableRowColor">
  266. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  267. <CODE>&nbsp;boolean</CODE></FONT></TD>
  268. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#contains(javax.mail.Flags)">contains</A></B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;f)</CODE>
  269.  
  270. <BR>
  271. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether all the flags in the specified Flags object are
  272.  present in this Flags object.</TD>
  273. </TR>
  274. <TR BGCOLOR="white" CLASS="TableRowColor">
  275. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  276. <CODE>&nbsp;boolean</CODE></FONT></TD>
  277. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#contains(java.lang.String)">contains</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;flag)</CODE>
  278.  
  279. <BR>
  280. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether the specified user flag is present in this Flags object.</TD>
  281. </TR>
  282. <TR BGCOLOR="white" CLASS="TableRowColor">
  283. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  284. <CODE>&nbsp;boolean</CODE></FONT></TD>
  285. <TD><CODE><B><A HREF="../../javax/mail/Flags.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>
  286.  
  287. <BR>
  288. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether the two Flags objects are equal.</TD>
  289. </TR>
  290. <TR BGCOLOR="white" CLASS="TableRowColor">
  291. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  292. <CODE>&nbsp;<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>[]</CODE></FONT></TD>
  293. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#getSystemFlags()">getSystemFlags</A></B>()</CODE>
  294.  
  295. <BR>
  296. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return all the system flags in this Flags object.</TD>
  297. </TR>
  298. <TR BGCOLOR="white" CLASS="TableRowColor">
  299. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  300. <CODE>&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>
  301. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#getUserFlags()">getUserFlags</A></B>()</CODE>
  302.  
  303. <BR>
  304. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return all the user flags in this Flags object.</TD>
  305. </TR>
  306. <TR BGCOLOR="white" CLASS="TableRowColor">
  307. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  308. <CODE>&nbsp;int</CODE></FONT></TD>
  309. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#hashCode()">hashCode</A></B>()</CODE>
  310.  
  311. <BR>
  312. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compute a hash code for this Flags object.</TD>
  313. </TR>
  314. <TR BGCOLOR="white" CLASS="TableRowColor">
  315. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  316. <CODE>&nbsp;void</CODE></FONT></TD>
  317. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#remove(javax.mail.Flags.Flag)">remove</A></B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</CODE>
  318.  
  319. <BR>
  320. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove the specified system flag from this Flags object.</TD>
  321. </TR>
  322. <TR BGCOLOR="white" CLASS="TableRowColor">
  323. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  324. <CODE>&nbsp;void</CODE></FONT></TD>
  325. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#remove(javax.mail.Flags)">remove</A></B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;f)</CODE>
  326.  
  327. <BR>
  328. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove all flags in the given Flags object from this
  329.  Flags object.</TD>
  330. </TR>
  331. <TR BGCOLOR="white" CLASS="TableRowColor">
  332. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  333. <CODE>&nbsp;void</CODE></FONT></TD>
  334. <TD><CODE><B><A HREF="../../javax/mail/Flags.html#remove(java.lang.String)">remove</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;flag)</CODE>
  335.  
  336. <BR>
  337. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove the specified user flag from this Flags object.</TD>
  338. </TR>
  339. </TABLE>
  340. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  341. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  342. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  343. <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>
  344. </TR>
  345. <TR BGCOLOR="white" CLASS="TableRowColor">
  346. <TD><CODE><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>
  347. </TR>
  348. </TABLE>
  349. &nbsp;
  350. <P>
  351.  
  352. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  353.  
  354. <A NAME="constructor_detail"><!-- --></A>
  355. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  356. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  357. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  358. <B>Constructor Detail</B></FONT></TH>
  359. </TR>
  360. </TABLE>
  361.  
  362. <A NAME="Flags()"><!-- --></A><H3>
  363. Flags</H3>
  364. <PRE>
  365. public <B>Flags</B>()</PRE>
  366. <DL>
  367. <DD>Construct an empty Flags object.
  368. <P>
  369. </DL>
  370. <HR>
  371.  
  372. <A NAME="Flags(javax.mail.Flags)"><!-- --></A><H3>
  373. Flags</H3>
  374. <PRE>
  375. public <B>Flags</B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;flags)</PRE>
  376. <DL>
  377. <DD>Construct a Flags object initialized with the given flags.
  378. <P>
  379. <DL>
  380. <DT><B>Parameters:</B><DD><CODE>flags</CODE> - the flags for initialization</DL>
  381. </DL>
  382. <HR>
  383.  
  384. <A NAME="Flags(javax.mail.Flags.Flag)"><!-- --></A><H3>
  385. Flags</H3>
  386. <PRE>
  387. public <B>Flags</B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</PRE>
  388. <DL>
  389. <DD>Construct a Flags object initialized with the given system flag.
  390. <P>
  391. <DL>
  392. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the flag for initialization</DL>
  393. </DL>
  394. <HR>
  395.  
  396. <A NAME="Flags(java.lang.String)"><!-- --></A><H3>
  397. Flags</H3>
  398. <PRE>
  399. public <B>Flags</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;flag)</PRE>
  400. <DL>
  401. <DD>Construct a Flags object initialized with the given user flag.
  402. <P>
  403. <DL>
  404. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the flag for initialization</DL>
  405. </DL>
  406.  
  407. <!-- ============ METHOD DETAIL ========== -->
  408.  
  409. <A NAME="method_detail"><!-- --></A>
  410. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  411. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  412. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  413. <B>Method Detail</B></FONT></TH>
  414. </TR>
  415. </TABLE>
  416.  
  417. <A NAME="add(javax.mail.Flags.Flag)"><!-- --></A><H3>
  418. add</H3>
  419. <PRE>
  420. public void <B>add</B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</PRE>
  421. <DL>
  422. <DD>Add the specified system flag to this Flags object.
  423. <P>
  424. <DD><DL>
  425. </DL>
  426. </DD>
  427. <DD><DL>
  428. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the flag to add</DL>
  429. </DD>
  430. </DL>
  431. <HR>
  432.  
  433. <A NAME="add(java.lang.String)"><!-- --></A><H3>
  434. add</H3>
  435. <PRE>
  436. public void <B>add</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;flag)</PRE>
  437. <DL>
  438. <DD>Add the specified user flag to this Flags object.
  439. <P>
  440. <DD><DL>
  441. </DL>
  442. </DD>
  443. <DD><DL>
  444. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the flag to add</DL>
  445. </DD>
  446. </DL>
  447. <HR>
  448.  
  449. <A NAME="add(javax.mail.Flags)"><!-- --></A><H3>
  450. add</H3>
  451. <PRE>
  452. public void <B>add</B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;f)</PRE>
  453. <DL>
  454. <DD>Add all the flags in the given Flags object to this
  455.  Flags object.
  456. <P>
  457. <DD><DL>
  458. </DL>
  459. </DD>
  460. <DD><DL>
  461. <DT><B>Parameters:</B><DD><CODE>f</CODE> - Flags object</DL>
  462. </DD>
  463. </DL>
  464. <HR>
  465.  
  466. <A NAME="remove(javax.mail.Flags.Flag)"><!-- --></A><H3>
  467. remove</H3>
  468. <PRE>
  469. public void <B>remove</B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</PRE>
  470. <DL>
  471. <DD>Remove the specified system flag from this Flags object.
  472. <P>
  473. <DD><DL>
  474. </DL>
  475. </DD>
  476. <DD><DL>
  477. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the flag to be removed</DL>
  478. </DD>
  479. </DL>
  480. <HR>
  481.  
  482. <A NAME="remove(java.lang.String)"><!-- --></A><H3>
  483. remove</H3>
  484. <PRE>
  485. public void <B>remove</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;flag)</PRE>
  486. <DL>
  487. <DD>Remove the specified user flag from this Flags object.
  488. <P>
  489. <DD><DL>
  490. </DL>
  491. </DD>
  492. <DD><DL>
  493. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the flag to be removed</DL>
  494. </DD>
  495. </DL>
  496. <HR>
  497.  
  498. <A NAME="remove(javax.mail.Flags)"><!-- --></A><H3>
  499. remove</H3>
  500. <PRE>
  501. public void <B>remove</B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;f)</PRE>
  502. <DL>
  503. <DD>Remove all flags in the given Flags object from this
  504.  Flags object.
  505. <P>
  506. <DD><DL>
  507. </DL>
  508. </DD>
  509. <DD><DL>
  510. <DT><B>Parameters:</B><DD><CODE>f</CODE> - the flag to be removed</DL>
  511. </DD>
  512. </DL>
  513. <HR>
  514.  
  515. <A NAME="contains(javax.mail.Flags.Flag)"><!-- --></A><H3>
  516. contains</H3>
  517. <PRE>
  518. public boolean <B>contains</B>(<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>&nbsp;flag)</PRE>
  519. <DL>
  520. <DD>Check whether the specified system flag is present in this Flags object.
  521. <P>
  522. <DD><DL>
  523. </DL>
  524. </DD>
  525. <DD><DL>
  526.  
  527. <DT><B>Returns:</B><DD>true of the given flag is present, otherwise false.</DL>
  528. </DD>
  529. </DL>
  530. <HR>
  531.  
  532. <A NAME="contains(java.lang.String)"><!-- --></A><H3>
  533. contains</H3>
  534. <PRE>
  535. public boolean <B>contains</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;flag)</PRE>
  536. <DL>
  537. <DD>Check whether the specified user flag is present in this Flags object.
  538. <P>
  539. <DD><DL>
  540. </DL>
  541. </DD>
  542. <DD><DL>
  543.  
  544. <DT><B>Returns:</B><DD>true of the given flag is present, otherwise false.</DL>
  545. </DD>
  546. </DL>
  547. <HR>
  548.  
  549. <A NAME="contains(javax.mail.Flags)"><!-- --></A><H3>
  550. contains</H3>
  551. <PRE>
  552. public boolean <B>contains</B>(<A HREF="../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;f)</PRE>
  553. <DL>
  554. <DD>Check whether all the flags in the specified Flags object are
  555.  present in this Flags object.
  556. <P>
  557. <DD><DL>
  558. </DL>
  559. </DD>
  560. <DD><DL>
  561.  
  562. <DT><B>Returns:</B><DD>true if all flags in the given Flags object are present,
  563.                 otherwise false.</DL>
  564. </DD>
  565. </DL>
  566. <HR>
  567.  
  568. <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
  569. equals</H3>
  570. <PRE>
  571. 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>
  572. <DL>
  573. <DD>Check whether the two Flags objects are equal.
  574. <P>
  575. <DD><DL>
  576. <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>
  577. </DD>
  578. <DD><DL>
  579.  
  580. <DT><B>Returns:</B><DD>true if they're equal</DL>
  581. </DD>
  582. </DL>
  583. <HR>
  584.  
  585. <A NAME="hashCode()"><!-- --></A><H3>
  586. hashCode</H3>
  587. <PRE>
  588. public int <B>hashCode</B>()</PRE>
  589. <DL>
  590. <DD>Compute a hash code for this Flags object.
  591. <P>
  592. <DD><DL>
  593. <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#hashCode()" title="class or interface in java.lang">hashCode</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>
  594. </DD>
  595. <DD><DL>
  596.  
  597. <DT><B>Returns:</B><DD>the hash code</DL>
  598. </DD>
  599. </DL>
  600. <HR>
  601.  
  602. <A NAME="getSystemFlags()"><!-- --></A><H3>
  603. getSystemFlags</H3>
  604. <PRE>
  605. public <A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail">Flags.Flag</A>[] <B>getSystemFlags</B>()</PRE>
  606. <DL>
  607. <DD>Return all the system flags in this Flags object.  Returns
  608. an array of size zero if no flags are set.
  609. <P>
  610. <DD><DL>
  611. </DL>
  612. </DD>
  613. <DD><DL>
  614.  
  615. <DT><B>Returns:</B><DD>array of Flags.Flag objects representing system flags</DL>
  616. </DD>
  617. </DL>
  618. <HR>
  619.  
  620. <A NAME="getUserFlags()"><!-- --></A><H3>
  621. getUserFlags</H3>
  622. <PRE>
  623. public <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>getUserFlags</B>()</PRE>
  624. <DL>
  625. <DD>Return all the user flags in this Flags object.  Returns
  626. an array of size zero if no flags are set.
  627. <P>
  628. <DD><DL>
  629. </DL>
  630. </DD>
  631. <DD><DL>
  632.  
  633. <DT><B>Returns:</B><DD>array of Strings, each String represents a flag.</DL>
  634. </DD>
  635. </DL>
  636. <HR>
  637.  
  638. <A NAME="clone()"><!-- --></A><H3>
  639. clone</H3>
  640. <PRE>
  641. public <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>clone</B>()</PRE>
  642. <DL>
  643. <DD>Returns a clone of this Flags object.
  644. <P>
  645. <DD><DL>
  646. <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#clone()" title="class or interface in java.lang">clone</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>
  647. </DD>
  648. <DD><DL>
  649. </DL>
  650. </DD>
  651. </DL>
  652. <!-- ========= END OF CLASS DATA ========= -->
  653. <HR>
  654.  
  655.  
  656. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  657. <A NAME="navbar_bottom"><!-- --></A>
  658. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  659. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  660. <TR>
  661. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  662. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  663. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  664.  <TR ALIGN="center" VALIGN="top">
  665.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  666.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  667.  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  668.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Flags.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  669.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  670.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  671.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  672.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  673.  </TR>
  674. </TABLE>
  675. </TD>
  676. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  677. </EM>
  678. </TD>
  679. </TR>
  680.  
  681. <TR>
  682. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  683. &nbsp;<A HREF="../../javax/mail/FetchProfile.Item.html" title="class in javax.mail"><B>PREV CLASS</B></A>&nbsp;
  684. &nbsp;<A HREF="../../javax/mail/Flags.Flag.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
  685. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  686.  <A HREF="../../index.html?javax/mail/Flags.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  687. &nbsp;<A HREF="Flags.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  688. &nbsp;<SCRIPT type="text/javascript">
  689.  <!--
  690.  if(window==top) {
  691.    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  692.  }
  693.  //-->
  694. </SCRIPT>
  695. <NOSCRIPT>
  696.  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  697. </NOSCRIPT>
  698.  
  699.  
  700. </FONT></TD>
  701. </TR>
  702. <TR>
  703. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  704.  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  705. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  706. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  707. </TR>
  708. </TABLE>
  709. <A NAME="skip-navbar_bottom"></A>
  710. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  711.  
  712. <HR>
  713. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  714. </BODY>
  715. </HTML>
  716.