blob: b8f955a5012cda23a09359e80d95b97b804634fb [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/expiry/ExpiryPolicy.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>ExpiryPolicy (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="ExpiryPolicy (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/ExpiryPolicy.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/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/cache/expiry/ModifiedExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/expiry/ExpiryPolicy.html" target="_top">Frames</a></li>
<li><a href="ExpiryPolicy.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">javax.cache.expiry</div>
<h2 title="Interface ExpiryPolicy" class="title">Interface ExpiryPolicy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../javax/cache/expiry/AccessedExpiryPolicy.html" title="class in javax.cache.expiry">AccessedExpiryPolicy</a>, <a href="../../../javax/cache/expiry/CreatedExpiryPolicy.html" title="class in javax.cache.expiry">CreatedExpiryPolicy</a>, <a href="../../../javax/cache/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry">EternalExpiryPolicy</a>, <a href="../../../javax/cache/expiry/ModifiedExpiryPolicy.html" title="class in javax.cache.expiry">ModifiedExpiryPolicy</a>, <a href="../../../javax/cache/expiry/TouchedExpiryPolicy.html" title="class in javax.cache.expiry">TouchedExpiryPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ExpiryPolicy</span></pre>
<div class="block">Defines functions to determine when cache entries will expire based on
creation, access and modification operations.
<p>
Each of the functions return a new <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> that specifies the
amount of time that must pass before a cache entry is considered expired.
<a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> has constants defined for useful durations.</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>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a></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">&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><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/expiry/ExpiryPolicy.html#getExpiryForAccess()">getExpiryForAccess</a></strong>()</code>
<div class="block">Gets the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an accessed Cache.Entry is
considered expired.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/expiry/ExpiryPolicy.html#getExpiryForCreation()">getExpiryForCreation</a></strong>()</code>
<div class="block">Gets the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before a newly created Cache.Entry is considered
expired.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/expiry/ExpiryPolicy.html#getExpiryForUpdate()">getExpiryForUpdate</a></strong>()</code>
<div class="block">Gets the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an updated Cache.Entry is considered
expired.</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="getExpiryForCreation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpiryForCreation</h4>
<pre><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a>&nbsp;getExpiryForCreation()</pre>
<div class="block">Gets the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before a newly created Cache.Entry is considered
expired.
<p>
This method is called by a caching implementation after a Cache.Entry is
created, but before a Cache.Entry is added to a cache, to determine the
<a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an entry expires. If a <a href="../../../javax/cache/expiry/Duration.html#ZERO"><code>Duration.ZERO</code></a>
is returned the new Cache.Entry is considered to be already expired and
will not be added to the Cache.
<p>
Should an exception occur while determining the Duration, an implementation
specific default <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> will be used.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the new <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before a created entry expires</dd></dl>
</li>
</ul>
<a name="getExpiryForAccess()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpiryForAccess</h4>
<pre><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a>&nbsp;getExpiryForAccess()</pre>
<div class="block">Gets the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an accessed Cache.Entry is
considered expired.
<p>
This method is called by a caching implementation after a Cache.Entry is
accessed to determine the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an entry expires. If a
<a href="../../../javax/cache/expiry/Duration.html#ZERO"><code>Duration.ZERO</code></a> is returned a Cache.Entry will be
considered immediately expired. Returning <code>null</code> will result
in no change to the previously understood expiry <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a>.
<p>
Should an exception occur while determining the Duration, an implementation
specific default Duration will be used.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the new <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an accessed entry expires</dd></dl>
</li>
</ul>
<a name="getExpiryForUpdate()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getExpiryForUpdate</h4>
<pre><a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a>&nbsp;getExpiryForUpdate()</pre>
<div class="block">Gets the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an updated Cache.Entry is considered
expired.
<p>
This method is called by the caching implementation after a Cache.Entry is
updated to determine the <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before the updated entry expires.
If a <a href="../../../javax/cache/expiry/Duration.html#ZERO"><code>Duration.ZERO</code></a> is returned a Cache.Entry is considered
immediately expired. Returning <code>null</code> will result in no change
to the previously understood expiry <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a>.
<p>
Should an exception occur while determining the Duration, an implementation
specific default Duration will be used.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the new <a href="../../../javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> before an updated entry expires</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/ExpiryPolicy.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/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/cache/expiry/ModifiedExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/expiry/ExpiryPolicy.html" target="_top">Frames</a></li>
<li><a href="ExpiryPolicy.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 &#169; 2014. All Rights Reserved.</small></p>
</body>
</html>