ChartDeleter.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:41 CEST 2014 -->
  6. <title>ChartDeleter (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="ChartDeleter (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/ChartDeleter.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li>Prev&nbsp;Class</li>
  53. <li><a href="../../../../org/jfree/chart/servlet/DisplayChart.html" title="class in org.jfree.chart.servlet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/servlet/ChartDeleter.html" target="_top">Frames</a></li>
  57. <li><a href="ChartDeleter.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart.servlet</div>
  96. <h2 title="Class ChartDeleter" class="title">Class ChartDeleter</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.chart.servlet.ChartDeleter</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable, java.util.EventListener, javax.servlet.http.HttpSessionBindingListener</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/chart/servlet/ChartDeleter.html#line.58">ChartDeleter</a>
  117. extends java.lang.Object
  118. implements javax.servlet.http.HttpSessionBindingListener, java.io.Serializable</pre>
  119. <div class="block">Used for deleting charts from the temporary directory when the users session
  120. expires.</div>
  121. <dl>
  122. <dt><span class="seeLabel">See Also:</span></dt>
  123. <dd><a href="../../../../serialized-form.html#org.jfree.chart.servlet.ChartDeleter">Serialized Form</a></dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/servlet/ChartDeleter.html#ChartDeleter--">ChartDeleter</a></span>()</code>
  144. <div class="block">Blank constructor.</div>
  145. </td>
  146. </tr>
  147. </table>
  148. </li>
  149. </ul>
  150. <!-- ========== METHOD SUMMARY =========== -->
  151. <ul class="blockList">
  152. <li class="blockList"><a name="method.summary">
  153. <!-- -->
  154. </a>
  155. <h3>Method Summary</h3>
  156. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  157. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  158. <tr>
  159. <th class="colFirst" scope="col">Modifier and Type</th>
  160. <th class="colLast" scope="col">Method and Description</th>
  161. </tr>
  162. <tr id="i0" class="altColor">
  163. <td class="colFirst"><code>void</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/servlet/ChartDeleter.html#addChart-java.lang.String-">addChart</a></span>(java.lang.String&nbsp;filename)</code>
  165. <div class="block">Add a chart to be deleted when the session expires</div>
  166. </td>
  167. </tr>
  168. <tr id="i1" class="rowColor">
  169. <td class="colFirst"><code>boolean</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/servlet/ChartDeleter.html#isChartAvailable-java.lang.String-">isChartAvailable</a></span>(java.lang.String&nbsp;filename)</code>
  171. <div class="block">Checks to see if a chart is in the list of charts to be deleted</div>
  172. </td>
  173. </tr>
  174. <tr id="i2" class="altColor">
  175. <td class="colFirst"><code>void</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/servlet/ChartDeleter.html#valueBound-javax.servlet.http.HttpSessionBindingEvent-">valueBound</a></span>(javax.servlet.http.HttpSessionBindingEvent&nbsp;event)</code>
  177. <div class="block">Binding this object to the session has no additional effects.</div>
  178. </td>
  179. </tr>
  180. <tr id="i3" class="rowColor">
  181. <td class="colFirst"><code>void</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/servlet/ChartDeleter.html#valueUnbound-javax.servlet.http.HttpSessionBindingEvent-">valueUnbound</a></span>(javax.servlet.http.HttpSessionBindingEvent&nbsp;event)</code>
  183. <div class="block">When this object is unbound from the session (including upon session
  184. expiry) the files that have been added to the ArrayList are iterated
  185. and deleted.</div>
  186. </td>
  187. </tr>
  188. </table>
  189. <ul class="blockList">
  190. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  191. <!-- -->
  192. </a>
  193. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  194. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  195. </ul>
  196. </li>
  197. </ul>
  198. </li>
  199. </ul>
  200. </div>
  201. <div class="details">
  202. <ul class="blockList">
  203. <li class="blockList">
  204. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  205. <ul class="blockList">
  206. <li class="blockList"><a name="constructor.detail">
  207. <!-- -->
  208. </a>
  209. <h3>Constructor Detail</h3>
  210. <a name="ChartDeleter--">
  211. <!-- -->
  212. </a>
  213. <ul class="blockListLast">
  214. <li class="blockList">
  215. <h4>ChartDeleter</h4>
  216. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/chart/servlet/ChartDeleter.html#line.66">ChartDeleter</a>()</pre>
  217. <div class="block">Blank constructor.</div>
  218. </li>
  219. </ul>
  220. </li>
  221. </ul>
  222. <!-- ============ METHOD DETAIL ========== -->
  223. <ul class="blockList">
  224. <li class="blockList"><a name="method.detail">
  225. <!-- -->
  226. </a>
  227. <h3>Method Detail</h3>
  228. <a name="addChart-java.lang.String-">
  229. <!-- -->
  230. </a>
  231. <ul class="blockList">
  232. <li class="blockList">
  233. <h4>addChart</h4>
  234. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/servlet/ChartDeleter.html#line.76">addChart</a>(java.lang.String&nbsp;filename)</pre>
  235. <div class="block">Add a chart to be deleted when the session expires</div>
  236. <dl>
  237. <dt><span class="paramLabel">Parameters:</span></dt>
  238. <dd><code>filename</code> - the name of the chart in the temporary directory to be
  239. deleted.</dd>
  240. </dl>
  241. </li>
  242. </ul>
  243. <a name="isChartAvailable-java.lang.String-">
  244. <!-- -->
  245. </a>
  246. <ul class="blockList">
  247. <li class="blockList">
  248. <h4>isChartAvailable</h4>
  249. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/chart/servlet/ChartDeleter.html#line.88">isChartAvailable</a>(java.lang.String&nbsp;filename)</pre>
  250. <div class="block">Checks to see if a chart is in the list of charts to be deleted</div>
  251. <dl>
  252. <dt><span class="paramLabel">Parameters:</span></dt>
  253. <dd><code>filename</code> - the name of the chart in the temporary directory.</dd>
  254. <dt><span class="returnLabel">Returns:</span></dt>
  255. <dd>A boolean value indicating whether the chart is present in the
  256. list.</dd>
  257. </dl>
  258. </li>
  259. </ul>
  260. <a name="valueBound-javax.servlet.http.HttpSessionBindingEvent-">
  261. <!-- -->
  262. </a>
  263. <ul class="blockList">
  264. <li class="blockList">
  265. <h4>valueBound</h4>
  266. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/servlet/ChartDeleter.html#line.98">valueBound</a>(javax.servlet.http.HttpSessionBindingEvent&nbsp;event)</pre>
  267. <div class="block">Binding this object to the session has no additional effects.</div>
  268. <dl>
  269. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  270. <dd><code>valueBound</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSessionBindingListener</code></dd>
  271. <dt><span class="paramLabel">Parameters:</span></dt>
  272. <dd><code>event</code> - the session bind event.</dd>
  273. </dl>
  274. </li>
  275. </ul>
  276. <a name="valueUnbound-javax.servlet.http.HttpSessionBindingEvent-">
  277. <!-- -->
  278. </a>
  279. <ul class="blockListLast">
  280. <li class="blockList">
  281. <h4>valueUnbound</h4>
  282. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/chart/servlet/ChartDeleter.html#line.110">valueUnbound</a>(javax.servlet.http.HttpSessionBindingEvent&nbsp;event)</pre>
  283. <div class="block">When this object is unbound from the session (including upon session
  284. expiry) the files that have been added to the ArrayList are iterated
  285. and deleted.</div>
  286. <dl>
  287. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  288. <dd><code>valueUnbound</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSessionBindingListener</code></dd>
  289. <dt><span class="paramLabel">Parameters:</span></dt>
  290. <dd><code>event</code> - the session unbind event.</dd>
  291. </dl>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </li>
  297. </ul>
  298. </div>
  299. </div>
  300. <!-- ========= END OF CLASS DATA ========= -->
  301. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  302. <div class="bottomNav"><a name="navbar.bottom">
  303. <!-- -->
  304. </a>
  305. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  306. <a name="navbar.bottom.firstrow">
  307. <!-- -->
  308. </a>
  309. <ul class="navList" title="Navigation">
  310. <li><a href="../../../../overview-summary.html">Overview</a></li>
  311. <li><a href="package-summary.html">Package</a></li>
  312. <li class="navBarCell1Rev">Class</li>
  313. <li><a href="class-use/ChartDeleter.html">Use</a></li>
  314. <li><a href="package-tree.html">Tree</a></li>
  315. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  316. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  317. <li><a href="../../../../help-doc.html">Help</a></li>
  318. </ul>
  319. </div>
  320. <div class="subNav">
  321. <ul class="navList">
  322. <li>Prev&nbsp;Class</li>
  323. <li><a href="../../../../org/jfree/chart/servlet/DisplayChart.html" title="class in org.jfree.chart.servlet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  324. </ul>
  325. <ul class="navList">
  326. <li><a href="../../../../index.html?org/jfree/chart/servlet/ChartDeleter.html" target="_top">Frames</a></li>
  327. <li><a href="ChartDeleter.html" target="_top">No&nbsp;Frames</a></li>
  328. </ul>
  329. <ul class="navList" id="allclasses_navbar_bottom">
  330. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  331. </ul>
  332. <div>
  333. <script type="text/javascript"><!--
  334. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  335. if(window==top) {
  336. allClassesLink.style.display = "block";
  337. }
  338. else {
  339. allClassesLink.style.display = "none";
  340. }
  341. //-->
  342. </script>
  343. </div>
  344. <div>
  345. <ul class="subNavList">
  346. <li>Summary:&nbsp;</li>
  347. <li>Nested&nbsp;|&nbsp;</li>
  348. <li>Field&nbsp;|&nbsp;</li>
  349. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  350. <li><a href="#method.summary">Method</a></li>
  351. </ul>
  352. <ul class="subNavList">
  353. <li>Detail:&nbsp;</li>
  354. <li>Field&nbsp;|&nbsp;</li>
  355. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  356. <li><a href="#method.detail">Method</a></li>
  357. </ul>
  358. </div>
  359. <a name="skip.navbar.bottom">
  360. <!-- -->
  361. </a></div>
  362. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  363. </body>
  364. </html>