UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

391 lines (390 loc) 15.1 kB
<!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_67) on Sun Sep 07 15:29:31 CEST 2014 --> <title>ICache (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="ICache (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/ICache.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/cache/CounterCacheKey.html" title="class in org.apache.cassandra.cache"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cache/ICache.html" target="_top">Frames</a></li> <li><a href="ICache.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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.cache</div> <h2 title="Interface ICache" class="title">Interface ICache&lt;K,V&gt;</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../org/apache/cassandra/cache/ConcurrentLinkedHashCache.html" title="class in org.apache.cassandra.cache">ConcurrentLinkedHashCache</a>, <a href="../../../../org/apache/cassandra/cache/SerializingCache.html" title="class in org.apache.cassandra.cache">SerializingCache</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">ICache&lt;K,V&gt;</span></pre> <div class="block">This is similar to the Map interface, but requires maintaining a given capacity and does not require put or remove to return values, which lets SerializingCache be more efficient by avoiding deserialize except on get.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== 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">&nbsp;</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>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#capacity()">capacity</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#clear()">clear</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#containsKey(K)">containsKey</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#get(K)">get</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Set&lt;<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#hotKeySet(int)">hotKeySet</a></strong>(int&nbsp;n)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Set&lt;<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#keySet()">keySet</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#put(K,%20V)">put</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;value)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#putIfAbsent(K,%20V)">putIfAbsent</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#remove(K)">remove</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#replace(K,%20V,%20V)">replace</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;old, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#setCapacity(long)">setCapacity</a></strong>(long&nbsp;capacity)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#size()">size</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/ICache.html#weightedSize()">weightedSize</a></strong>()</code>&nbsp;</td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="capacity()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>capacity</h4> <pre>long&nbsp;capacity()</pre> </li> </ul> <a name="setCapacity(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setCapacity</h4> <pre>void&nbsp;setCapacity(long&nbsp;capacity)</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>void&nbsp;put(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;value)</pre> </li> </ul> <a name="putIfAbsent(java.lang.Object,java.lang.Object)"> <!-- --> </a><a name="putIfAbsent(K, V)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>putIfAbsent</h4> <pre>boolean&nbsp;putIfAbsent(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;value)</pre> </li> </ul> <a name="replace(java.lang.Object,java.lang.Object,java.lang.Object)"> <!-- --> </a><a name="replace(K, V, V)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>replace</h4> <pre>boolean&nbsp;replace(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;old, <a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;value)</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><a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">V</a>&nbsp;get(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;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>void&nbsp;remove(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key)</pre> </li> </ul> <a name="size()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>size</h4> <pre>int&nbsp;size()</pre> </li> </ul> <a name="weightedSize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>weightedSize</h4> <pre>long&nbsp;weightedSize()</pre> </li> </ul> <a name="clear()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>clear</h4> <pre>void&nbsp;clear()</pre> </li> </ul> <a name="keySet()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>keySet</h4> <pre>java.util.Set&lt;<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&gt;&nbsp;keySet()</pre> </li> </ul> <a name="hotKeySet(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hotKeySet</h4> <pre>java.util.Set&lt;<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&gt;&nbsp;hotKeySet(int&nbsp;n)</pre> </li> </ul> <a name="containsKey(java.lang.Object)"> <!-- --> </a><a name="containsKey(K)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>containsKey</h4> <pre>boolean&nbsp;containsKey(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="type parameter in ICache">K</a>&nbsp;key)</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/ICache.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/cache/CounterCacheKey.html" title="class in org.apache.cassandra.cache"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cache/ICache.html" target="_top">Frames</a></li> <li><a href="ICache.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>