| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/jcache/1.0.0/javadoc/javax/cache/configuration/CacheEntryListenerConfiguration.html" /> |
| <!-- Generated by javadoc (version 1.7.0_25) on Fri Mar 28 13:34:25 EST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>CacheEntryListenerConfiguration (JSR107 API and SPI 1.0.0 API)</title> |
| <meta name="date" content="2014-03-28"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CacheEntryListenerConfiguration (JSR107 API and SPI 1.0.0 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/CacheEntryListenerConfiguration.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>Prev Class</li> |
| <li><a href="../../../javax/cache/configuration/CompleteConfiguration.html" title="interface in javax.cache.configuration"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/cache/configuration/CacheEntryListenerConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="CacheEntryListenerConfiguration.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>Nested | </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">javax.cache.configuration</div> |
| <h2 title="Interface CacheEntryListenerConfiguration" class="title">Interface CacheEntryListenerConfiguration<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - the type of keys</dd><dd><code>V</code> - the type of values</dd></dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../javax/cache/configuration/MutableCacheEntryListenerConfiguration.html" title="class in javax.cache.configuration">MutableCacheEntryListenerConfiguration</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">CacheEntryListenerConfiguration<K,V></span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">Defines the configuration requirements for a |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a> and a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for its |
| creation.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Brian Oliver, Greg Luck</dd></dl> |
| </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"> </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><a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><<a href="../../../javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event">CacheEntryEventFilter</a><? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">K</a>,? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">V</a>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html#getCacheEntryEventFilterFactory()">getCacheEntryEventFilterFactory</a></strong>()</code> |
| <div class="block">Obtains the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="../../../javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event"><code>CacheEntryEventFilter</code></a> that should be |
| applied prior to notifying the <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><<a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event">CacheEntryListener</a><? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">K</a>,? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">V</a>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html#getCacheEntryListenerFactory()">getCacheEntryListenerFactory</a></strong>()</code> |
| <div class="block">Obtains the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html#isOldValueRequired()">isOldValueRequired</a></strong>()</code> |
| <div class="block">Determines if the old value should be provided to the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html#isSynchronous()">isSynchronous</a></strong>()</code> |
| <div class="block">Determines if the thread that caused an event to be created should be |
| blocked (not return from the operation causing the event) until the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a> has been notified.</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="getCacheEntryListenerFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheEntryListenerFactory</h4> |
| <pre><a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><<a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event">CacheEntryListener</a><? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">K</a>,? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">V</a>>> getCacheEntryListenerFactory()</pre> |
| <div class="block">Obtains the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isOldValueRequired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOldValueRequired</h4> |
| <pre>boolean isOldValueRequired()</pre> |
| <div class="block">Determines if the old value should be provided to the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the old value is required by the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCacheEntryEventFilterFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheEntryEventFilterFactory</h4> |
| <pre><a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><<a href="../../../javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event">CacheEntryEventFilter</a><? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">K</a>,? super <a href="../../../javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">V</a>>> getCacheEntryEventFilterFactory()</pre> |
| <div class="block">Obtains the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="../../../javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event"><code>CacheEntryEventFilter</code></a> that should be |
| applied prior to notifying the <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>. |
| <p> |
| When <code>null</code> no filtering is applied and all appropriate events |
| are notified.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the |
| <a href="../../../javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event"><code>CacheEntryEventFilter</code></a> or <code>null</code> |
| if no filtering is required</dd></dl> |
| </li> |
| </ul> |
| <a name="isSynchronous()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isSynchronous</h4> |
| <pre>boolean isSynchronous()</pre> |
| <div class="block">Determines if the thread that caused an event to be created should be |
| blocked (not return from the operation causing the event) until the |
| <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a> has been notified.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the thread that created the event should block</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><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/CacheEntryListenerConfiguration.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>Prev Class</li> |
| <li><a href="../../../javax/cache/configuration/CompleteConfiguration.html" title="interface in javax.cache.configuration"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/cache/configuration/CacheEntryListenerConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="CacheEntryListenerConfiguration.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>Nested | </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 © 2014. All Rights Reserved.</small></p> |
| </body> |
| </html> |
