| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Cache</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="Cache"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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="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>Prev Class</li> |
| <li><a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheFilter.html" title="interface in org.apache.openejb.core.stateful"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/core/stateful/Cache.html" target="_top">Frames</a></li> |
| <li><a href="Cache.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.openejb.core.stateful</div> |
| <h2 title="Interface Cache" class="title">Interface Cache<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/openejb/core/stateful/SimpleCache.html" title="class in org.apache.openejb.core.stateful">SimpleCache</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Cache<K,V></span></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="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/openejb/core/stateful/Cache.CacheFilter.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheFilter</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheFilter.html" title="type parameter in Cache.CacheFilter">V</a>></span></code> |
| <div class="block">CacheFileter is used to select values to remove during a removeAll |
| invocation.</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/openejb/core/stateful/Cache.CacheListener.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheListener</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheListener.html" title="type parameter in Cache.CacheListener">V</a>></span></code> |
| <div class="block">Callback listener for cache events.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.TimeOut.html" title="interface in org.apache.openejb.core.stateful">Cache.TimeOut</a></span></code> |
| <div class="block">A cache entry can implement this interface |
| to provide its timeout.</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#add-K-V-">add</a></span>(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key, |
| <a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a> value)</code> |
| <div class="block">Add a new entry to the cache.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#checkIn-K-">checkIn</a></span>(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key)</code> |
| <div class="block">Marks the entry available, so it can be accessed again.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#checkOut-K-boolean-">checkOut</a></span>(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key, |
| boolean loadIfNotFound)</code> |
| <div class="block">Marks the entry checked-out, so this entry can not be accessed until |
| checked-in.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#destroy--">destroy</a></span>()</code> |
| <div class="block">Destroy the cache.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheListener.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheListener</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#getListener--">getListener</a></span>()</code> |
| <div class="block">Gets the listener for cache events.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#init--">init</a></span>()</code> |
| <div class="block">Initialize the cache.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#remove-K-">remove</a></span>(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key)</code> |
| <div class="block">Removes the entry from the cache.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#removeAll-org.apache.openejb.core.stateful.Cache.CacheFilter-">removeAll</a></span>(<a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheFilter.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheFilter</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a>> filter)</code> |
| <div class="block">Removes all of the entries that match the specified filter.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateful/Cache.html#setListener-org.apache.openejb.core.stateful.Cache.CacheListener-">setListener</a></span>(<a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheListener.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheListener</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a>> listener)</code> |
| <div class="block">Sets the listener for cache events.</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="getListener--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListener</h4> |
| <pre><a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheListener.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheListener</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a>> getListener()</pre> |
| <div class="block">Gets the listener for cache events.</div> |
| </li> |
| </ul> |
| <a name="setListener-org.apache.openejb.core.stateful.Cache.CacheListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setListener</h4> |
| <pre>void setListener(<a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheListener.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheListener</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a>> listener)</pre> |
| <div class="block">Sets the listener for cache events. This should be called by the |
| container before using the cache.</div> |
| </li> |
| </ul> |
| <a name="add-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="add-K-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>void add(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key, |
| <a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a> value)</pre> |
| <div class="block">Add a new entry to the cache. The entry is marked checked-out and can |
| not be accessed again until checked-in.</div> |
| </li> |
| </ul> |
| <a name="checkOut-java.lang.Object-boolean-"> |
| <!-- --> |
| </a><a name="checkOut-K-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkOut</h4> |
| <pre><a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a> checkOut(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key, |
| boolean loadIfNotFound) |
| throws java.lang.Exception</pre> |
| <div class="block">Marks the entry checked-out, so this entry can not be accessed until |
| checked-in.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if the entry is already checked out.</dd> |
| <dd><code>java.lang.Exception</code> - if an entry is loaded and the afterLoad method threw an |
| exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkIn-java.lang.Object-"> |
| <!-- --> |
| </a><a name="checkIn-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkIn</h4> |
| <pre>void checkIn(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key)</pre> |
| <div class="block">Marks the entry available, so it can be accessed again.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if the entry is not checked out.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="remove-java.lang.Object-"> |
| <!-- --> |
| </a><a name="remove-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre><a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a> remove(<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">K</a> key)</pre> |
| <div class="block">Removes the entry from the cache.</div> |
| </li> |
| </ul> |
| <a name="removeAll-org.apache.openejb.core.stateful.Cache.CacheFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAll</h4> |
| <pre>void removeAll(<a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheFilter.html" title="interface in org.apache.openejb.core.stateful">Cache.CacheFilter</a><<a href="../../../../../org/apache/openejb/core/stateful/Cache.html" title="type parameter in Cache">V</a>> filter)</pre> |
| <div class="block">Removes all of the entries that match the specified filter.</div> |
| </li> |
| </ul> |
| <a name="init--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>void init()</pre> |
| <div class="block">Initialize the cache.</div> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>void destroy()</pre> |
| <div class="block">Destroy the cache.</div> |
| </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="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>Prev Class</li> |
| <li><a href="../../../../../org/apache/openejb/core/stateful/Cache.CacheFilter.html" title="interface in org.apache.openejb.core.stateful"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/core/stateful/Cache.html" target="_top">Frames</a></li> |
| <li><a href="Cache.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 ======= --> |
| </body> |
| </html> |
