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:36 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. FolderEvent (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="FolderEvent (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/FolderEvent.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/event/FolderAdapter.html" title="class in javax.mail.event"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../index.html?javax/mail/event/FolderEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="FolderEvent.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="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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.event</FONT>
  93. <BR>
  94. Class FolderEvent</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="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">java.util.EventObject</A>
  98.       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../javax/mail/event/MailEvent.html" title="class in javax.mail.event">javax.mail.event.MailEvent</A>
  99.           <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.mail.event.FolderEvent</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 class <B>FolderEvent</B><DT>extends <A HREF="../../../javax/mail/event/MailEvent.html" title="class in javax.mail.event">MailEvent</A></DL>
  107. </PRE>
  108.  
  109. <P>
  110. This class models Folder <em>existence</em> events. FolderEvents are
  111.  delivered to FolderListeners registered on the affected Folder as
  112.  well as the containing Store. <p>
  113.  
  114.  Service providers vary widely in their ability to notify clients of
  115.  these events.  At a minimum, service providers must notify listeners
  116.  registered on the same Store or Folder object on which the operation
  117.  occurs.  Service providers may also notify listeners when changes
  118.  are made through operations on other objects in the same virtual
  119.  machine, or by other clients in the same or other hosts.  Such
  120.  notifications are not required and are typically not supported
  121.  by mail protocols (including IMAP).
  122. <P>
  123.  
  124. <P>
  125. <DL>
  126. <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#javax.mail.event.FolderEvent">Serialized Form</A></DL>
  127. <HR>
  128.  
  129. <P>
  130. <!-- =========== FIELD SUMMARY =========== -->
  131.  
  132. <A NAME="field_summary"><!-- --></A>
  133. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  134. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  135. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  136. <B>Field Summary</B></FONT></TH>
  137. </TR>
  138. <TR BGCOLOR="white" CLASS="TableRowColor">
  139. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  140. <CODE>static&nbsp;int</CODE></FONT></TD>
  141. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#CREATED">CREATED</A></B></CODE>
  142.  
  143. <BR>
  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The folder was created.</TD>
  145. </TR>
  146. <TR BGCOLOR="white" CLASS="TableRowColor">
  147. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  148. <CODE>static&nbsp;int</CODE></FONT></TD>
  149. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#DELETED">DELETED</A></B></CODE>
  150.  
  151. <BR>
  152. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The folder was deleted.</TD>
  153. </TR>
  154. <TR BGCOLOR="white" CLASS="TableRowColor">
  155. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  156. <CODE>protected &nbsp;<A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  157. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#folder">folder</A></B></CODE>
  158.  
  159. <BR>
  160. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The folder the event occurred on.</TD>
  161. </TR>
  162. <TR BGCOLOR="white" CLASS="TableRowColor">
  163. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  164. <CODE>protected &nbsp;<A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  165. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#newFolder">newFolder</A></B></CODE>
  166.  
  167. <BR>
  168. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The folder that represents the new name, in case of a RENAMED event.</TD>
  169. </TR>
  170. <TR BGCOLOR="white" CLASS="TableRowColor">
  171. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  172. <CODE>static&nbsp;int</CODE></FONT></TD>
  173. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#RENAMED">RENAMED</A></B></CODE>
  174.  
  175. <BR>
  176. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The folder was renamed.</TD>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>protected &nbsp;int</CODE></FONT></TD>
  181. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#type">type</A></B></CODE>
  182.  
  183. <BR>
  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The event type.</TD>
  185. </TR>
  186. </TABLE>
  187. &nbsp;<A NAME="fields_inherited_from_class_java.util.EventObject"><!-- --></A>
  188. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  189. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  190. <TH ALIGN="left"><B>Fields inherited from class java.util.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">EventObject</A></B></TH>
  191. </TR>
  192. <TR BGCOLOR="white" CLASS="TableRowColor">
  193. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true#source" title="class or interface in java.util">source</A></CODE></TD>
  194. </TR>
  195. </TABLE>
  196. &nbsp;
  197. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  198.  
  199. <A NAME="constructor_summary"><!-- --></A>
  200. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  201. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  202. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  203. <B>Constructor Summary</B></FONT></TH>
  204. </TR>
  205. <TR BGCOLOR="white" CLASS="TableRowColor">
  206. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#FolderEvent(java.lang.Object, javax.mail.Folder, javax.mail.Folder, int)">FolderEvent</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;source,
  207.             <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;oldFolder,
  208.             <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;newFolder,
  209.             int&nbsp;type)</CODE>
  210.  
  211. <BR>
  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
  213. </TR>
  214. <TR BGCOLOR="white" CLASS="TableRowColor">
  215. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#FolderEvent(java.lang.Object, javax.mail.Folder, int)">FolderEvent</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;source,
  216.             <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;folder,
  217.             int&nbsp;type)</CODE>
  218.  
  219. <BR>
  220. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
  221. </TR>
  222. </TABLE>
  223. &nbsp;
  224. <!-- ========== METHOD SUMMARY =========== -->
  225.  
  226. <A NAME="method_summary"><!-- --></A>
  227. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  228. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  229. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  230. <B>Method Summary</B></FONT></TH>
  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/event/FolderEvent.html#dispatch(java.lang.Object)">dispatch</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;listener)</CODE>
  236.  
  237. <BR>
  238. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invokes the appropriate FolderListener method</TD>
  239. </TR>
  240. <TR BGCOLOR="white" CLASS="TableRowColor">
  241. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  242. <CODE>&nbsp;<A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  243. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#getFolder()">getFolder</A></B>()</CODE>
  244.  
  245. <BR>
  246. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the affected folder.</TD>
  247. </TR>
  248. <TR BGCOLOR="white" CLASS="TableRowColor">
  249. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  250. <CODE>&nbsp;<A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  251. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#getNewFolder()">getNewFolder</A></B>()</CODE>
  252.  
  253. <BR>
  254. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If this event indicates that a folder is renamed, (i.e, the event type
  255.  is RENAMED), then this method returns the Folder object representing the
  256.  new name.</TD>
  257. </TR>
  258. <TR BGCOLOR="white" CLASS="TableRowColor">
  259. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  260. <CODE>&nbsp;int</CODE></FONT></TD>
  261. <TD><CODE><B><A HREF="../../../javax/mail/event/FolderEvent.html#getType()">getType</A></B>()</CODE>
  262.  
  263. <BR>
  264. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the type of this event.</TD>
  265. </TR>
  266. </TABLE>
  267. &nbsp;<A NAME="methods_inherited_from_class_java.util.EventObject"><!-- --></A>
  268. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  269. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  270. <TH ALIGN="left"><B>Methods inherited from class java.util.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">EventObject</A></B></TH>
  271. </TR>
  272. <TR BGCOLOR="white" CLASS="TableRowColor">
  273. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true#getSource()" title="class or interface in java.util">getSource</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true#toString()" title="class or interface in java.util">toString</A></CODE></TD>
  274. </TR>
  275. </TABLE>
  276. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  277. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  278. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  279. <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>
  280. </TR>
  281. <TR BGCOLOR="white" CLASS="TableRowColor">
  282. <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#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>
  283. </TR>
  284. </TABLE>
  285. &nbsp;
  286. <P>
  287.  
  288. <!-- ============ FIELD DETAIL =========== -->
  289.  
  290. <A NAME="field_detail"><!-- --></A>
  291. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  292. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  293. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  294. <B>Field Detail</B></FONT></TH>
  295. </TR>
  296. </TABLE>
  297.  
  298. <A NAME="CREATED"><!-- --></A><H3>
  299. CREATED</H3>
  300. <PRE>
  301. public static final int <B>CREATED</B></PRE>
  302. <DL>
  303. <DD>The folder was created.
  304. <P>
  305. <DL>
  306. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.mail.event.FolderEvent.CREATED">Constant Field Values</A></DL>
  307. </DL>
  308. <HR>
  309.  
  310. <A NAME="DELETED"><!-- --></A><H3>
  311. DELETED</H3>
  312. <PRE>
  313. public static final int <B>DELETED</B></PRE>
  314. <DL>
  315. <DD>The folder was deleted.
  316. <P>
  317. <DL>
  318. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.mail.event.FolderEvent.DELETED">Constant Field Values</A></DL>
  319. </DL>
  320. <HR>
  321.  
  322. <A NAME="RENAMED"><!-- --></A><H3>
  323. RENAMED</H3>
  324. <PRE>
  325. public static final int <B>RENAMED</B></PRE>
  326. <DL>
  327. <DD>The folder was renamed.
  328. <P>
  329. <DL>
  330. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.mail.event.FolderEvent.RENAMED">Constant Field Values</A></DL>
  331. </DL>
  332. <HR>
  333.  
  334. <A NAME="type"><!-- --></A><H3>
  335. type</H3>
  336. <PRE>
  337. protected int <B>type</B></PRE>
  338. <DL>
  339. <DD>The event type.
  340. <P>
  341. <DL>
  342. </DL>
  343. </DL>
  344. <HR>
  345.  
  346. <A NAME="folder"><!-- --></A><H3>
  347. folder</H3>
  348. <PRE>
  349. protected transient <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>folder</B></PRE>
  350. <DL>
  351. <DD>The folder the event occurred on.
  352. <P>
  353. <DL>
  354. </DL>
  355. </DL>
  356. <HR>
  357.  
  358. <A NAME="newFolder"><!-- --></A><H3>
  359. newFolder</H3>
  360. <PRE>
  361. protected transient <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>newFolder</B></PRE>
  362. <DL>
  363. <DD>The folder that represents the new name, in case of a RENAMED event.
  364. <P>
  365. <DL>
  366. <DT><B>Since:</B></DT>
  367.   <DD>JavaMail 1.1</DD>
  368. </DL>
  369. </DL>
  370.  
  371. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  372.  
  373. <A NAME="constructor_detail"><!-- --></A>
  374. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  375. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  376. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  377. <B>Constructor Detail</B></FONT></TH>
  378. </TR>
  379. </TABLE>
  380.  
  381. <A NAME="FolderEvent(java.lang.Object, javax.mail.Folder, int)"><!-- --></A><H3>
  382. FolderEvent</H3>
  383. <PRE>
  384. public <B>FolderEvent</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;source,
  385.                    <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;folder,
  386.                    int&nbsp;type)</PRE>
  387. <DL>
  388. <DD>Constructor. <p>
  389. <P>
  390. <DL>
  391. <DT><B>Parameters:</B><DD><CODE>source</CODE> - The source of the event<DD><CODE>folder</CODE> - The affected folder<DD><CODE>type</CODE> - The event type</DL>
  392. </DL>
  393. <HR>
  394.  
  395. <A NAME="FolderEvent(java.lang.Object, javax.mail.Folder, javax.mail.Folder, int)"><!-- --></A><H3>
  396. FolderEvent</H3>
  397. <PRE>
  398. public <B>FolderEvent</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;source,
  399.                    <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;oldFolder,
  400.                    <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;newFolder,
  401.                    int&nbsp;type)</PRE>
  402. <DL>
  403. <DD>Constructor. Use for RENAMED events.
  404. <P>
  405. <DL>
  406. <DT><B>Parameters:</B><DD><CODE>source</CODE> - The source of the event<DD><CODE>oldFolder</CODE> - The folder that is renamed<DD><CODE>newFolder</CODE> - The folder that represents the new name<DD><CODE>type</CODE> - The event type<DT><B>Since:</B></DT>
  407.   <DD>JavaMail 1.1</DD>
  408. </DL>
  409. </DL>
  410.  
  411. <!-- ============ METHOD DETAIL ========== -->
  412.  
  413. <A NAME="method_detail"><!-- --></A>
  414. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  415. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  416. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  417. <B>Method Detail</B></FONT></TH>
  418. </TR>
  419. </TABLE>
  420.  
  421. <A NAME="getType()"><!-- --></A><H3>
  422. getType</H3>
  423. <PRE>
  424. public int <B>getType</B>()</PRE>
  425. <DL>
  426. <DD>Return the type of this event.
  427. <P>
  428. <DD><DL>
  429.  
  430. <DT><B>Returns:</B><DD>type</DL>
  431. </DD>
  432. </DL>
  433. <HR>
  434.  
  435. <A NAME="getFolder()"><!-- --></A><H3>
  436. getFolder</H3>
  437. <PRE>
  438. public <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getFolder</B>()</PRE>
  439. <DL>
  440. <DD>Return the affected folder.
  441. <P>
  442. <DD><DL>
  443.  
  444. <DT><B>Returns:</B><DD>the affected folder<DT><B>See Also:</B><DD><A HREF="../../../javax/mail/event/FolderEvent.html#getNewFolder()"><CODE>getNewFolder()</CODE></A></DL>
  445. </DD>
  446. </DL>
  447. <HR>
  448.  
  449. <A NAME="getNewFolder()"><!-- --></A><H3>
  450. getNewFolder</H3>
  451. <PRE>
  452. public <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getNewFolder</B>()</PRE>
  453. <DL>
  454. <DD>If this event indicates that a folder is renamed, (i.e, the event type
  455.  is RENAMED), then this method returns the Folder object representing the
  456.  new name. <p>
  457.  
  458.  The <code>getFolder()</code> method returns the folder that is renamed.
  459. <P>
  460. <DD><DL>
  461.  
  462. <DT><B>Returns:</B><DD>Folder representing the new name.<DT><B>Since:</B></DT>
  463.   <DD>JavaMail 1.1</DD>
  464. <DT><B>See Also:</B><DD><A HREF="../../../javax/mail/event/FolderEvent.html#getFolder()"><CODE>getFolder()</CODE></A></DL>
  465. </DD>
  466. </DL>
  467. <HR>
  468.  
  469. <A NAME="dispatch(java.lang.Object)"><!-- --></A><H3>
  470. dispatch</H3>
  471. <PRE>
  472. public void <B>dispatch</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;listener)</PRE>
  473. <DL>
  474. <DD>Invokes the appropriate FolderListener method
  475. <P>
  476. <DD><DL>
  477. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/mail/event/MailEvent.html#dispatch(java.lang.Object)">dispatch</A></CODE> in class <CODE><A HREF="../../../javax/mail/event/MailEvent.html" title="class in javax.mail.event">MailEvent</A></CODE></DL>
  478. </DD>
  479. <DD><DL>
  480. </DL>
  481. </DD>
  482. </DL>
  483. <!-- ========= END OF CLASS DATA ========= -->
  484. <HR>
  485.  
  486.  
  487. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  488. <A NAME="navbar_bottom"><!-- --></A>
  489. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  490. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  491. <TR>
  492. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  493. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  494. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  495.   <TR ALIGN="center" VALIGN="top">
  496.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  497.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  498.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  499.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FolderEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  500.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  501.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  502.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  503.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  504.   </TR>
  505. </TABLE>
  506. </TD>
  507. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  508. </EM>
  509. </TD>
  510. </TR>
  511.  
  512. <TR>
  513. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  514. &nbsp;<A HREF="../../../javax/mail/event/FolderAdapter.html" title="class in javax.mail.event"><B>PREV CLASS</B></A>&nbsp;
  515. &nbsp;<A HREF="../../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event"><B>NEXT CLASS</B></A></FONT></TD>
  516. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  517.   <A HREF="../../../index.html?javax/mail/event/FolderEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  518. &nbsp;<A HREF="FolderEvent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  519. &nbsp;<SCRIPT type="text/javascript">
  520.   <!--
  521.   if(window==top) {
  522.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  523.   }
  524.   //-->
  525. </SCRIPT>
  526. <NOSCRIPT>
  527.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  528. </NOSCRIPT>
  529.  
  530.  
  531. </FONT></TD>
  532. </TR>
  533. <TR>
  534. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  535.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  536. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  537. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  538. </TR>
  539. </TABLE>
  540. <A NAME="skip-navbar_bottom"></A>
  541. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  542.  
  543. <HR>
  544. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  545. </BODY>
  546. </HTML>
  547.