| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| <link rel="canonical" href="https://ignite.apache.org/releases/1.5.0-b1/javadoc/org/apache/ignite/IgniteCache.html" /> |
| <!-- Generated by javadoc (version 1.7.0_21) on Tue Dec 01 23:28:50 MSK 2015 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>IgniteCache (Ignite 1.5.0-b1)</title> |
| <meta name="date" content="2015-12-01"> |
| <link rel="stylesheet" type="text/css" href="../../../javadoc.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="IgniteCache (Ignite 1.5.0-b1)"; |
| } |
| //--> |
| </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/IgniteCache.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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/ignite/IgniteBinary.html" title="interface in org.apache.ignite"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/ignite/IgniteCache.html" target="_top">Frames</a></li> |
| <li><a href="IgniteCache.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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</div> |
| <h2 title="Interface IgniteCache" class="title">Interface IgniteCache<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - Cache key type.</dd><dd><code>V</code> - Cache value type.</dd></dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, javax.cache.Cache<K,V>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><javax.cache.Cache.Entry<K,V>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">IgniteCache<K,V></span> |
| extends javax.cache.Cache<K,V>, <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></pre> |
| <div class="block">Main entry point for all <b>Data Grid APIs.</b> You can get a named cache by calling <a href="../../../org/apache/ignite/Ignite.html#cache(java.lang.String)"><code>Ignite.cache(String)</code></a> |
| method. |
| <h1 class="header">Functionality</h1> |
| This API extends <code>Cache</code> API which contains <code>JCache (JSR107)</code> cache functionality |
| and documentation. In addition to <code>Cache</code> functionality this API provides: |
| <ul> |
| <li>Ability to perform basic atomic Map-like operations available on <code>JCache</code> API.</li> |
| <li>Ability to bulk load cache via <a href="../../../org/apache/ignite/IgniteCache.html#loadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)"><code>loadCache(IgniteBiPredicate, Object...)</code></a> method. |
| <li>Distributed lock functionality via <a href="../../../org/apache/ignite/IgniteCache.html#lock(K)"><code>lock(Object)</code></a> methods.</li> |
| <li>Ability to query cache using Predicate, SQL, and Text queries via <a href="../../../org/apache/ignite/IgniteCache.html#query(org.apache.ignite.cache.query.Query)"><code>query(Query)</code></a> method.</li> |
| <li>Ability to collect cache and query metrics.</li> |
| <li>Ability to force partition rebalancing via <a href="../../../org/apache/ignite/IgniteCache.html#rebalance()"><code>rebalance()</code></a> methopd |
| (in case if delayed rebalancing was configured.)</li> |
| <li>Ability to peek into memory without doing actual <code>get(...)</code> from cache |
| via <a href="../../../org/apache/ignite/IgniteCache.html#localPeek(K, org.apache.ignite.cache.CachePeekMode...)"><code>localPeek(Object, CachePeekMode...)</code></a> methods</li> |
| <li>Ability to evict and promote entries from on-heap to off-heap or swap and back.</li> |
| <li>Ability to atomically collocate compute and data via <a href="../../../org/apache/ignite/IgniteCache.html#invoke(K, org.apache.ignite.cache.CacheEntryProcessor, java.lang.Object...)"><code>invoke(Object, CacheEntryProcessor, Object...)</code></a> |
| methods.</li> |
| </ul> |
| <h1 class="header">Transactions</h1> |
| Cache API supports transactions. You can group and set of cache methods within a transaction |
| to provide ACID-compliant behavior. See <a href="../../../org/apache/ignite/IgniteTransactions.html" title="interface in org.apache.ignite"><code>IgniteTransactions</code></a> for more information. |
| <h1 class="header">Asynchronous Mode</h1> |
| Cache API supports asynchronous mode via <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang"><code>IgniteAsyncSupport</code></a> functionality. To turn on |
| asynchronous mode invoke <a href="../../../org/apache/ignite/IgniteCache.html#withAsync()"><code>withAsync()</code></a> method. Once asynchronous mode is enabled, |
| all methods with <a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang"><code>@IgniteAsyncSupported</code></a> annotation will be executed |
| asynchronously.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_javax.cache.Cache"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface javax.cache.Cache</h3> |
| <code>javax.cache.Cache.Entry<K,V></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== 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"> </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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#clear()">clear</a></strong>()</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#clear(K)">clear</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code> |
| <div class="block">Clear entry from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#clearAll(java.util.Set)">clearAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">Clear entries from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#close()">close</a></strong>()</code> |
| <div class="block">Closes this cache instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#containsKey(K)">containsKey</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#containsKeys(java.util.Set)">containsKeys</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">Determines if the <code>Cache</code> contains entries for the specified keys.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#destroy()">destroy</a></strong>()</code> |
| <div class="block">Completely deletes the cache with all its data from the system on all cluster nodes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#get(K)">get</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code></td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getAll(java.util.Set)">getAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getAllOutTx(java.util.Set)">getAllOutTx</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">Gets values from cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getAndPut(K, V)">getAndPut</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getAndPutIfAbsent(K, V)">getAndPutIfAbsent</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</code> |
| <div class="block">Stores given key-value pair in cache only if cache had no previous mapping for it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getAndRemove(K)">getAndRemove</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getAndReplace(K, V)">getAndReplace</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</code></td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><C extends javax.cache.configuration.Configuration<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>>> <br>C</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#getConfiguration(java.lang.Class)">getConfiguration</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><C> clazz)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#invoke(K, org.apache.ignite.cache.CacheEntryProcessor, java.lang.Object...)">invoke</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache">CacheEntryProcessor</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... arguments)</code> |
| <div class="block">Invokes an <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> against the <code>Cache.Entry</code> specified by |
| the provided key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#invoke(K, javax.cache.processor.EntryProcessor, java.lang.Object...)">invoke</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| javax.cache.processor.EntryProcessor<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... arguments)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,javax.cache.processor.EntryProcessorResult<T>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#invokeAll(java.util.Map, java.lang.Object...)">invokeAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,? extends javax.cache.processor.EntryProcessor<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T>> map, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,javax.cache.processor.EntryProcessorResult<T>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#invokeAll(java.util.Set, org.apache.ignite.cache.CacheEntryProcessor, java.lang.Object...)">invokeAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys, |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache">CacheEntryProcessor</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code> |
| <div class="block">Invokes an <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> against the set of <code>Cache.Entry</code>s |
| specified by the set of keys.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,javax.cache.processor.EntryProcessorResult<T>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#invokeAll(java.util.Set, javax.cache.processor.EntryProcessor, java.lang.Object...)">invokeAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys, |
| javax.cache.processor.EntryProcessor<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code></td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#isLocalLocked(K, boolean)">isLocalLocked</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| boolean byCurrThread)</code> |
| <div class="block">Checks if specified key is locked.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#loadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)">loadCache</a></strong>(<a href="../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> p, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code> |
| <div class="block">Executes <a href="../../../org/apache/ignite/IgniteCache.html#localLoadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)"><code>localLoadCache(IgniteBiPredicate, Object...)</code></a> on all cache nodes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localClear(K)">localClear</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code> |
| <div class="block">Clear entry from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localClearAll(java.util.Set)">localClearAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">Clear entries from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><javax.cache.Cache.Entry<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localEntries(org.apache.ignite.cache.CachePeekMode...)">localEntries</a></strong>(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</code> |
| <div class="block">Allows for iteration over local cache entries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localEvict(java.util.Collection)">localEvict</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">Attempts to evict all entries associated with keys.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localLoadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)">localLoadCache</a></strong>(<a href="../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> p, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</code> |
| <div class="block">Delegates to <a href="../../../org/apache/ignite/cache/store/CacheStore.html#loadCache(org.apache.ignite.lang.IgniteBiInClosure, java.lang.Object...)"><code>CacheStore.loadCache(IgniteBiInClosure,Object...)</code></a> method |
| to load state from the underlying persistent storage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localPeek(K, org.apache.ignite.cache.CachePeekMode...)">localPeek</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</code> |
| <div class="block">Peeks at in-memory cached value using default optinal peek mode.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localPromote(java.util.Set)">localPromote</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">This method unswaps cache entries by given keys, if any, from swap storage |
| into memory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localSize(org.apache.ignite.cache.CachePeekMode...)">localSize</a></strong>(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</code> |
| <div class="block">Gets the number of all entries cached on this node.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#localSizeLong(org.apache.ignite.cache.CachePeekMode...)">localSizeLong</a></strong>(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</code> |
| <div class="block">Gets the number of all entries cached on this node as a long value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#lock(K)">lock</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code> |
| <div class="block">Creates a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> instance associated with passed key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#lockAll(java.util.Collection)">lockAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code> |
| <div class="block">Creates a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> instance associated with passed keys.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/cache/CacheMetrics.html" title="interface in org.apache.ignite.cache">CacheMetrics</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#metrics()">metrics</a></strong>()</code> |
| <div class="block">Gets snapshot metrics (statistics) for this cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/cache/CacheMetrics.html" title="interface in org.apache.ignite.cache">CacheMetrics</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#metrics(org.apache.ignite.cluster.ClusterGroup)">metrics</a></strong>(<a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a> grp)</code> |
| <div class="block">Gets snapshot metrics for caches in cluster group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/mxbean/CacheMetricsMXBean.html" title="interface in org.apache.ignite.mxbean">CacheMetricsMXBean</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#mxBean()">mxBean</a></strong>()</code> |
| <div class="block">Gets MxBean for this cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#put(K, V)">put</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#putAll(java.util.Map)">putAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> map)</code></td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#putIfAbsent(K, V)">putIfAbsent</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><R> <a href="../../../org/apache/ignite/cache/query/QueryCursor.html" title="interface in org.apache.ignite.cache.query">QueryCursor</a><R></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#query(org.apache.ignite.cache.query.Query)">query</a></strong>(<a href="../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><R> qry)</code> |
| <div class="block">Queries cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/cache/query/QueryMetrics.html" title="interface in org.apache.ignite.cache.query">QueryMetrics</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#queryMetrics()">queryMetrics</a></strong>()</code> |
| <div class="block">Gets query metrics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>javax.cache.Cache.Entry<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#randomEntry()">randomEntry</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#rebalance()">rebalance</a></strong>()</code> |
| <div class="block">This cache node to re-balance its partitions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#remove(K)">remove</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</code></td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#remove(K, V)">remove</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> oldVal)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#removeAll()">removeAll</a></strong>()</code> |
| <div class="block">Removes all of the mappings from this cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#removeAll(java.util.Set)">removeAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#replace(K, V)">replace</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</code></td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#replace(K, V, V)">replace</a></strong>(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> oldVal, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> newVal)</code></td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#size(org.apache.ignite.cache.CachePeekMode...)">size</a></strong>(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</code> |
| <div class="block">Gets the number of all entries cached across all nodes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#sizeLong(org.apache.ignite.cache.CachePeekMode...)">sizeLong</a></strong>(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</code> |
| <div class="block">Gets the number of all entries cached across all nodes as a long value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#withAsync()">withAsync</a></strong>()</code> |
| <div class="block">Gets instance of this component with asynchronous mode enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#withExpiryPolicy(javax.cache.expiry.ExpiryPolicy)">withExpiryPolicy</a></strong>(javax.cache.expiry.ExpiryPolicy plc)</code> |
| <div class="block">Returns cache with the specified expired policy set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><K1,V1> <a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><K1,V1></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#withKeepBinary()">withKeepBinary</a></strong>()</code> |
| <div class="block">Returns cache that will operate with binary objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#withNoRetries()">withNoRetries</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/ignite/IgniteCache.html#withSkipStore()">withSkipStore</a></strong>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_javax.cache.Cache"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.cache.Cache</h3> |
| <code>deregisterCacheEntryListener, getCacheManager, getName, isClosed, iterator, loadAll, registerCacheEntryListener, unwrap</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.ignite.lang.IgniteAsyncSupport"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.ignite.lang.<a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></h3> |
| <code><a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html#future()">future</a>, <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html#isAsync()">isAsync</a></code></li> |
| </ul> |
| </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="withAsync()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAsync</h4> |
| <pre><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> withAsync()</pre> |
| <div class="block">Gets instance of this component with asynchronous mode enabled.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html#withAsync()">withAsync</a></code> in interface <code><a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Instance of this component with asynchronous mode enabled.</dd></dl> |
| </li> |
| </ul> |
| <a name="getConfiguration(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre><C extends javax.cache.configuration.Configuration<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>>> C getConfiguration(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><C> clazz)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>getConfiguration</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="randomEntry()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>randomEntry</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| javax.cache.Cache.Entry<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> randomEntry()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Gets a random entry out of cache. In the worst cache scenario this method |
| has complexity of <pre>O(S * N/64)</pre> where <code>N</code> is the size of internal hash |
| table and <code>S</code> is the number of hash table buckets to sample, which is <code>5</code> |
| by default. However, if the table is pretty dense, with density factor of <code>N/64</code>, |
| which is true for near fully populated caches, this method will generally perform significantly |
| faster with complexity of O(S) where <code>S = 5</code>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Random entry, or <code>null</code> if cache is empty.</dd></dl> |
| </li> |
| </ul> |
| <a name="withExpiryPolicy(javax.cache.expiry.ExpiryPolicy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withExpiryPolicy</h4> |
| <pre><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> withExpiryPolicy(javax.cache.expiry.ExpiryPolicy plc)</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. |
| <p> |
| This method does not modify existing cache instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>plc</code> - Expire policy to use.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cache instance with the specified expiry policy set.</dd></dl> |
| </li> |
| </ul> |
| <a name="withSkipStore()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSkipStore</h4> |
| <pre><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> withSkipStore()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Cache with read-through write-through behavior disabled.</dd></dl> |
| </li> |
| </ul> |
| <a name="withNoRetries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNoRetries</h4> |
| <pre><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> withNoRetries()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Cache with no-retries behavior enabled.</dd></dl> |
| </li> |
| </ul> |
| <a name="withKeepBinary()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withKeepBinary</h4> |
| <pre><K1,V1> <a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite">IgniteCache</a><K1,V1> 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.portable.PortableObject</code> for portable classes</li> |
| <li>All primitives (byte, int, ...) and there boxed versions (Byte, Integer, ...)</li> |
| <li>Arrays of primitives (byte[], int[], ...)</li> |
| <li><a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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 portable) |
| </li> |
| </ul> |
| <p> |
| For example, if you use <a href="http://docs.oracle.com/javase/7/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> |
| IgniteCache<Integer, BinaryObject> prj = cache.withKeepBinary(); |
| |
| // Value is not deserialized and returned in portable 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="strong">Returns:</span></dt><dd>New cache instance for portable objects.</dd></dl> |
| </li> |
| </ul> |
| <a name="loadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadCache</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void loadCache(@Nullable |
| <a href="../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> p, |
| @Nullable |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args) |
| throws javax.cache.CacheException</pre> |
| <div class="block">Executes <a href="../../../org/apache/ignite/IgniteCache.html#localLoadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)"><code>localLoadCache(IgniteBiPredicate, Object...)</code></a> on all cache nodes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - Optional predicate (may be <code>null</code>). If provided, will be used to |
| filter values loaded from storage before they are put into cache.</dd><dd><code>args</code> - Optional user arguments to be passed into |
| <a href="../../../org/apache/ignite/cache/store/CacheStore.html#loadCache(org.apache.ignite.lang.IgniteBiInClosure, java.lang.Object...)"><code>CacheStore.loadCache(IgniteBiInClosure, Object...)</code></a> method.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.cache.CacheException</code> - If loading failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="localLoadCache(org.apache.ignite.lang.IgniteBiPredicate, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localLoadCache</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void localLoadCache(@Nullable |
| <a href="../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> p, |
| @Nullable |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args) |
| throws javax.cache.CacheException</pre> |
| <div class="block">Delegates to <a href="../../../org/apache/ignite/cache/store/CacheStore.html#loadCache(org.apache.ignite.lang.IgniteBiInClosure, java.lang.Object...)"><code>CacheStore.loadCache(IgniteBiInClosure,Object...)</code></a> method |
| to load state from the underlying persistent storage. The loaded values |
| will then be given to the optionally passed in predicate, and, if the predicate returns |
| <code>true</code>, will be stored in cache. If predicate is <code>null</code>, then |
| all loaded values will be stored in cache. |
| <p> |
| Note that this method does not receive keys as a parameter, so it is up to |
| <a href="../../../org/apache/ignite/cache/store/CacheStore.html" title="interface in org.apache.ignite.cache.store"><code>CacheStore</code></a> implementation to provide all the data to be loaded. |
| <p> |
| This method is not transactional and may end up loading a stale value into |
| cache if another thread has updated the value immediately after it has been |
| loaded. It is mostly useful when pre-loading the cache from underlying |
| data store before start, or for read-only caches.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - Optional predicate (may be <code>null</code>). If provided, will be used to |
| filter values to be put into cache.</dd><dd><code>args</code> - Optional user arguments to be passed into |
| <a href="../../../org/apache/ignite/cache/store/CacheStore.html#loadCache(org.apache.ignite.lang.IgniteBiInClosure, java.lang.Object...)"><code>CacheStore.loadCache(IgniteBiInClosure, Object...)</code></a> method.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.cache.CacheException</code> - If loading failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="getAndPutIfAbsent(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a name="getAndPutIfAbsent(K, V)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAndPutIfAbsent</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> getAndPutIfAbsent(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val) |
| throws javax.cache.CacheException</pre> |
| <div class="block">Stores given key-value pair in cache only if cache had no previous mapping for it. If cache |
| previously contained value for the given key, then this value is returned. |
| In case of <a href="../../../org/apache/ignite/cache/CacheMode.html#PARTITIONED"><code>CacheMode.PARTITIONED</code></a> or <a href="../../../org/apache/ignite/cache/CacheMode.html#REPLICATED"><code>CacheMode.REPLICATED</code></a> caches, |
| the value will be loaded from the primary node, which in its turn may load the value |
| from the swap storage, and consecutively, if it's not in swap, |
| from the underlying persistent storage. If value has to be loaded from persistent |
| storage, <code>CacheLoader.load(Object)</code> method will be used. |
| <p> |
| If the returned value is not needed, method <a href="../../../org/apache/ignite/IgniteCache.html#putIfAbsent(K, V)"><code>putIfAbsent(Object, Object)</code></a> should |
| always be used instead of this one to avoid the overhead associated with returning of the |
| previous value. |
| <p> |
| If write-through is enabled, the stored value will be persisted to <a href="../../../org/apache/ignite/cache/store/CacheStore.html" title="interface in org.apache.ignite.cache.store"><code>CacheStore</code></a> |
| via <code>CacheWriter.write(javax.cache.Cache.Entry)</code> method. |
| <h2 class="header">Transactions</h2> |
| This method is transactional and will enlist the entry into ongoing transaction |
| if there is one.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key to store in cache.</dd><dd><code>val</code> - Value to be associated with the given key.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Previously contained value regardless of whether put happened or not (<code>null</code> if there was no |
| previous value).</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If either key or value are <code>null</code>.</dd> |
| <dd><code>javax.cache.CacheException</code> - If put operation failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="lock(java.lang.Object)"> |
| <!-- --> |
| </a><a name="lock(K)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a> lock(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <div class="block">Creates a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> instance associated with passed key. |
| This method does not acquire lock immediately, you have to call appropriate method on returned instance. |
| Returned lock does not support <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true#newCondition()" title="class or interface in java.util.concurrent.locks"><code>Lock.newCondition()</code></a> method, |
| other methods defined in <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> are supported.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key for lock.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>New lock instance associated with passed key.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true#lock()" title="class or interface in java.util.concurrent.locks"><code>Lock.lock()</code></a>, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true#tryLock(long, java.util.concurrent.TimeUnit)" title="class or interface in java.util.concurrent.locks"><code>Lock.tryLock(long, TimeUnit)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="lockAll(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockAll</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a> lockAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <div class="block">Creates a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> instance associated with passed keys. |
| This method does not acquire lock immediately, you have to call appropriate method on returned instance. |
| Returned lock does not support <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true#newCondition()" title="class or interface in java.util.concurrent.locks"><code>Lock.newCondition()</code></a> method, |
| other methods defined in <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> are supported.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Keys for lock.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>New lock instance associated with passed key.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true#lock()" title="class or interface in java.util.concurrent.locks"><code>Lock.lock()</code></a>, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true#tryLock(long, java.util.concurrent.TimeUnit)" title="class or interface in java.util.concurrent.locks"><code>Lock.tryLock(long, TimeUnit)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isLocalLocked(java.lang.Object,boolean)"> |
| <!-- --> |
| </a><a name="isLocalLocked(K, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocalLocked</h4> |
| <pre>boolean isLocalLocked(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| boolean byCurrThread)</pre> |
| <div class="block">Checks if specified key is locked. |
| <p> |
| This is a local in-VM operation and does not involve any network trips |
| or access to persistent storage in any way.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key to check.</dd><dd><code>byCurrThread</code> - If <code>true</code> method will check that current thread owns a lock on this key, other vise |
| will check that any thread on any node owns a lock on this key.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>True</code> if lock is owned by some node.</dd></dl> |
| </li> |
| </ul> |
| <a name="query(org.apache.ignite.cache.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre><R> <a href="../../../org/apache/ignite/cache/query/QueryCursor.html" title="interface in org.apache.ignite.cache.query">QueryCursor</a><R> query(<a href="../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><R> qry)</pre> |
| <div class="block">Queries cache. Accepts any subclass of <a href="../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query"><code>Query</code></a> interface.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>qry</code> - Query.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cursor.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/ignite/cache/query/ScanQuery.html" title="class in org.apache.ignite.cache.query"><code>ScanQuery</code></a>, |
| <a href="../../../org/apache/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query"><code>SqlQuery</code></a>, |
| <a href="../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query"><code>TextQuery</code></a>, |
| <a href="../../../org/apache/ignite/cache/query/SpiQuery.html" title="class in org.apache.ignite.cache.query"><code>SpiQuery</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="localEntries(org.apache.ignite.cache.CachePeekMode...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localEntries</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><javax.cache.Cache.Entry<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>>> localEntries(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes) |
| throws javax.cache.CacheException</pre> |
| <div class="block">Allows for iteration over local cache entries.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>peekModes</code> - Peek modes.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Iterable over local cache entries.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.cache.CacheException</code> - If failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="queryMetrics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryMetrics</h4> |
| <pre><a href="../../../org/apache/ignite/cache/query/QueryMetrics.html" title="interface in org.apache.ignite.cache.query">QueryMetrics</a> queryMetrics()</pre> |
| <div class="block">Gets query metrics.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Metrics.</dd></dl> |
| </li> |
| </ul> |
| <a name="localEvict(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localEvict</h4> |
| <pre>void localEvict(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <div class="block">Attempts to evict all entries associated with keys. Note, |
| that entry will be evicted only if it's not used (not |
| participating in any locks or transactions).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Keys to evict.</dd></dl> |
| </li> |
| </ul> |
| <a name="localPeek(java.lang.Object,org.apache.ignite.cache.CachePeekMode[])"> |
| <!-- --> |
| </a><a name="localPeek(K, org.apache.ignite.cache.CachePeekMode...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localPeek</h4> |
| <pre><a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> localPeek(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</pre> |
| <div class="block">Peeks at in-memory cached value using default optinal peek mode. |
| <p> |
| This method will not load value from any persistent store or from a remote node. |
| <h2 class="header">Transactions</h2> |
| This method does not participate in any transactions.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Entry key.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Peeked value, or <code>null</code> if not found.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If key is <code>null</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="localPromote(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localPromote</h4> |
| <pre>void localPromote(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys) |
| throws javax.cache.CacheException</pre> |
| <div class="block">This method unswaps cache entries by given keys, if any, from swap storage |
| into memory. |
| <h2 class="header">Transactions</h2> |
| This method is not transactional.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Keys to promote entries for.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.cache.CacheException</code> - If promote failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="size(org.apache.ignite.cache.CachePeekMode...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| int size(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes) |
| throws javax.cache.CacheException</pre> |
| <div class="block">Gets the number of all entries cached across all nodes. By default, if <code>peekModes</code> value isn't defined, |
| 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="strong">Parameters:</span></dt><dd><code>peekModes</code> - Optional peek modes. If not provided, then total cache size is returned.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cache size across all nodes.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.cache.CacheException</code></dd></dl> |
| </li> |
| </ul> |
| <a name="sizeLong(org.apache.ignite.cache.CachePeekMode...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sizeLong</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| long sizeLong(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes) |
| throws javax.cache.CacheException</pre> |
| <div class="block">Gets the number of all entries cached across all nodes as a long value. By default, if <code>peekModes</code> value |
| isn't defined, 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="strong">Parameters:</span></dt><dd><code>peekModes</code> - Optional peek modes. If not provided, then total cache size is returned.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cache size across all nodes.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.cache.CacheException</code></dd></dl> |
| </li> |
| </ul> |
| <a name="localSize(org.apache.ignite.cache.CachePeekMode...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localSize</h4> |
| <pre>int localSize(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</pre> |
| <div class="block">Gets the number of all entries cached on this node. By default, if <code>peekModes</code> value isn't defined, |
| only size of primary copies 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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>peekModes</code> - Optional peek modes. If not provided, then total cache size is returned.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cache size on this node.</dd></dl> |
| </li> |
| </ul> |
| <a name="localSizeLong(org.apache.ignite.cache.CachePeekMode...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localSizeLong</h4> |
| <pre>long localSizeLong(<a href="../../../org/apache/ignite/cache/CachePeekMode.html" title="enum in org.apache.ignite.cache">CachePeekMode</a>... peekModes)</pre> |
| <div class="block">Gets the number of all entries cached on this node as a long value. By default, if <code>peekModes</code> value isn't |
| defined, only size of primary copies 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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>peekModes</code> - Optional peek modes. If not provided, then total cache size is returned.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cache size on this node.</dd></dl> |
| </li> |
| </ul> |
| <a name="invokeAll(java.util.Map, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,javax.cache.processor.EntryProcessorResult<T>> invokeAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,? extends javax.cache.processor.EntryProcessor<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T>> map, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - Map containing keys and entry processors to be applied to values.</dd><dd><code>args</code> - Additional arguments to pass to the <code>EntryProcessor</code>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The map of <code>EntryProcessorResult</code>s of the processing per key, |
| if any, defined by the <code>EntryProcessor</code> implementation. No mappings |
| will be returned for <code>EntryProcessor</code>s that return a |
| <code>null</code> value for a key.</dd></dl> |
| </li> |
| </ul> |
| <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/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> get(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>get</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> getAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>getAll</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllOutTx(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllOutTx</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> getAllOutTx(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <div class="block">Gets values from cache. Will bypass started transaction, if any, i.e. will not enlist entries |
| and will not lock any keys if pessimistic transaction is started by thread.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - The keys whose associated values are to be returned.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A map of entries that were found for the given keys.</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean containsKey(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>containsKey</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="containsKeys(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsKeys</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean containsKeys(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <div class="block">Determines if the <code>Cache</code> contains entries for the specified keys.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Key whose presence in this cache is to be tested.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>True</code> if this cache contains a mapping for the specified keys.</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void put(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>put</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> getAndPut(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>getAndPut</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putAll(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void putAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>> map)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>putAll</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean putIfAbsent(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>putIfAbsent</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean remove(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>remove</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean remove(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> oldVal)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>remove</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> getAndRemove(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>getAndRemove</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean replace(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> oldVal, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> newVal)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>replace</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| boolean replace(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>replace</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</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/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> getAndReplace(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a> val)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>getAndReplace</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAll(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void removeAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>removeAll</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void removeAll()</pre> |
| <div class="block">Removes all of the mappings from this cache. |
| <p> |
| The order that the individual entries are removed is undefined. |
| <p> |
| For every mapping that exists the following are called: |
| <ul> |
| <li>any registered <code>CacheEntryRemovedListener</code>s</li> |
| <li>if the cache is a write-through cache, the <code>CacheWriter</code></li> |
| </ul> |
| If the cache is empty, the <code>CacheWriter</code> is not called. |
| <p> |
| This operation is not transactional. It calls broadcast closure that |
| deletes all primary keys from remote nodes. |
| <p> |
| This is potentially an expensive operation as listeners are invoked. |
| Use <a href="../../../org/apache/ignite/IgniteCache.html#clear()"><code>clear()</code></a> to avoid this.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>removeAll</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the cache is <code>Cache.isClosed()</code></dd> |
| <dd><code>javax.cache.CacheException</code> - if there is a problem during the remove</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/ignite/IgniteCache.html#clear()"><code>clear()</code></a>, |
| <code>CacheWriter.deleteAll(java.util.Collection<?>)</code></dd></dl> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void clear()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>clear</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear(java.lang.Object)"> |
| <!-- --> |
| </a><a name="clear(K)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void clear(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <div class="block">Clear entry from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s. Entry is cleared only if it is not currently locked, |
| and is not participating in a transaction.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key to clear.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the cache is <code>Cache.isClosed()</code></dd> |
| <dd><code>javax.cache.CacheException</code> - if there is a problem during the clear</dd></dl> |
| </li> |
| </ul> |
| <a name="clearAll(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| void clearAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <div class="block">Clear entries from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s. Entry is cleared only if it is not currently locked, |
| and is not participating in a transaction.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Keys to clear.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the cache is <code>Cache.isClosed()</code></dd> |
| <dd><code>javax.cache.CacheException</code> - if there is a problem during the clear</dd></dl> |
| </li> |
| </ul> |
| <a name="localClear(java.lang.Object)"> |
| <!-- --> |
| </a><a name="localClear(K)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localClear</h4> |
| <pre>void localClear(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key)</pre> |
| <div class="block">Clear entry from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s. Entry is cleared only if it is not currently locked, |
| and is not participating in a transaction. |
| <p/> |
| Note that this operation is local as it merely clears |
| an entry from local cache, it does not remove entries from |
| remote caches.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key to clear.</dd></dl> |
| </li> |
| </ul> |
| <a name="localClearAll(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localClearAll</h4> |
| <pre>void localClearAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys)</pre> |
| <div class="block">Clear entries from the cache and swap storage, without notifying listeners or |
| <code>CacheWriter</code>s. Entry is cleared only if it is not currently locked, |
| and is not participating in a transaction. |
| <p/> |
| Note that this operation is local as it merely clears |
| an entry from local cache, it does not remove entries from |
| remote caches.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Keys to clear.</dd></dl> |
| </li> |
| </ul> |
| <a name="invoke(java.lang.Object,javax.cache.processor.EntryProcessor,java.lang.Object[])"> |
| <!-- --> |
| </a><a name="invoke(K, javax.cache.processor.EntryProcessor, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <T> T invoke(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| javax.cache.processor.EntryProcessor<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... arguments)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>invoke</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invoke(java.lang.Object,org.apache.ignite.cache.CacheEntryProcessor,java.lang.Object[])"> |
| <!-- --> |
| </a><a name="invoke(K, org.apache.ignite.cache.CacheEntryProcessor, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <T> T invoke(<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a> key, |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache">CacheEntryProcessor</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... arguments)</pre> |
| <div class="block">Invokes an <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> against the <code>Cache.Entry</code> specified by |
| the provided key. If an <code>Cache.Entry</code> does not exist for the specified key, |
| an attempt is made to load it (if a loader is configured) or a surrogate |
| <code>Cache.Entry</code>, consisting of the key with a null value is used instead. |
| This method different |
| <p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to the entry</dd><dd><code>entryProcessor</code> - the <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> to invoke</dd><dd><code>arguments</code> - additional arguments to pass to the |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the result of the processing, if any, defined by the |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> implementation</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if key or <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> is null</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the cache is <code>Cache.isClosed()</code></dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the implementation is configured to perform |
| runtime-type-checking, and the key or value |
| types are incompatible with those that have been |
| configured for the <code>Cache</code></dd> |
| <dd><code>javax.cache.processor.EntryProcessorException</code> - if an exception is thrown by the <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a>, a Caching Implementation |
| must wrap any <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang"><code>Exception</code></a> thrown |
| wrapped in an <code>EntryProcessorException</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="invokeAll(java.util.Set, javax.cache.processor.EntryProcessor, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,javax.cache.processor.EntryProcessorResult<T>> invokeAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys, |
| javax.cache.processor.EntryProcessor<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>invokeAll</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invokeAll(java.util.Set, org.apache.ignite.cache.CacheEntryProcessor, java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeAll</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a> |
| <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,javax.cache.processor.EntryProcessorResult<T>> invokeAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>> keys, |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache">CacheEntryProcessor</a><<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>,T> entryProcessor, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... args)</pre> |
| <div class="block">Invokes an <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> against the set of <code>Cache.Entry</code>s |
| specified by the set of keys. |
| <p> |
| If an <code>Cache.Entry</code> does not exist for the specified key, an attempt is made |
| to load it (if a loader is configured) or a surrogate <code>Cache.Entry</code>, |
| consisting of the key and a value of null is provided. |
| <p> |
| The order that the entries for the keys are processed is undefined. |
| Implementations may choose to process the entries in any order, including |
| concurrently. Furthermore there is no guarantee implementations will |
| use the same <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> instance to process each entry, as |
| the case may be in a non-local cache topology. |
| <p> |
| The result of executing the <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> is returned as a |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of <code>EntryProcessorResult</code>s, one result per key. Should the |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> or Caching implementation throw an exception, the |
| exception is wrapped and re-thrown when a call to |
| <code>EntryProcessorResult.get()</code> is made.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - the set of keys for entries to process</dd><dd><code>entryProcessor</code> - the <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> to invoke</dd><dd><code>args</code> - additional arguments to pass to the |
| <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the map of <code>EntryProcessorResult</code>s of the processing per key, |
| if any, defined by the <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> implementation. No mappings |
| will be returned for <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a>s that return a |
| <code>null</code> value for a key.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if keys or <a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a> are null</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the cache is <code>Cache.isClosed()</code></dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the implementation is configured to perform |
| runtime-type-checking, and the key or value |
| types are incompatible with those that have been |
| configured for the <code>Cache</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/ignite/cache/CacheEntryProcessor.html" title="interface in org.apache.ignite.cache"><code>CacheEntryProcessor</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Closes this cache instance. |
| <p> |
| For local cache equivalent to <a href="../../../org/apache/ignite/IgniteCache.html#destroy()"><code>destroy()</code></a>. |
| For distributed caches, if called on clients, stops client cache, if called on a server node, |
| just closes this cache instance and does not destroy cache data. |
| <p> |
| After cache instance is closed another <a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite"><code>IgniteCache</code></a> instance for the same |
| cache can be created using <a href="../../../org/apache/ignite/Ignite.html#cache(java.lang.String)"><code>Ignite.cache(String)</code></a> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>close</code> in interface <code>javax.cache.Cache<<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">K</a>,<a href="../../../org/apache/ignite/IgniteCache.html" title="type parameter in IgniteCache">V</a>></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>void destroy()</pre> |
| <div class="block">Completely deletes the cache with all its data from the system on all cluster nodes.</div> |
| </li> |
| </ul> |
| <a name="rebalance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rebalance</h4> |
| <pre><a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><?> rebalance()</pre> |
| <div class="block">This cache node to re-balance its partitions. This method is usually used when |
| <a href="../../../org/apache/ignite/configuration/CacheConfiguration.html#getRebalanceDelay()"><code>CacheConfiguration.getRebalanceDelay()</code></a> configuration parameter has non-zero value. |
| When many nodes are started or stopped almost concurrently, it is more efficient to delay |
| rebalancing until the node topology is stable to make sure that no redundant re-partitioning |
| happens. |
| <p> |
| In case of<a href="../../../org/apache/ignite/cache/CacheMode.html#PARTITIONED"><code>CacheMode.PARTITIONED</code></a> caches, for better efficiency user should |
| usually make sure that new nodes get placed on the same place of consistent hash ring as |
| the left nodes, and that nodes are restarted before |
| <a href="../../../org/apache/ignite/configuration/CacheConfiguration.html#getRebalanceDelay()"><code>rebalanceDelay</code></a> expires. To place nodes |
| on the same place in consistent hash ring, use |
| <a href="../../../org/apache/ignite/configuration/IgniteConfiguration.html#setConsistentId(java.io.Serializable)"><code>IgniteConfiguration.setConsistentId(Serializable)</code></a> to make sure that |
| a node maps to the same hash ID if re-started. |
| <p> |
| See <a href="../../../org/apache/ignite/configuration/CacheConfiguration.html#getRebalanceDelay()"><code>CacheConfiguration.getRebalanceDelay()</code></a> for more information on how to configure |
| rebalance re-partition delay. |
| <p></div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Future that will be completed when rebalancing is finished.</dd></dl> |
| </li> |
| </ul> |
| <a name="metrics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metrics</h4> |
| <pre><a href="../../../org/apache/ignite/cache/CacheMetrics.html" title="interface in org.apache.ignite.cache">CacheMetrics</a> metrics()</pre> |
| <div class="block">Gets snapshot metrics (statistics) for this cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Cache metrics.</dd></dl> |
| </li> |
| </ul> |
| <a name="metrics(org.apache.ignite.cluster.ClusterGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metrics</h4> |
| <pre><a href="../../../org/apache/ignite/cache/CacheMetrics.html" title="interface in org.apache.ignite.cache">CacheMetrics</a> metrics(<a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a> grp)</pre> |
| <div class="block">Gets snapshot metrics for caches in cluster group.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>grp</code> - Cluster group.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Cache metrics.</dd></dl> |
| </li> |
| </ul> |
| <a name="mxBean()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>mxBean</h4> |
| <pre><a href="../../../org/apache/ignite/mxbean/CacheMetricsMXBean.html" title="interface in org.apache.ignite.mxbean">CacheMetricsMXBean</a> mxBean()</pre> |
| <div class="block">Gets MxBean for this cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>MxBean.</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/IgniteCache.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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/ignite/IgniteBinary.html" title="interface in org.apache.ignite"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/ignite/IgniteCache.html" target="_top">Frames</a></li> |
| <li><a href="IgniteCache.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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://apache.org/projects/ignite.html"><nobr>2015 Copyright © 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> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> </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 Fabric</b> </td> <td>: ver. <strong>1.5.0-b1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: December 1 2015 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
