blob: a5c6b6411ad92963b28b5ad8d5a83049748de9d0 [file]
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->
<html>
<head>
<!-- Generated by groovydoc (4.0.30) -->
<title>CacheEvict (Grails 7.0.9)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../groovy.ico" type="image/x-icon" rel="icon">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CacheEvict (Grails 7.0.9)";
}
//-->
</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="../../../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">
<div>
<ul class="navList">
<li><a href="../../../index.html?grails/plugin/cache/CacheEvict" target="_top">Frames</a></li>
<li><a href="CacheEvict.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#required_element_summary">Required</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#optional_element_summary">Optional</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
<li><a href="#element_detail">Element</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Package: <strong>grails.plugin.cache</strong></div>
<h2 title="[Java] Annotation Type CacheEvict" class="title">[Java] Annotation Type CacheEvict</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>grails.plugin.cache.CacheEvict
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<!-- todo: direct known subclasses -->
<hr>
<pre>@java.lang.annotation.Target({ElementType.METHOD, ElementType.TYPE})
@java.lang.annotation.Retention(RetentionPolicy.RUNTIME)
@java.lang.annotation.Inherited
@java.lang.annotation.Documented
@org.codehaus.groovy.transform.GroovyASTTransformationClass("org.grails.plugin.cache.compiler.CacheEvictTransformation")
public @interface CacheEvict</pre>
<p> Indicates that a method (or all methods on a class) trigger(s)
a cache invalidate operation.
<DL><DT><B>Authors:</B></DT><DD>Jeff Brown</DD><DD>Graeme Rocher</DD></DL></p>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== NESTED CLASS SUMMARY =========== -->
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== PROPERTY SUMMARY =========== -->
<!-- =========== ELEMENT SUMMARY =========== -->
<ul class="blockList"><a name="element_summary"><!-- --></a>
<li class="blockList">
<h3>Element Summary</h3>
<a name="required_element_summary"><!-- --></a>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table">
<caption><span>Required Element Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>java.lang.String[]</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#value">value</a></code><br>Qualifier value for the specified cached operation.</td>
</tr>
</table>
</ul>
<a name="optional_element_summary"><!-- --></a>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table">
<caption><span>Optional Element Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>boolean</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#allEntries">allEntries</a></code><br>Whether or not all the entries inside the cache(s) are removed or not. </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>java.lang.Class[]</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#condition">condition</a></code><br>A closure used for conditioning the method caching.</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>java.lang.Class[]</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#key">key</a></code><br>A closure for computing the key dynamically.</td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Inherited Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
<caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Methods inherited from class</th>
<th class="colLast" scope="col">Name</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class java.lang.Object</code></td>
<td class="colLast"><code>java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)</code></td>
</tr>
</table>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- =========== ELEMENT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="element_detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="allEntries"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;boolean <strong>allEntries</strong></h4>
<p> Whether or not all the entries inside the cache(s) are removed or not. By
default, only the value under the associated key is removed.
<p>Note that specifying setting this parameter to true and specifying a
CacheKey is not allowed. <DL><DT><B>Default:</B></DT><DD>false</DD></DL></p>
</li>
</ul>
<a name="condition"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;java.lang.Class[] <strong>condition</strong></h4>
<p> A closure used for conditioning the method caching.
<p>Default is null, meaning the method is always cached. <DL><DT><B>Default:</B></DT><DD>{}</DD></DL></p>
</li>
</ul>
<a name="key"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;java.lang.Class[] <strong>key</strong></h4>
<p> A closure for computing the key dynamically.
<p>Default is null, meaning all method parameters are considered as a key. <DL><DT><B>Default:</B></DT><DD>{}</DD></DL></p>
</li>
</ul>
<a name="value"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;java.lang.String[] <strong>value</strong></h4>
<p> Qualifier value for the specified cached operation.
<p>May be used to determine the target cache (or caches), matching the qualifier
value.
</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</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="../../../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">
<div>
<ul class="navList">
<li><a href="../../../index.html?grails/plugin/cache/CacheEvict" target="_top">Frames</a></li>
<li><a href="CacheEvict.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#required_element_summary">Required</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#optional_element_summary">Optional</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
<li><a href="#element_detail">Element</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<p><!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(["setDoNotTrack", true]);
_paq.push(["disableCookies"]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '79']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code --></p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>