cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
441 lines (440 loc) • 18.7 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:29 CEST 2014 -->
<title>ExpiringMap (apache-cassandra API)</title>
<meta name="date" content="2014-09-07">
<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-cassandra 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/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/utils/ExpiringMap.CacheableObject.html" title="class in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/utils/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>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.cassandra.utils</div>
<h2 title="Class ExpiringMap" class="title">Class ExpiringMap<K,V></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.utils.ExpiringMap<K,V></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ExpiringMap<K,V></span>
extends java.lang.Object</pre>
</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>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.CacheableObject.html" title="class in org.apache.cassandra.utils">ExpiringMap.CacheableObject</a><<a href="../../../../org/apache/cassandra/utils/ExpiringMap.CacheableObject.html" title="type parameter in ExpiringMap.CacheableObject">T</a>></strong></code> </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/cassandra/utils/ExpiringMap.html#ExpiringMap(long)">ExpiringMap</a></strong>(long defaultExpiration)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#ExpiringMap(long,%20com.google.common.base.Function)">ExpiringMap</a></strong>(long defaultExpiration,
com.google.common.base.Function<<a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>,<a href="../../../../org/apache/cassandra/utils/ExpiringMap.CacheableObject.html" title="class in org.apache.cassandra.utils">ExpiringMap.CacheableObject</a><<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>>>,?> postExpireHook)</code> </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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#containsKey(K)">containsKey</a></strong>(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#get(K)">get</a></strong>(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#getAge(K)">getAge</a></strong>(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#isEmpty()">isEmpty</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#keySet()">keySet</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#put(K,%20V)">put</a></strong>(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key,
<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> value)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#put(K,%20V,%20long)">put</a></strong>(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key,
<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> value,
long timeout)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#remove(K)">remove</a></strong>(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#reset()">reset</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#shutdownBlocking()">shutdownBlocking</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ExpiringMap.html#size()">size</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ExpiringMap</h4>
<pre>public ExpiringMap(long defaultExpiration)</pre>
</li>
</ul>
<a name="ExpiringMap(long, com.google.common.base.Function)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ExpiringMap</h4>
<pre>public ExpiringMap(long defaultExpiration,
com.google.common.base.Function<<a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>,<a href="../../../../org/apache/cassandra/utils/ExpiringMap.CacheableObject.html" title="class in org.apache.cassandra.utils">ExpiringMap.CacheableObject</a><<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a>>>,?> postExpireHook)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultExpiration</code> - the TTL for objects in the cache in milliseconds</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="shutdownBlocking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdownBlocking</h4>
<pre>public void shutdownBlocking()</pre>
</li>
</ul>
<a name="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public void reset()</pre>
</li>
</ul>
<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/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> put(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key,
<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> value)</pre>
</li>
</ul>
<a name="put(java.lang.Object,java.lang.Object,long)">
<!-- -->
</a><a name="put(K, V, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public <a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> put(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key,
<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> value,
long timeout)</pre>
</li>
</ul>
<a name="get(java.lang.Object)">
<!-- -->
</a><a name="get(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> get(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</pre>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a><a name="remove(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public <a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">V</a> remove(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</pre>
</li>
</ul>
<a name="getAge(java.lang.Object)">
<!-- -->
</a><a name="getAge(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAge</h4>
<pre>public long getAge(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>System.nanoTime() when key was put into the map.</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
</li>
</ul>
<a name="containsKey(java.lang.Object)">
<!-- -->
</a><a name="containsKey(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre>public boolean containsKey(<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a> key)</pre>
</li>
</ul>
<a name="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public boolean isEmpty()</pre>
</li>
</ul>
<a name="keySet()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>keySet</h4>
<pre>public java.util.Set<<a href="../../../../org/apache/cassandra/utils/ExpiringMap.html" title="type parameter in ExpiringMap">K</a>> keySet()</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/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/utils/ExpiringMap.CacheableObject.html" title="class in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/utils/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>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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>