| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>WindowPartitionCache (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WindowPartitionCache (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/WindowPartitionCache.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/storm/windowing/persistence/SimpleWindowPartitionCache.SimpleWindowPartitionCacheBuilder.html" title="class in org.apache.storm.windowing.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.Builder.html" title="interface in org.apache.storm.windowing.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/windowing/persistence/WindowPartitionCache.html" target="_top">Frames</a></li> |
| <li><a href="WindowPartitionCache.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.storm.windowing.persistence</div> |
| <h2 title="Interface WindowPartitionCache" class="title">Interface WindowPartitionCache<K,V></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/storm/windowing/persistence/SimpleWindowPartitionCache.html" title="class in org.apache.storm.windowing.persistence">SimpleWindowPartitionCache</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">WindowPartitionCache<K,V></span></pre> |
| <div class="block"><p>A loading cache abstraction for caching <a href="../../../../../org/apache/storm/windowing/persistence/WindowState.WindowPartition.html" title="class in org.apache.storm.windowing.persistence"><code>WindowState.WindowPartition</code></a>.</p></div> |
| </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="memberSummary" 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">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.Builder.html" title="interface in org.apache.storm.windowing.persistence">WindowPartitionCache.Builder</a><<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.Builder.html" title="type parameter in WindowPartitionCache.Builder">K</a>,<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.Builder.html" title="type parameter in WindowPartitionCache.Builder">V</a>></span></code> |
| <div class="block">Builder interface for <a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="interface in org.apache.storm.windowing.persistence"><code>WindowPartitionCache</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.CacheLoader.html" title="interface in org.apache.storm.windowing.persistence">WindowPartitionCache.CacheLoader</a><<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.CacheLoader.html" title="type parameter in WindowPartitionCache.CacheLoader">K</a>,<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.CacheLoader.html" title="type parameter in WindowPartitionCache.CacheLoader">V</a>></span></code> |
| <div class="block">The interface for loading entires into the cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.RemovalCause.html" title="enum in org.apache.storm.windowing.persistence">WindowPartitionCache.RemovalCause</a></span></code> |
| <div class="block">The reason why an enrty got evicted from the cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.RemovalListener.html" title="interface in org.apache.storm.windowing.persistence">WindowPartitionCache.RemovalListener</a><<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.RemovalListener.html" title="type parameter in WindowPartitionCache.RemovalListener">K</a>,<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.RemovalListener.html" title="type parameter in WindowPartitionCache.RemovalListener">V</a>></span></code> |
| <div class="block">A callback interface for handling removal of events from the cache.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a>,<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html#asMap--">asMap</a></span>()</code> |
| <div class="block">Return a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentMap</code></a> view of the current entries in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html#get-K-">get</a></span>(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</code> |
| <div class="block">Get value from the cache or load the value.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html#invalidate-K-">invalidate</a></span>(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</code> |
| <div class="block">Invalidate an entry from the cache.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html#pinAndGet-K-">pinAndGet</a></span>(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</code> |
| <div class="block">Get value from the cache or load the value pinning it so that the entry will never get evicted.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html#unpin-K-">unpin</a></span>(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</code> |
| <div class="block">Unpin an entry from the cache so that it can be a candidate for eviction.</div> |
| </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="get-java.lang.Object-"> |
| <!-- --> |
| </a><a name="get-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">V</a> get(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</pre> |
| <div class="block"><p>Get value from the cache or load the value.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pinAndGet-java.lang.Object-"> |
| <!-- --> |
| </a><a name="pinAndGet-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pinAndGet</h4> |
| <pre><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">V</a> pinAndGet(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</pre> |
| <div class="block"><p>Get value from the cache or load the value pinning it so that the entry will never get evicted.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unpin-java.lang.Object-"> |
| <!-- --> |
| </a><a name="unpin-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpin</h4> |
| <pre>boolean unpin(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</pre> |
| <div class="block"><p>Unpin an entry from the cache so that it can be a candidate for eviction.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the entry was unpinned, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asMap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asMap</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a>,<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">V</a>> asMap()</pre> |
| <div class="block"><p>Return a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentMap</code></a> view of the current entries in the cache.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the map of key-values currently cached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invalidate-java.lang.Object-"> |
| <!-- --> |
| </a><a name="invalidate-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>invalidate</h4> |
| <pre>void invalidate(<a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.html" title="type parameter in WindowPartitionCache">K</a> key)</pre> |
| <div class="block"><p>Invalidate an entry from the cache.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/WindowPartitionCache.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 class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/windowing/persistence/SimpleWindowPartitionCache.SimpleWindowPartitionCacheBuilder.html" title="class in org.apache.storm.windowing.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/windowing/persistence/WindowPartitionCache.Builder.html" title="interface in org.apache.storm.windowing.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/windowing/persistence/WindowPartitionCache.html" target="_top">Frames</a></li> |
| <li><a href="WindowPartitionCache.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
