blob: 3b7c997d09ff8f7ec539783656f4b22ae1c004d8 [file] [log] [blame]
<!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/event/package-summary.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>javax.cache.event (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="javax.cache.event (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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="../../../javax/cache/configuration/package-summary.html">Prev Package</a></li>
<li><a href="../../../javax/cache/expiry/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/event/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;javax.cache.event</h1>
<div class="docSummary">
<div class="block">This package contains event listener interfaces.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryCreatedListener.html" title="interface in javax.cache.event">CacheEntryCreatedListener</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Invoked after a cache entry is created, or if a batch call is made, after the
entries are created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event">CacheEntryEventFilter</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A function that may be used to check <a href="../../../javax/cache/event/CacheEntryEvent.html" title="class in javax.cache.event"><code>CacheEntryEvent</code></a>s prior to being
dispatched to <a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryExpiredListener.html" title="interface in javax.cache.event">CacheEntryExpiredListener</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Invoked if a cache entry or entries are evicted due to expiration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event">CacheEntryListener</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A tagging interface for cache entry listeners.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryRemovedListener.html" title="interface in javax.cache.event">CacheEntryRemovedListener</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Invoked if a cache entry is removed, or if a batch call is made, after the
entries are removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryUpdatedListener.html" title="interface in javax.cache.event">CacheEntryUpdatedListener</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Invoked if an existing cache entry is updated, or if a batch call is made,
after the entries are updated.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryEvent.html" title="class in javax.cache.event">CacheEntryEvent</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A Cache entry event base class.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/cache/event/EventType.html" title="enum in javax.cache.event">EventType</a></td>
<td class="colLast">
<div class="block">The type of event received by the listener.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../javax/cache/event/CacheEntryListenerException.html" title="class in javax.cache.event">CacheEntryListenerException</a></td>
<td class="colLast">
<div class="block">An exception to indicate a problem has occurred with a listener.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package javax.cache.event Description">Package javax.cache.event Description</h2>
<div class="block">This package contains event listener interfaces.
<p>
These may be registered for callback notification of the cache events.
The specific interface should be implemented for each event type a callback
is desired on.
<p>
Event notifications occur synchronously in the line of execution of the calling thread.
The calling thread blocks until the listener has completed execution or thrown a <a href="../../../javax/cache/event/CacheEntryCreatedListener.html" title="interface in javax.cache.event"><code>CacheEntryCreatedListener</code></a>.
<p>
Listeners are invoked <strong>after</strong> the cache is updated. If the listener throws
an <a href="../../../javax/cache/event/CacheEntryCreatedListener.html" title="interface in javax.cache.event"><code>CacheEntryCreatedListener</code></a> this will propagate back to the caller but it does not affect the cache update
as it already completed before the listener was called.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Greg Luck, Yannis Cosmadopoulos</dd></dl>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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="../../../javax/cache/configuration/package-summary.html">Prev Package</a></li>
<li><a href="../../../javax/cache/expiry/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/event/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All Rights Reserved.</small></p>
</body>
</html>