blob: 8f87f7a280c8822ea8e0d7ebc7f0678be04faa75 [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>
<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(72949126, "init", {
clickmap:true,
trackLinks:true,
accurateTrackBounce:true,
webvisor:true
});
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->
<script type='text/javascript'>
window.__lo_site_id = 284467;
(function() {
var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
})();
</script>
<link rel="canonical" href="https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/client/ClientCache.html" />
<!-- Generated by javadoc (1.8.0_261) on Wed Dec 09 14:33:08 MSK 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientCache (Ignite 2.9.1)</title>
<meta name="date" content="2020-12-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
<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"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClientCache (Ignite 2.9.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/ClientCache.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="../../../../org/apache/ignite/client/ClientAuthorizationException.html" title="class in org.apache.ignite.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/client/ClientCacheConfiguration.html" title="class in org.apache.ignite.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/client/ClientCache.html" target="_top">Frames</a></li>
<li><a href="ClientCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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">org.apache.ignite.client</div>
<h2 title="Interface ClientCache" class="title">Interface ClientCache<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClientCache<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></span></pre>
<div class="block">Thin client cache.</div>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#clear--">clear</a></span>()</code>
<div class="block">Clears the contents of the cache.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#containsKey-K-">containsKey</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)</code>
<div class="block">Determines if the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a> contains an entry for the specified key.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#get-K-">get</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)</code>
<div class="block">Gets an entry from the cache.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</span><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>,<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#getAll-java.util.Set-">getAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keys)</code>
<div class="block">Gets a collection of entries from the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a>, returning them as
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of the values associated with the set of keys requested.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#getAndPut-K-V-">getAndPut</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)</code>
<div class="block">Associates the specified value with the specified key in this cache, returning an existing value if one existed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#getAndRemove-K-">getAndRemove</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)</code>
<div class="block">Atomically removes the entry for a key only if currently mapped to some value.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#getAndReplace-K-V-">getAndReplace</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)</code>
<div class="block">Atomically replaces the value for a given key if and only if there is a value currently mapped by the key.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientCacheConfiguration.html" title="class in org.apache.ignite.client">ClientCacheConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#getConfiguration--">getConfiguration</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#getName--">getName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#put-K-V-">put</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)</code>
<div class="block">Associates the specified value with the specified key in the cache.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#putAll-java.util.Map-">putAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>,? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a><span class='angle_bracket'>&gt;</span>&nbsp;map)</code>
<div class="block">Copies all of the entries from the specified map to the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#putIfAbsent-K-V-">putIfAbsent</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)</code>
<div class="block">Atomically associates the specified key with the given value if it is not already associated with a value.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../org/apache/ignite/cache/query/QueryCursor.html" title="interface in org.apache.ignite.cache.query">QueryCursor</a><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#query-org.apache.ignite.cache.query.Query-">query</a></span>(<a href="../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span>&nbsp;qry)</code>
<div class="block">Queries cache.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/cache/query/FieldsQueryCursor.html" title="interface in org.apache.ignite.cache.query">FieldsQueryCursor</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#query-org.apache.ignite.cache.query.SqlFieldsQuery-">query</a></span>(<a href="../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a>&nbsp;qry)</code>
<div class="block">Convenience method to execute <a href="../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query"><code>SqlFieldsQuery</code></a>.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#remove-K-">remove</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)</code>
<div class="block">Removes the mapping for a key from this cache if it is present.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#remove-K-V-">remove</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;oldVal)</code>
<div class="block">Atomically removes the mapping for a key only if currently mapped to the given value.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#removeAll--">removeAll</a></span>()</code>
<div class="block">Removes all of the mappings from this cache.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#removeAll-java.util.Set-">removeAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keys)</code>
<div class="block">Removes entries for the specified keys.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#replace-K-V-">replace</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)</code>
<div class="block">Atomically replaces the entry for a key only if currently mapped to some
value.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#replace-K-V-V-">replace</a></span>(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;oldVal,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;newVal)</code>
<div class="block">Atomically replaces the entry for a key only if currently mapped to a given value.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#size-org.apache.ignite.cache.CachePeekMode...-">size</a></span>(<a href="../../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>...&nbsp;peekModes)</code>
<div class="block">Gets the number of all entries cached across all nodes.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client">ClientCache</a><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#withExpirePolicy-javax.cache.expiry.ExpiryPolicy-">withExpirePolicy</a></span>(javax.cache.expiry.ExpiryPolicy&nbsp;expirePlc)</code>
<div class="block">Returns cache with the specified expired policy set.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client">ClientCache</a><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCache.html#withKeepBinary--">withKeepBinary</a></span>()</code>
<div class="block">Returns cache that will operate with binary objects.</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="get-java.lang.Object-">
<!-- -->
</a><a name="get-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;get(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Gets an entry from the cache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key whose associated value is to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the element, or null, if it does not exist.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the key is null.</dd>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="put-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="put-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>void&nbsp;put(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Associates the specified value with the specified key in the cache.
<p>
If the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a> previously contained a mapping for the key, the old
value is replaced by the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - key with which the specified value is to be associated</dd>
<dd><code>val</code> - value to be associated with the specified key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if key is null or if value is null.</dd>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="containsKey-java.lang.Object-">
<!-- -->
</a><a name="containsKey-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre>boolean&nbsp;containsKey(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Determines if the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a> contains an entry for the specified key.
<p>
More formally, returns <tt>true</tt> if and only if this cache contains a
mapping for a key <tt>k</tt> such that <tt>key.equals(k)</tt>.
(There can be at most one such mapping)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - key whose presence in this cache is to be tested.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>true</tt> if this map contains a mapping for the specified key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the cache.</dd>
</dl>
</li>
</ul>
<a name="getConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientCacheConfiguration.html" title="class in org.apache.ignite.client">ClientCacheConfiguration</a>&nbsp;getConfiguration()
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The cache configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="size-org.apache.ignite.cache.CachePeekMode...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>int&nbsp;size(<a href="../../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>...&nbsp;peekModes)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Gets the number of all entries cached across all nodes. By default, if <code>peekModes</code> value isn't provided,
only size of primary copies across all nodes will be returned. This behavior is identical to calling
this method with <a href="../../../../org/apache/ignite/cache/CachePeekMode.html#PRIMARY"><code>CachePeekMode.PRIMARY</code></a> peek mode.
<p>
NOTE: this operation is distributed and will query all participating nodes for their cache sizes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>peekModes</code> - Optional peek modes. If not provided, then total cache size is returned.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAll-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</span><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>,<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a><span class='angle_bracket'>&gt;</span>&nbsp;getAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keys)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Gets a collection of entries from the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a>, returning them as
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of the values associated with the set of keys requested.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keys</code> - The keys whose associated values are to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A map of entries that were found for the given keys. Keys not found
in the cache are not in the returned map.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="putAll-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
<pre>void&nbsp;putAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>,? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a><span class='angle_bracket'>&gt;</span>&nbsp;map)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Copies all of the entries from the specified map to the <a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client"><code>ClientCache</code></a>.
<p>
The effect of this call is equivalent to that of calling
<a href="../../../../org/apache/ignite/client/ClientCache.html#put-K-V-"><code>put(k, v)</code></a> on this cache once for each mapping
from key <tt>k</tt> to value <tt>v</tt> in the specified map.
<p>
The order in which the individual puts occur is undefined.
<p>
The behavior of this operation is undefined if entries in the cache
corresponding to entries in the map are modified or removed while this
operation is in progress. or if map is modified while the operation is in
progress.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</code> - Mappings to be stored in this cache.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="replace-java.lang.Object-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="replace-K-V-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre>boolean&nbsp;replace(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;oldVal,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;newVal)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Atomically replaces the entry for a key only if currently mapped to a given value.
<p>
This is equivalent to:
<pre><code>
if (cache.containsKey(key) &amp;&amp; equals(cache.get(key), oldValue)) {
cache.put(key, newValue);
return true;
} else {
return false;
}
</code></pre>
except that the action is performed atomically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key with which the specified value is associated.</dd>
<dd><code>oldVal</code> - Value expected to be associated with the specified key.</dd>
<dd><code>newVal</code> - Value to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>true</tt> if the value was replaced</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="replace-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="replace-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre>boolean&nbsp;replace(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Atomically replaces the entry for a key only if currently mapped to some
value.
<p>
This is equivalent to
<pre><code>
if (cache.containsKey(key)) {
cache.put(key, value);
return true;
} else {
return false;
}</code></pre>
except that the action is performed atomically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The key with which the specified value is associated.</dd>
<dd><code>val</code> - The value to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>true</tt> if the value was replaced.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="remove-java.lang.Object-">
<!-- -->
</a><a name="remove-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean&nbsp;remove(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Removes the mapping for a key from this cache if it is present.
<p>
More formally, if this cache contains a mapping from key <tt>k</tt> to value <tt>v</tt> such that
<code>(key==null ? k==null : key.equals(k))</code>, that mapping is removed.
(The cache can contain at most one such mapping.)
<p>Returns <tt>true</tt> if this cache previously associated the key, or <tt>false</tt> if the cache
contained no mapping for the key.
<p>
The cache will not contain a mapping for the specified key once the
call returns.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key whose mapping is to be removed from the cache.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>false</tt> if there was no matching key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="remove-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="remove-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean&nbsp;remove(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;oldVal)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Atomically removes the mapping for a key only if currently mapped to the given value.
<p>
This is equivalent to:
<pre><code>
if (cache.containsKey(key) &amp;&amp; equals(cache.get(key), oldValue) {
cache.remove(key);
return true;
} else {
return false;
}
</code></pre>
except that the action is performed atomically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key whose mapping is to be removed from the cache.</dd>
<dd><code>oldVal</code> - Value expected to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>false</tt> if there was no matching key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="removeAll-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>void&nbsp;removeAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keys)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Removes entries for the specified keys.
<p>
The order in which the individual entries are removed is undefined.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keys</code> - The keys to remove.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="removeAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>void&nbsp;removeAll()
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Removes all of the mappings from this cache.
<p>
The order that the individual entries are removed is undefined.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAndPut-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="getAndPut-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAndPut</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;getAndPut(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Associates the specified value with the specified key in this cache, returning an existing value if one existed.
<p>
If the cache previously contained a mapping for
the key, the old value is replaced by the specified value. (A cache
<tt>c</tt> is said to contain a mapping for a key <tt>k</tt> if and only
if <a href="../../../../org/apache/ignite/client/ClientCache.html#containsKey-K-"><code>c.containsKey(k)</code></a> would return
<tt>true</tt>.)
<p>
The previous value is returned, or null if there was no value associated
with the key previously.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key with which the specified value is to be associated.</dd>
<dd><code>val</code> - Value to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value associated with the key at the start of the operation or
null if none was associated.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAndRemove-java.lang.Object-">
<!-- -->
</a><a name="getAndRemove-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAndRemove</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;getAndRemove(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Atomically removes the entry for a key only if currently mapped to some value.
<p>
This is equivalent to:
<pre><code>
if (cache.containsKey(key)) {
V oldValue = cache.get(key);
cache.remove(key);
return oldValue;
} else {
return null;
}
</code></pre>
except that the action is performed atomically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key with which the specified value is associated.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value if one existed or null if no mapping existed for this key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAndReplace-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="getAndReplace-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAndReplace</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;getAndReplace(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Atomically replaces the value for a given key if and only if there is a value currently mapped by the key.
<p>
This is equivalent to
<pre><code>
if (cache.containsKey(key)) {
V oldValue = cache.get(key);
cache.put(key, value);
return oldValue;
} else {
return null;
}
</code></pre>
except that the action is performed atomically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key with which the specified value is associated.</dd>
<dd><code>val</code> - Value to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The previous value associated with the specified key, or
<tt>null</tt> if there was no mapping for the key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="putIfAbsent-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="putIfAbsent-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putIfAbsent</h4>
<pre>boolean&nbsp;putIfAbsent(<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/client/ClientCache.html" title="type parameter in ClientCache">V</a>&nbsp;val)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Atomically associates the specified key with the given value if it is not already associated with a value.
<p>
This is equivalent to:
<pre><code>
if (!cache.containsKey(key)) {}
cache.put(key, value);
return true;
} else {
return false;
}
</code></pre>
except that the action is performed atomically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key with which the specified value is to be associated.</dd>
<dd><code>val</code> - Value to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>true</tt> if a value was set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>void&nbsp;clear()
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Clears the contents of the cache.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
<a name="withKeepBinary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withKeepBinary</h4>
<pre><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client">ClientCache</a><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span>&nbsp;withKeepBinary()</pre>
<div class="block">Returns cache that will operate with binary objects.
<p>
Cache returned by this method will not be forced to deserialize binary objects,
so keys and values will be returned from cache API methods without changes. Therefore,
signature of the cache can contain only following types:
<ul>
<li><code>org.apache.ignite.binary.BinaryObject</code> for binary classes</li>
<li>All primitives (byte, int, ...) and there boxed versions (Byte, Integer, ...)</li>
<li>Arrays of primitives (byte[], int[], ...)</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> and array of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>s</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a> and array of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a>s</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> and array of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a>s</li>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql"><code>Timestamp</code></a> and array of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql"><code>Timestamp</code></a>s</li>
<li>Enums and array of enums</li>
<li>
Maps, collections and array of objects (but objects inside
them will still be converted if they are binary)
</li>
</ul>
<p>
For example, if you use <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang"><code>Integer</code></a> as a key and <code>Value</code> class as a value
(which will be stored in binary format), you should acquire following projection
to avoid deserialization:
<pre>
CacheClient<Integer, BinaryObject> prj = cache.withKeepBinary();
// Value is not deserialized and returned in binary format.
BinaryObject po = prj.get(1);
</pre>
<p>
Note that this method makes sense only if cache is working in binary mode
if default marshaller is used.
If not, this method is no-op and will return current cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New cache instance for binary objects.</dd>
</dl>
</li>
</ul>
<a name="withExpirePolicy-javax.cache.expiry.ExpiryPolicy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withExpirePolicy</h4>
<pre><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../org/apache/ignite/client/ClientCache.html" title="interface in org.apache.ignite.client">ClientCache</a><span class='angle_bracket'>&lt;</span>K1,V1<span class='angle_bracket'>&gt;</span>&nbsp;withExpirePolicy(javax.cache.expiry.ExpiryPolicy&nbsp;expirePlc)</pre>
<div class="block">Returns cache with the specified expired policy set. This policy will be used for each operation invoked on
the returned cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cache instance with the specified expiry policy set.</dd>
</dl>
</li>
</ul>
<a name="query-org.apache.ignite.cache.query.Query-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../org/apache/ignite/cache/query/QueryCursor.html" title="interface in org.apache.ignite.cache.query">QueryCursor</a><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span>&nbsp;query(<a href="../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span>&nbsp;qry)</pre>
<div class="block">Queries cache. Supports <a href="../../../../org/apache/ignite/cache/query/ScanQuery.html" title="class in org.apache.ignite.cache.query"><code>ScanQuery</code></a> and <a href="../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query"><code>SqlFieldsQuery</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>qry</code> - Query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cursor.</dd>
</dl>
</li>
</ul>
<a name="query-org.apache.ignite.cache.query.SqlFieldsQuery-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>query</h4>
<pre><a href="../../../../org/apache/ignite/cache/query/FieldsQueryCursor.html" title="interface in org.apache.ignite.cache.query">FieldsQueryCursor</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;query(<a href="../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a>&nbsp;qry)</pre>
<div class="block">Convenience method to execute <a href="../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query"><code>SqlFieldsQuery</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>qry</code> - Query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cursor.</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/ClientCache.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="../../../../org/apache/ignite/client/ClientAuthorizationException.html" title="class in org.apache.ignite.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/client/ClientCacheConfiguration.html" title="class in org.apache.ignite.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/client/ClientCache.html" target="_top">Frames</a></li>
<li><a href="ClientCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2020 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.9.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 9 2020 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>