blob: b6b990ac1d0809bcdaf171926263698b6a280ee8 [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>GrailsConcurrentLinkedMapCache (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="GrailsConcurrentLinkedMapCache (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/GrailsConcurrentLinkedMapCache" target="_top">Frames</a></li>
<li><a href="GrailsConcurrentLinkedMapCache.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</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] Class GrailsConcurrentLinkedMapCache" class="title">[Java] Class GrailsConcurrentLinkedMapCache</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>grails.plugin.cache.GrailsConcurrentLinkedMapCache
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces and Traits:</dt>
<dd><a href='../../../grails/plugin/cache/GrailsCache.html'>GrailsCache</a></dd>
</dl>
<!-- todo: direct known subclasses -->
<hr>
<pre>public class GrailsConcurrentLinkedMapCache
extends java.lang.Object
implements <a href='../../../grails/plugin/cache/GrailsCache.html'>GrailsCache</a></pre>
<p>
<DL><DT><B>Authors:</B></DT><DD>Jakob Drangmeister</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 =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary"><!-- --></a>
<h3>Constructor Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor and description</th>
</tr>
<tr class="altColor">
<td class="colFirst">
<code><strong><a href="#GrailsConcurrentLinkedMapCache(java.lang.String, long, boolean)">GrailsConcurrentLinkedMapCache</a></strong>(java.lang.String name, long capacity, boolean allowNullValues)</code><br>Create a new GrailsConcurrentLinkedMapCache with the specified name
and capacity</td>
</tr>
<tr class="rowColor">
<td class="colFirst">
<code><strong><a href="#GrailsConcurrentLinkedMapCache(java.lang.String, long)">GrailsConcurrentLinkedMapCache</a></strong>(java.lang.String name, long capacity)</code><br>Create a new GrailsConcurrentLinkedMapCache with the specified name
and capacity</td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type Params</th>
<th class="colLast" scope="col">Return Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="#clear()">clear</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="#evict(java.lang.Object)">evict</a></strong>(java.lang.Object key)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>protected&nbsp;java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="#fromStoreValue(java.lang.Object)">fromStoreValue</a></strong>(java.lang.Object storeValue)</code><br>Convert the given value from the internal store to a user value
returned from the get method (adapting <CODE>null</CODE>).</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;<a href='../../../grails/plugin/cache/GrailsValueWrapper.html'>GrailsValueWrapper</a></code></td>
<td class="colLast"><code><strong><a href="#get(java.lang.Object)">get</a></strong>(java.lang.Object key)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;</code></td>
<td class="colLast"><code>public&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="#get(java.lang.Object, Class)">get</a></strong>(java.lang.Object key, java.lang.Class&lt;T&gt; type)</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;</code></td>
<td class="colLast"><code>public&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="#get(java.lang.Object, Callable)">get</a></strong>(java.lang.Object key, java.util.concurrent.Callable&lt;T&gt; valueLoader)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;java.util.Collection&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><strong><a href="#getAllKeys()">getAllKeys</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;final&nbsp;long</code></td>
<td class="colLast"><code><strong><a href="#getCapacity()">getCapacity</a></strong>()</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;java.util.Collection&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><strong><a href="#getHottestKeys()">getHottestKeys</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;final&nbsp;java.lang.String</code></td>
<td class="colLast"><code><strong><a href="#getName()">getName</a></strong>()</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;final&nbsp;java.util.concurrent.ConcurrentMap&lt;java.lang.Object, java.lang.Object&gt;</code></td>
<td class="colLast"><code><strong><a href="#getNativeCache()">getNativeCache</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;final&nbsp;int</code></td>
<td class="colLast"><code><strong><a href="#getSize()">getSize</a></strong>()</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;final&nbsp;boolean</code></td>
<td class="colLast"><code><strong><a href="#isAllowNullValues()">isAllowNullValues</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="#put(java.lang.Object, java.lang.Object)">put</a></strong>(java.lang.Object key, java.lang.Object value)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>public&nbsp;<a href='../../../ValueWrapper.html'>ValueWrapper</a></code></td>
<td class="colLast"><code><strong><a href="#putIfAbsent(java.lang.Object, java.lang.Object)">putIfAbsent</a></strong>(java.lang.Object key, java.lang.Object value)</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code></code></td>
<td class="colLast"><code>protected&nbsp;java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="#toStoreValue(java.lang.Object)">toStoreValue</a></strong>(java.lang.Object userValue)</code><br>Convert the given user value, as passed into the put method,
to a value in the internal store (adapting <CODE>null</CODE>).</td>
</tr>
</table>
</ul>
</li>
<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">
<!-- =========== CONSTRUCTOR DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GrailsConcurrentLinkedMapCache(java.lang.String, long, boolean)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;<strong>GrailsConcurrentLinkedMapCache</strong>(java.lang.String name, long capacity, boolean allowNullValues)</h4>
<p> Create a new GrailsConcurrentLinkedMapCache with the specified name
and capacity
<DL><DT><B>Parameters:</B></DT><DD><code>name</code> - the name of the cache</DD><DD><code>capacity</code> - of the map</DD><DD><code>allowNullValues</code> - null values (default is true)</DD></DL></p>
</li>
</ul>
<a name="GrailsConcurrentLinkedMapCache(java.lang.String, long)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;<strong>GrailsConcurrentLinkedMapCache</strong>(java.lang.String name, long capacity)</h4>
<p> Create a new GrailsConcurrentLinkedMapCache with the specified name
and capacity
<DL><DT><B>Parameters:</B></DT><DD><code>name</code> - the name of the cache</DD><DD><code>capacity</code> - of the map</DD></DL></p>
</li>
</ul>
</li>
</ul>
<!-- =========== METHOD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="clear()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override<br>public&nbsp;void <strong>clear</strong>()</h4>
<p></p>
</li>
</ul>
<a name="evict(java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override<br>public&nbsp;void <strong>evict</strong>(java.lang.Object key)</h4>
<p></p>
</li>
</ul>
<a name="fromStoreValue(java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.Object <strong>fromStoreValue</strong>(java.lang.Object storeValue)</h4>
<p> Convert the given value from the internal store to a user value
returned from the get method (adapting <CODE>null</CODE>).
<DL><DT><B>Parameters:</B></DT><DD><code>storeValue</code> - the store value</DD></DL><DL><DT><B>Returns:</B></DT><DD>the value to return to the user</DD></DL></p>
</li>
</ul>
<a name="get(java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override<br>public&nbsp;<a href='../../../grails/plugin/cache/GrailsValueWrapper.html'>GrailsValueWrapper</a> <strong>get</strong>(java.lang.Object key)</h4>
<p></p>
</li>
</ul>
<a name="get(java.lang.Object, Class)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>&lt;T&gt; @java.lang.Override<br>public&nbsp;T <strong>get</strong>(java.lang.Object key, java.lang.Class&lt;T&gt; type)</h4>
<p></p>
</li>
</ul>
<a name="get(java.lang.Object, Callable)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>&lt;T&gt; @java.lang.Override<br>public&nbsp;T <strong>get</strong>(java.lang.Object key, java.util.concurrent.Callable&lt;T&gt; valueLoader)</h4>
<p></p>
</li>
</ul>
<a name="getAllKeys()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.SuppressWarnings("unchecked")<br>public&nbsp;java.util.Collection&lt;java.lang.Object&gt; <strong>getAllKeys</strong>()</h4>
<p></p>
</li>
</ul>
<a name="getCapacity()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;final&nbsp;long <strong>getCapacity</strong>()</h4>
<p></p>
</li>
</ul>
<a name="getHottestKeys()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;java.util.Collection&lt;java.lang.Object&gt; <strong>getHottestKeys</strong>()</h4>
<p></p>
</li>
</ul>
<a name="getName()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override<br>public&nbsp;final&nbsp;java.lang.String <strong>getName</strong>()</h4>
<p></p>
</li>
</ul>
<a name="getNativeCache()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override<br>public&nbsp;final&nbsp;java.util.concurrent.ConcurrentMap&lt;java.lang.Object, java.lang.Object&gt; <strong>getNativeCache</strong>()</h4>
<p></p>
</li>
</ul>
<a name="getSize()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;final&nbsp;int <strong>getSize</strong>()</h4>
<p></p>
</li>
</ul>
<a name="isAllowNullValues()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;final&nbsp;boolean <strong>isAllowNullValues</strong>()</h4>
<p></p>
</li>
</ul>
<a name="put(java.lang.Object, java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override<br>public&nbsp;void <strong>put</strong>(java.lang.Object key, java.lang.Object value)</h4>
<p></p>
</li>
</ul>
<a name="putIfAbsent(java.lang.Object, java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>public&nbsp;<a href='../../../ValueWrapper.html'>ValueWrapper</a> <strong>putIfAbsent</strong>(java.lang.Object key, java.lang.Object value)</h4>
<p></p>
</li>
</ul>
<a name="toStoreValue(java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.Object <strong>toStoreValue</strong>(java.lang.Object userValue)</h4>
<p> Convert the given user value, as passed into the put method,
to a value in the internal store (adapting <CODE>null</CODE>).
<DL><DT><B>Parameters:</B></DT><DD><code>userValue</code> - the given user value</DD></DL><DL><DT><B>Returns:</B></DT><DD>the value to store</DD></DL></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/GrailsConcurrentLinkedMapCache" target="_top">Frames</a></li>
<li><a href="GrailsConcurrentLinkedMapCache.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</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>