| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_07) on Tue Oct 02 13:04:16 CEST 2012 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ExpiringMap.Expirer (Apache MINA 2.0.6 API)</title> |
| <meta name="date" content="2012-10-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ExpiringMap.Expirer (Apache MINA 2.0.6 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ExpiringMap.Expirer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/mina/util/ExpiringMap.html" title="class in org.apache.mina.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/util/IdentityHashSet.html" title="class in org.apache.mina.util"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/util/ExpiringMap.Expirer.html" target="_top">Frames</a></li> |
| <li><a href="ExpiringMap.Expirer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mina.util</div> |
| <h2 title="Class ExpiringMap.Expirer" class="title">Class ExpiringMap.Expirer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.util.ExpiringMap.Expirer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/mina/util/ExpiringMap.html" title="class in org.apache.mina.util">ExpiringMap</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>,<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ExpiringMap.Expirer</span> |
| extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></pre> |
| <div class="block">A Thread that monitors an <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="class in org.apache.mina.util"><code>ExpiringMap</code></a> and will remove |
| elements that have passed the threshold.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#ExpiringMap.Expirer()">ExpiringMap.Expirer</a></strong>()</code> |
| <div class="block">Creates a new instance of Expirer.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#getExpirationInterval()">getExpirationInterval</a></strong>()</code> |
| <div class="block">Get the interval in which an object will live in the map before |
| it is removed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#getTimeToLive()">getTimeToLive</a></strong>()</code> |
| <div class="block">Returns the Time-to-live value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#isRunning()">isRunning</a></strong>()</code> |
| <div class="block">Checks to see if the thread is running</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#run()">run</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#setExpirationInterval(long)">setExpirationInterval</a></strong>(long expirationInterval)</code> |
| <div class="block">Set the interval in which an object will live in the map before |
| it is removed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#setTimeToLive(long)">setTimeToLive</a></strong>(long timeToLive)</code> |
| <div class="block">Update the value for the time-to-live</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#startExpiring()">startExpiring</a></strong>()</code> |
| <div class="block">Kick off this thread which will look for old objects and remove them.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#startExpiringIfNotStarted()">startExpiringIfNotStarted</a></strong>()</code> |
| <div class="block">If this thread has not started, then start it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html#stopExpiring()">stopExpiring</a></strong>()</code> |
| <div class="block">Stop the thread from monitoring the map.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ExpiringMap.Expirer()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ExpiringMap.Expirer</h4> |
| <pre>public ExpiringMap.Expirer()</pre> |
| <div class="block">Creates a new instance of Expirer.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="run()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public void run()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang">run</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startExpiring()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startExpiring</h4> |
| <pre>public void startExpiring()</pre> |
| <div class="block">Kick off this thread which will look for old objects and remove them.</div> |
| </li> |
| </ul> |
| <a name="startExpiringIfNotStarted()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startExpiringIfNotStarted</h4> |
| <pre>public void startExpiringIfNotStarted()</pre> |
| <div class="block">If this thread has not started, then start it. |
| Otherwise just return;</div> |
| </li> |
| </ul> |
| <a name="stopExpiring()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopExpiring</h4> |
| <pre>public void stopExpiring()</pre> |
| <div class="block">Stop the thread from monitoring the map.</div> |
| </li> |
| </ul> |
| <a name="isRunning()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRunning</h4> |
| <pre>public boolean isRunning()</pre> |
| <div class="block">Checks to see if the thread is running</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>If the thread is running, true. Otherwise false.</dd></dl> |
| </li> |
| </ul> |
| <a name="getTimeToLive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeToLive</h4> |
| <pre>public int getTimeToLive()</pre> |
| <div class="block">Returns the Time-to-live value.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The time-to-live (seconds)</dd></dl> |
| </li> |
| </ul> |
| <a name="setTimeToLive(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeToLive</h4> |
| <pre>public void setTimeToLive(long timeToLive)</pre> |
| <div class="block">Update the value for the time-to-live</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeToLive</code> - The time-to-live (seconds)</dd></dl> |
| </li> |
| </ul> |
| <a name="getExpirationInterval()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpirationInterval</h4> |
| <pre>public int getExpirationInterval()</pre> |
| <div class="block">Get the interval in which an object will live in the map before |
| it is removed.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The time in seconds.</dd></dl> |
| </li> |
| </ul> |
| <a name="setExpirationInterval(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setExpirationInterval</h4> |
| <pre>public void setExpirationInterval(long expirationInterval)</pre> |
| <div class="block">Set the interval in which an object will live in the map before |
| it is removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>expirationInterval</code> - The time in seconds</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ExpiringMap.Expirer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/mina/util/ExpiringMap.html" title="class in org.apache.mina.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/util/IdentityHashSet.html" title="class in org.apache.mina.util"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/util/ExpiringMap.Expirer.html" target="_top">Frames</a></li> |
| <li><a href="ExpiringMap.Expirer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2012 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
