| <!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 Sat Oct 06 02:26:01 CEST 2012 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ExpiringMap (Apache MINA 2.0.7 API)</title> |
| <meta name="date" content="2012-10-06"> |
| <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 (Apache MINA 2.0.7 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.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/ExpirationListener.html" title="interface in org.apache.mina.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.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.html" target="_top">Frames</a></li> |
| <li><a href="ExpiringMap.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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" class="title">Class ExpiringMap<K,V></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<K,V></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/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><K,V></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ExpiringMap<K,V></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/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><K,V></pre> |
| <div class="block">A map with expiration. This class contains a worker thread that will |
| periodically check this class in order to determine if any objects |
| should be removed based on the provided time-to-live value.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html" title="class in org.apache.mina.util">ExpiringMap.Expirer</a></strong></code> |
| <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> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface java.util.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></h3> |
| <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">K</a>,<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">V</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#DEFAULT_EXPIRATION_INTERVAL">DEFAULT_EXPIRATION_INTERVAL</a></strong></code> |
| <div class="block">The default value, 1</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#DEFAULT_TIME_TO_LIVE">DEFAULT_TIME_TO_LIVE</a></strong></code> |
| <div class="block">The default value, 60</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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.html#ExpiringMap()">ExpiringMap</a></strong>()</code> |
| <div class="block">Creates a new instance of ExpiringMap using the default values |
| DEFAULT_TIME_TO_LIVE and DEFAULT_EXPIRATION_INTERVAL</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#ExpiringMap(int)">ExpiringMap</a></strong>(int timeToLive)</code> |
| <div class="block">Creates a new instance of ExpiringMap using the supplied |
| time-to-live value and the default value for DEFAULT_EXPIRATION_INTERVAL</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#ExpiringMap(int, int)">ExpiringMap</a></strong>(int timeToLive, |
| int expirationInterval)</code> |
| <div class="block">Creates a new instance of ExpiringMap using the supplied values and |
| a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/ConcurrentHashMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentHashMap</code></a> for the internal data structure.</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#addExpirationListener(org.apache.mina.util.ExpirationListener)">addExpirationListener</a></strong>(<a href="../../../../org/apache/mina/util/ExpirationListener.html" title="interface in org.apache.mina.util">ExpirationListener</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> listener)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#clear()">clear</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#containsKey(java.lang.Object)">containsKey</a></strong>(<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> key)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#containsValue(java.lang.Object)">containsValue</a></strong>(<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> value)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</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>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#entrySet()">entrySet</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#equals(java.lang.Object)">equals</a></strong>(<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> obj)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#get(java.lang.Object)">get</a></strong>(<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> key)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#getExpirationInterval()">getExpirationInterval</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html" title="class in org.apache.mina.util">ExpiringMap.Expirer</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#getExpirer()">getExpirer</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#getTimeToLive()">getTimeToLive</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#hashCode()">hashCode</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#isEmpty()">isEmpty</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#keySet()">keySet</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#put(K, V)">put</a></strong>(<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key, |
| <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> value)</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.html#putAll(java.util.Map)">putAll</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><? extends <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>,? extends <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> inMap)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#remove(java.lang.Object)">remove</a></strong>(<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> key)</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.html#removeExpirationListener(org.apache.mina.util.ExpirationListener)">removeExpirationListener</a></strong>(<a href="../../../../org/apache/mina/util/ExpirationListener.html" title="interface in org.apache.mina.util">ExpirationListener</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> listener)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#setExpirationInterval(int)">setExpirationInterval</a></strong>(int expirationInterval)</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.html#setTimeToLive(int)">setTimeToLive</a></strong>(int timeToLive)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#size()">size</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/util/ExpiringMap.html#values()">values</a></strong>()</code> </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#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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_TIME_TO_LIVE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_TIME_TO_LIVE</h4> |
| <pre>public static final int DEFAULT_TIME_TO_LIVE</pre> |
| <div class="block">The default value, 60</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.mina.util.ExpiringMap.DEFAULT_TIME_TO_LIVE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_EXPIRATION_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_EXPIRATION_INTERVAL</h4> |
| <pre>public static final int DEFAULT_EXPIRATION_INTERVAL</pre> |
| <div class="block">The default value, 1</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.mina.util.ExpiringMap.DEFAULT_EXPIRATION_INTERVAL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ExpiringMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ExpiringMap</h4> |
| <pre>public ExpiringMap()</pre> |
| <div class="block">Creates a new instance of ExpiringMap using the default values |
| DEFAULT_TIME_TO_LIVE and DEFAULT_EXPIRATION_INTERVAL</div> |
| </li> |
| </ul> |
| <a name="ExpiringMap(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ExpiringMap</h4> |
| <pre>public ExpiringMap(int timeToLive)</pre> |
| <div class="block">Creates a new instance of ExpiringMap using the supplied |
| time-to-live value and the default value for DEFAULT_EXPIRATION_INTERVAL</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeToLive</code> - The time-to-live value (seconds)</dd></dl> |
| </li> |
| </ul> |
| <a name="ExpiringMap(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ExpiringMap</h4> |
| <pre>public ExpiringMap(int timeToLive, |
| int expirationInterval)</pre> |
| <div class="block">Creates a new instance of ExpiringMap using the supplied values and |
| a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/ConcurrentHashMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentHashMap</code></a> for the internal data structure.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeToLive</code> - The time-to-live value (seconds)</dd><dd><code>expirationInterval</code> - The time between checks to see if a value should be removed (seconds)</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="put(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a name="put(K, V)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> put(<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key, |
| <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> value)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#put(K, V)" title="class or interface in java.util">put</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> get(<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> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#get(java.lang.Object)" title="class or interface in java.util">get</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="remove(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>public <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> remove(<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> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util">remove</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="containsKey(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsKey</h4> |
| <pre>public boolean containsKey(<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> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#containsKey(java.lang.Object)" title="class or interface in java.util">containsKey</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="containsValue(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsValue</h4> |
| <pre>public boolean containsValue(<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> value)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#containsValue(java.lang.Object)" title="class or interface in java.util">containsValue</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="size()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>public int size()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#size()" title="class or interface in java.util">size</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEmpty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>public boolean isEmpty()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util">isEmpty</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util">clear</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#hashCode()" title="class or interface in java.util">hashCode</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="keySet()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keySet</h4> |
| <pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>> keySet()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util">keySet</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<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> obj)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putAll(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putAll</h4> |
| <pre>public void putAll(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><? extends <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>,? extends <a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> inMap)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#putAll(java.util.Map)" title="class or interface in java.util">putAll</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="values()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> values()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#values()" title="class or interface in java.util">values</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entrySet()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entrySet</h4> |
| <pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</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>>> entrySet()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true#entrySet()" title="class or interface in java.util">entrySet</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExpirationListener(org.apache.mina.util.ExpirationListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExpirationListener</h4> |
| <pre>public void addExpirationListener(<a href="../../../../org/apache/mina/util/ExpirationListener.html" title="interface in org.apache.mina.util">ExpirationListener</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> listener)</pre> |
| </li> |
| </ul> |
| <a name="removeExpirationListener(org.apache.mina.util.ExpirationListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeExpirationListener</h4> |
| <pre>public void removeExpirationListener(<a href="../../../../org/apache/mina/util/ExpirationListener.html" title="interface in org.apache.mina.util">ExpirationListener</a><<a href="../../../../org/apache/mina/util/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>> listener)</pre> |
| </li> |
| </ul> |
| <a name="getExpirer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpirer</h4> |
| <pre>public <a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.html" title="class in org.apache.mina.util">ExpiringMap.Expirer</a> getExpirer()</pre> |
| </li> |
| </ul> |
| <a name="getExpirationInterval()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpirationInterval</h4> |
| <pre>public int getExpirationInterval()</pre> |
| </li> |
| </ul> |
| <a name="getTimeToLive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeToLive</h4> |
| <pre>public int getTimeToLive()</pre> |
| </li> |
| </ul> |
| <a name="setExpirationInterval(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExpirationInterval</h4> |
| <pre>public void setExpirationInterval(int expirationInterval)</pre> |
| </li> |
| </ul> |
| <a name="setTimeToLive(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setTimeToLive</h4> |
| <pre>public void setTimeToLive(int timeToLive)</pre> |
| </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.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/ExpirationListener.html" title="interface in org.apache.mina.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/util/ExpiringMap.Expirer.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.html" target="_top">Frames</a></li> |
| <li><a href="ExpiringMap.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> |
