Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/index-all.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/index-all.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/index-all.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/index-all.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,1823 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Fri Mar 28 13:34:26 EST 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Index (JSR107 API and SPI 1.0.0 API)</title> +<meta name="date" content="2014-03-28"> +<link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Index (JSR107 API and SPI 1.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="./overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="./overview-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="#_A_">A</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_J_">J</a> <a href="#_K_">K</a> <a href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> <a href="#_Z_">Z</a> <a name="_A_"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><a href="./javax/cache/expiry/AccessedExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">AccessedExpiryPolicy</span></a> - Class in <a href="./javax/cache/expiry/package-summary.html">javax.cache.expiry</a></dt> +<dd> +<div class="block">An <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a> that defines the expiry <a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> + of a Cache Entry based on the last time it was accessed.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/AccessedExpiryPolicy.html#AccessedExpiryPolicy(javax.cache.expiry.Duration)">AccessedExpiryPolicy(Duration)</a></span> - Constructor for class javax.cache.expiry.<a href="./javax/cache/expiry/AccessedExpiryPolicy.html" title="class in javax.cache.expiry">AccessedExpiryPolicy</a></dt> +<dd> +<div class="block">Constructs an <a href="./javax/cache/expiry/AccessedExpiryPolicy.html" title="class in javax.cache.expiry"><code>AccessedExpiryPolicy</code></a> <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration)">addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K, V>)</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dd> +<div class="block">Add a configuration for a <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> +</dd> +</dl> +<a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><a href="./javax/cache/Cache.html" title="interface in javax.cache"><span class="strong">Cache</span></a><<a href="./javax/cache/Cache.html" title="type parameter in Cache">K</a>,<a href="./javax/cache/Cache.html" title="type parameter in Cache">V</a>> - Interface in <a href="./javax/cache/package-summary.html">javax.cache</a></dt> +<dd> +<div class="block">A <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> is a Map-like data structure that provides temporary storage + of application data.</div> +</dd> +<dt><a href="./javax/cache/Cache.Entry.html" title="interface in javax.cache"><span class="strong">Cache.Entry</span></a><<a href="./javax/cache/Cache.Entry.html" title="type parameter in Cache.Entry">K</a>,<a href="./javax/cache/Cache.Entry.html" title="type parameter in Cache.Entry">V</a>> - Interface in <a href="./javax/cache/package-summary.html">javax.cache</a></dt> +<dd> +<div class="block">A cache entry (key-value pair).</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheDefaults.html" title="annotation in javax.cache.annotation"><span class="strong">CacheDefaults</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Allows the configuration of defaults for <a href="./javax/cache/annotation/CacheResult.html" title="annotation in javax.cache.annotation"><code>CacheResult</code></a>, <a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a>, + <a href="./javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><code>CacheRemove</code></a>, and <a href="./javax/cache/annotation/CacheRemoveAll.html" title="annotation in javax.cache.annotation"><code>CacheRemoveAll</code></a> at the class level.</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryCreatedListener.html" title="interface in javax.cache.event"><span class="strong">CacheEntryCreatedListener</span></a><<a href="./javax/cache/event/CacheEntryCreatedListener.html" title="type parameter in CacheEntryCreatedListener">K</a>,<a href="./javax/cache/event/CacheEntryCreatedListener.html" title="type parameter in CacheEntryCreatedListener">V</a>> - Interface in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">Invoked after a cache entry is created, or if a batch call is made, after the + entries are created.</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryEvent.html" title="class in javax.cache.event"><span class="strong">CacheEntryEvent</span></a><<a href="./javax/cache/event/CacheEntryEvent.html" title="type parameter in CacheEntryEvent">K</a>,<a href="./javax/cache/event/CacheEntryEvent.html" title="type parameter in CacheEntryEvent">V</a>> - Class in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">A Cache entry event base class.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/event/CacheEntryEvent.html#CacheEntryEvent(javax.cache.Cache, javax.cache.event.EventType)">CacheEntryEvent(Cache, EventType)</a></span> - Constructor for class javax.cache.event.<a href="./javax/cache/event/CacheEntryEvent.html" title="class in javax.cache.event">CacheEntryEvent</a></dt> +<dd> +<div class="block">Constructs a cache entry event from a given cache as source</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event"><span class="strong">CacheEntryEventFilter</span></a><<a href="./javax/cache/event/CacheEntryEventFilter.html" title="type parameter in CacheEntryEventFilter">K</a>,<a href="./javax/cache/event/CacheEntryEventFilter.html" title="type parameter in CacheEntryEventFilter">V</a>> - Interface in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">A function that may be used to check <a href="./javax/cache/event/CacheEntryEvent.html" title="class in javax.cache.event"><code>CacheEntryEvent</code></a>s prior to being + dispatched to <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>s.</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryExpiredListener.html" title="interface in javax.cache.event"><span class="strong">CacheEntryExpiredListener</span></a><<a href="./javax/cache/event/CacheEntryExpiredListener.html" title="type parameter in CacheEntryExpiredListener">K</a>,<a href="./javax/cache/event/CacheEntryExpiredListener.html" title="type parameter in CacheEntryExpiredListener">V</a>> - Interface in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">Invoked if a cache entry or entries are evicted due to expiration.</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><span class="strong">CacheEntryListener</span></a><<a href="./javax/cache/event/CacheEntryListener.html" title="type parameter in CacheEntryListener">K</a>,<a href="./javax/cache/event/CacheEntryListener.html" title="type parameter in CacheEntryListener">V</a>> - Interface in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">A tagging interface for cache entry listeners.</div> +</dd> +<dt><a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="interface in javax.cache.configuration"><span class="strong">CacheEntryListenerConfiguration</span></a><<a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">K</a>,<a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="type parameter in CacheEntryListenerConfiguration">V</a>> - Interface in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">Defines the configuration requirements for a + <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a> and a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for its + creation.</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryListenerException.html" title="class in javax.cache.event"><span class="strong">CacheEntryListenerException</span></a> - Exception in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">An exception to indicate a problem has occurred with a listener.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/event/CacheEntryListenerException.html#CacheEntryListenerException()">CacheEntryListenerException()</a></span> - Constructor for exception javax.cache.event.<a href="./javax/cache/event/CacheEntryListenerException.html" title="class in javax.cache.event">CacheEntryListenerException</a></dt> +<dd> +<div class="block">Constructs a new CacheEntryListenerException.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/event/CacheEntryListenerException.html#CacheEntryListenerException(java.lang.String)">CacheEntryListenerException(String)</a></span> - Constructor for exception javax.cache.event.<a href="./javax/cache/event/CacheEntryListenerException.html" title="class in javax.cache.event">CacheEntryListenerException</a></dt> +<dd> +<div class="block">Constructs a new CacheEntryListenerException with a message string.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/event/CacheEntryListenerException.html#CacheEntryListenerException(java.lang.String, java.lang.Throwable)">CacheEntryListenerException(String, Throwable)</a></span> - Constructor for exception javax.cache.event.<a href="./javax/cache/event/CacheEntryListenerException.html" title="class in javax.cache.event">CacheEntryListenerException</a></dt> +<dd> +<div class="block">Constructs a CacheEntryListenerException with a message string, and + a base exception</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/event/CacheEntryListenerException.html#CacheEntryListenerException(java.lang.Throwable)">CacheEntryListenerException(Throwable)</a></span> - Constructor for exception javax.cache.event.<a href="./javax/cache/event/CacheEntryListenerException.html" title="class in javax.cache.event">CacheEntryListenerException</a></dt> +<dd> +<div class="block">Constructs a new CacheEntryListenerException with the specified cause and a + detail message of <tt>(cause==null ? null : cause.toString())</tt> + (that typically contains the class and detail message of + <tt>cause</tt>).</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryRemovedListener.html" title="interface in javax.cache.event"><span class="strong">CacheEntryRemovedListener</span></a><<a href="./javax/cache/event/CacheEntryRemovedListener.html" title="type parameter in CacheEntryRemovedListener">K</a>,<a href="./javax/cache/event/CacheEntryRemovedListener.html" title="type parameter in CacheEntryRemovedListener">V</a>> - Interface in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">Invoked if a cache entry is removed, or if a batch call is made, after the + entries are removed.</div> +</dd> +<dt><a href="./javax/cache/event/CacheEntryUpdatedListener.html" title="interface in javax.cache.event"><span class="strong">CacheEntryUpdatedListener</span></a><<a href="./javax/cache/event/CacheEntryUpdatedListener.html" title="type parameter in CacheEntryUpdatedListener">K</a>,<a href="./javax/cache/event/CacheEntryUpdatedListener.html" title="type parameter in CacheEntryUpdatedListener">V</a>> - Interface in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">Invoked if an existing cache entry is updated, or if a batch call is made, + after the entries are updated.</div> +</dd> +<dt><a href="./javax/cache/CacheException.html" title="class in javax.cache"><span class="strong">CacheException</span></a> - Exception in <a href="./javax/cache/package-summary.html">javax.cache</a></dt> +<dd> +<div class="block">Thrown to indicate an exception has occurred in the Cache.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheException.html#CacheException()">CacheException()</a></span> - Constructor for exception javax.cache.<a href="./javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></dt> +<dd> +<div class="block">Constructs a new CacheException.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheException.html#CacheException(java.lang.String)">CacheException(String)</a></span> - Constructor for exception javax.cache.<a href="./javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></dt> +<dd> +<div class="block">Constructs a new CacheException with a message string.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheException.html#CacheException(java.lang.String, java.lang.Throwable)">CacheException(String, Throwable)</a></span> - Constructor for exception javax.cache.<a href="./javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></dt> +<dd> +<div class="block">Constructs a CacheException with a message string, and + a base exception</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheException.html#CacheException(java.lang.Throwable)">CacheException(Throwable)</a></span> - Constructor for exception javax.cache.<a href="./javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></dt> +<dd> +<div class="block">Constructs a new CacheException with the specified cause and a + detail message of <tt>(cause==null ? null : cause.toString())</tt> + (that typically contains the class and detail message of + <tt>cause</tt>).</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">CacheInvocationContext</span></a><<a href="./javax/cache/annotation/CacheInvocationContext.html" title="type parameter in CacheInvocationContext">A</a> extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Runtime information about an intercepted method invocation for a method + annotated with <a href="./javax/cache/annotation/CacheResult.html" title="annotation in javax.cache.annotation"><code>CacheResult</code></a>, <a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a>, <a href="./javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><code>CacheRemove</code></a>, + or <a href="./javax/cache/annotation/CacheRemoveAll.html" title="annotation in javax.cache.annotation"><code>CacheRemoveAll</code></a></div> +</dd> +<dt><a href="./javax/cache/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation"><span class="strong">CacheInvocationParameter</span></a> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">A parameter to an intercepted method invocation.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><span class="strong">CacheKey</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Marks a method argument as part of the cache key.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><span class="strong">CacheKeyGenerator</span></a> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Generates a <a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> based on + a <a href="./javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><code>CacheKeyInvocationContext</code></a>.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">CacheKeyInvocationContext</span></a><<a href="./javax/cache/annotation/CacheKeyInvocationContext.html" title="type parameter in CacheKeyInvocationContext">A</a> extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Runtime information about an intercepted method invocation for a method + annotated with <a href="./javax/cache/annotation/CacheResult.html" title="annotation in javax.cache.annotation"><code>CacheResult</code></a>, <a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a>, or + <a href="./javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><code>CacheRemove</code></a>.</div> +</dd> +<dt><a href="./javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><span class="strong">CacheLoader</span></a><<a href="./javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">K</a>,<a href="./javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">V</a>> - Interface in <a href="./javax/cache/integration/package-summary.html">javax.cache.integration</a></dt> +<dd> +<div class="block">Used when a cache is read-through or when loading data into a cache via the + <a href="./javax/cache/Cache.html#loadAll(java.util.Set, boolean, javax.cache.integration.CompletionListener)"><code>Cache.loadAll(java.util.Set, boolean, + CompletionListener)</code></a> method.</div> +</dd> +<dt><a href="./javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration"><span class="strong">CacheLoaderException</span></a> - Exception in <a href="./javax/cache/integration/package-summary.html">javax.cache.integration</a></dt> +<dd> +<div class="block">An exception to indicate a problem has occurred executing a <a href="./javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheLoaderException.html#CacheLoaderException()">CacheLoaderException()</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></dt> +<dd> +<div class="block">Constructs a new CacheLoaderException.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheLoaderException.html#CacheLoaderException(java.lang.String)">CacheLoaderException(String)</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></dt> +<dd> +<div class="block">Constructs a new CacheLoaderException with a message string.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheLoaderException.html#CacheLoaderException(java.lang.String, java.lang.Throwable)">CacheLoaderException(String, Throwable)</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></dt> +<dd> +<div class="block">Constructs a CacheLoaderException with a message string, and + a base exception</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheLoaderException.html#CacheLoaderException(java.lang.Throwable)">CacheLoaderException(Throwable)</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></dt> +<dd> +<div class="block">Constructs a new CacheLoaderException with the specified cause and a + detail message of <tt>(cause==null ? null : cause.toString())</tt> + (that typically contains the class and detail message of + <tt>cause</tt>).</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#cacheLoaderFactory">cacheLoaderFactory</a></span> - Variable in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dd> +<div class="block">The <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="./javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a>.</div> +</dd> +<dt><a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><span class="strong">CacheManager</span></a> - Interface in <a href="./javax/cache/package-summary.html">javax.cache</a></dt> +<dd> +<div class="block">A <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> provides a means of establishing, configuring, + acquiring, closing and destroying uniquely named <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>s.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation"><span class="strong">CacheMethodDetails</span></a><<a href="./javax/cache/annotation/CacheMethodDetails.html" title="type parameter in CacheMethodDetails">A</a> extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true"; title="class or interface in java.lang.annotation">Annotation</a>> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Static information about a method annotated with one of: + <a href="./javax/cache/annotation/CacheResult.html" title="annotation in javax.cache.annotation"><code>CacheResult</code></a>, <a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a>, <a href="./javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><code>CacheRemove</code></a>, or <a href="./javax/cache/annotation/CacheRemoveAll.html" title="annotation in javax.cache.annotation"><code>CacheRemoveAll</code></a></div> +</dd> +<dt><a href="./javax/cache/management/CacheMXBean.html" title="interface in javax.cache.management"><span class="strong">CacheMXBean</span></a> - Interface in <a href="./javax/cache/management/package-summary.html">javax.cache.management</a></dt> +<dd> +<div class="block">A management bean for cache.</div> +</dd> +<dt><a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><span class="strong">CachePut</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">When a method annotated with <a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a> is invoked a <a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> will be generated and <a href="./javax/cache/Cache.html#put(K, V)"><code>Cache.put(Object, + Object)</code></a> will be invoked on the specified cache storing the value marked with + <a href="./javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a>.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><span class="strong">CacheRemove</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">When a method annotated with <a href="./javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><code>CacheRemove</code></a> is invoked a <a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> will be generated and <a href="./javax/cache/Cache.html#remove(K)"><code>Cache.remove(Object)</code></a> will be + invoked on the specified cache.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheRemoveAll.html" title="annotation in javax.cache.annotation"><span class="strong">CacheRemoveAll</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">When a method annotated with <a href="./javax/cache/annotation/CacheRemoveAll.html" title="annotation in javax.cache.annotation"><code>CacheRemoveAll</code></a> is invoked all elements in + the specified cache will be removed via the + <a href="./javax/cache/Cache.html#removeAll()"><code>Cache.removeAll()</code></a> method</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheResolver.html" title="interface in javax.cache.annotation"><span class="strong">CacheResolver</span></a> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Determines the <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> to use for an intercepted method invocation.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheResolverFactory.html" title="interface in javax.cache.annotation"><span class="strong">CacheResolverFactory</span></a> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Determines the <a href="./javax/cache/annotation/CacheResolver.html" title="interface in javax.cache.annotation"><code>CacheResolver</code></a> to use for an annotated method.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheResult.html" title="annotation in javax.cache.annotation"><span class="strong">CacheResult</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">When a method annotated with <a href="./javax/cache/annotation/CacheResult.html" title="annotation in javax.cache.annotation"><code>CacheResult</code></a> is invoked a + <a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> will be generated and <a href="./javax/cache/Cache.html#get(K)"><code>Cache.get(Object)</code></a> is + called before the annotated method actually executes.</div> +</dd> +<dt><a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management"><span class="strong">CacheStatisticsMXBean</span></a> - Interface in <a href="./javax/cache/management/package-summary.html">javax.cache.management</a></dt> +<dd> +<div class="block">Cache statistics.</div> +</dd> +<dt><a href="./javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><span class="strong">CacheValue</span></a> - Annotation Type in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">Marks the parameter to be cached for a method annotated with <a href="./javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a>.</div> +</dd> +<dt><a href="./javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><span class="strong">CacheWriter</span></a><<a href="./javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="./javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">V</a>> - Interface in <a href="./javax/cache/integration/package-summary.html">javax.cache.integration</a></dt> +<dd> +<div class="block">A CacheWriter is used for write-through to an external resource.</div> +</dd> +<dt><a href="./javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration"><span class="strong">CacheWriterException</span></a> - Exception in <a href="./javax/cache/integration/package-summary.html">javax.cache.integration</a></dt> +<dd> +<div class="block">An exception to indicate a problem has occurred executing a <a href="./javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheWriterException.html#CacheWriterException()">CacheWriterException()</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></dt> +<dd> +<div class="block">Constructs a new CacheWriterException.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheWriterException.html#CacheWriterException(java.lang.String)">CacheWriterException(String)</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></dt> +<dd> +<div class="block">Constructs a new CacheWriterException with a message string.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheWriterException.html#CacheWriterException(java.lang.String, java.lang.Throwable)">CacheWriterException(String, Throwable)</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></dt> +<dd> +<div class="block">Constructs a CacheWriterException with a message string, and + a base exception</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheWriterException.html#CacheWriterException(java.lang.Throwable)">CacheWriterException(Throwable)</a></span> - Constructor for exception javax.cache.integration.<a href="./javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></dt> +<dd> +<div class="block">Constructs a new CacheWriterException with the specified cause and a + detail message of <tt>(cause==null ? null : cause.toString())</tt> + (that typically contains the class and detail message of + <tt>cause</tt>).</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#cacheWriterFactory">cacheWriterFactory</a></span> - Variable in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dd> +<div class="block">The <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="./javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a>.</div> +</dd> +<dt><a href="./javax/cache/Caching.html" title="class in javax.cache"><span class="strong">Caching</span></a> - Class in <a href="./javax/cache/package-summary.html">javax.cache</a></dt> +<dd> +<div class="block">The <a href="./javax/cache/Caching.html" title="class in javax.cache"><code>Caching</code></a> class provides a convenient means for an application to + acquire an appropriate <a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> implementation.</div> +</dd> +<dt><a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><span class="strong">CachingProvider</span></a> - Interface in <a href="./javax/cache/spi/package-summary.html">javax.cache.spi</a></dt> +<dd> +<div class="block">Provides mechanisms to create, request and later manage the life-cycle of + configured <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a>s, identified by <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>s and scoped by + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang"><code>ClassLoader</code></a>s.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CompletionListenerFuture.html#cancel(boolean)">cancel(boolean)</a></span> - Method in class javax.cache.integration.<a href="./javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration">CompletionListenerFuture</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#clear()">clear()</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Clears the contents of the cache, without notifying listeners or + <a href="./javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a>s.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#clear()">clear()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">Clears the statistics counters to 0 for the associated Cache.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#close()">close()</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Closing a <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> signals to the <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> that produced or + owns the <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> that it should no longer be managed.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#close()">close()</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Closes the <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/spi/CachingProvider.html#close()">close()</a></span> - Method in interface javax.cache.spi.<a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi">CachingProvider</a></dt> +<dd> +<div class="block">Closes all of the <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources + created and maintained by the <a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> across all + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang"><code>ClassLoader</code></a>s.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/spi/CachingProvider.html#close(java.lang.ClassLoader)">close(ClassLoader)</a></span> - Method in interface javax.cache.spi.<a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi">CachingProvider</a></dt> +<dd> +<div class="block">Closes all <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources created + by the <a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> using the specified <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang"><code>ClassLoader</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/spi/CachingProvider.html#close(java.net.URI, java.lang.ClassLoader)">close(URI, ClassLoader)</a></span> - Method in interface javax.cache.spi.<a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi">CachingProvider</a></dt> +<dd> +<div class="block">Closes all <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources created + by the <a href="./javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> for the specified <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a> and + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang"><code>ClassLoader</code></a>.</div> +</dd> +<dt><a href="./javax/cache/configuration/CompleteConfiguration.html" title="interface in javax.cache.configuration"><span class="strong">CompleteConfiguration</span></a><<a href="./javax/cache/configuration/CompleteConfiguration.html" title="type parameter in CompleteConfiguration">K</a>,<a href="./javax/cache/configuration/CompleteConfiguration.html" title="type parameter in CompleteConfiguration">V</a>> - Interface in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">A read-only representation of the complete JCache <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> + configuration.</div> +</dd> +<dt><a href="./javax/cache/integration/CompletionListener.html" title="interface in javax.cache.integration"><span class="strong">CompletionListener</span></a> - Interface in <a href="./javax/cache/integration/package-summary.html">javax.cache.integration</a></dt> +<dd> +<div class="block">A CompletionListener is implemented by an application when it needs to be + notified of the completion of some Cache operation.</div> +</dd> +<dt><a href="./javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration"><span class="strong">CompletionListenerFuture</span></a> - Class in <a href="./javax/cache/integration/package-summary.html">javax.cache.integration</a></dt> +<dd> +<div class="block">A CompletionListenerFuture is a CompletionListener implementation that + supports being used as a Future.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CompletionListenerFuture.html#CompletionListenerFuture()">CompletionListenerFuture()</a></span> - Constructor for class javax.cache.integration.<a href="./javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration">CompletionListenerFuture</a></dt> +<dd> +<div class="block">Constructs a CompletionListenerFuture.</div> +</dd> +<dt><a href="./javax/cache/configuration/Configuration.html" title="interface in javax.cache.configuration"><span class="strong">Configuration</span></a><<a href="./javax/cache/configuration/Configuration.html" title="type parameter in Configuration">K</a>,<a href="./javax/cache/configuration/Configuration.html" title="type parameter in Configuration">V</a>> - Interface in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">A basic read-only representation of a <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> configuration.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#containsKey(K)">containsKey(K)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Determines if the <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> contains an entry for the specified key.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/Factory.html#create()">create()</a></span> - Method in interface javax.cache.configuration.<a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a></dt> +<dd> +<div class="block">Constructs and returns a fully configured instance of T.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html#create()">create()</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration">FactoryBuilder.ClassFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html#create()">create()</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="class in javax.cache.configuration">FactoryBuilder.SingletonFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#createCache(java.lang.String, C)">createCache(String, C)</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Creates a named <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> at runtime.</div> +</dd> +<dt><a href="./javax/cache/expiry/CreatedExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">CreatedExpiryPolicy</span></a> - Class in <a href="./javax/cache/expiry/package-summary.html">javax.cache.expiry</a></dt> +<dd> +<div class="block">An <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a> that defines the expiry <a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> + of a Cache Entry based on when it was created.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/CreatedExpiryPolicy.html#CreatedExpiryPolicy(javax.cache.expiry.Duration)">CreatedExpiryPolicy(Duration)</a></span> - Constructor for class javax.cache.expiry.<a href="./javax/cache/expiry/CreatedExpiryPolicy.html" title="class in javax.cache.expiry">CreatedExpiryPolicy</a></dt> +<dd> +<div class="block">Constructs an <a href="./javax/cache/expiry/CreatedExpiryPolicy.html" title="class in javax.cache.expiry"><code>CreatedExpiryPolicy</code></a> <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +</dl> +<a name="_D_"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><span class="strong"><a href="./javax/cache/integration/CacheWriter.html#delete(java.lang.Object)">delete(Object)</a></span> - Method in interface javax.cache.integration.<a href="./javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration">CacheWriter</a></dt> +<dd> +<div class="block">Delete the cache entry from the external resource.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CacheWriter.html#deleteAll(java.util.Collection)">deleteAll(Collection<?>)</a></span> - Method in interface javax.cache.integration.<a href="./javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration">CacheWriter</a></dt> +<dd> +<div class="block">Remove data and keys from the external resource for the given collection of + keys, if present.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration)">deregisterCacheEntryListener(CacheEntryListenerConfiguration<K, V>)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Deregisters a listener, using the + <a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="interface in javax.cache.configuration"><code>CacheEntryListenerConfiguration</code></a> that was used to register it.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#destroyCache(java.lang.String)">destroyCache(String)</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Destroys a specifically named and managed <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>.</div> +</dd> +<dt><a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><span class="strong">Duration</span></a> - Class in <a href="./javax/cache/expiry/package-summary.html">javax.cache.expiry</a></dt> +<dd> +<div class="block">A <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io"><code>Serializable</code></a> duration of time.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#Duration()">Duration()</a></span> - Constructor for class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dd> +<div class="block">Constructs a Duration (that by default is Eternal).</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#Duration(java.util.concurrent.TimeUnit, long)">Duration(TimeUnit, long)</a></span> - Constructor for class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dd> +<div class="block">Constructs a duration.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#Duration(long, long)">Duration(long, long)</a></span> - Constructor for class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dd> +<div class="block">Constructs a <a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry"><code>Duration</code></a> based on the duration between two + specified points in time (since the Epoc), measured in milliseconds.</div> +</dd> +</dl> +<a name="_E_"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#enableManagement(java.lang.String, boolean)">enableManagement(String, boolean)</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Controls whether management is enabled.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#enableStatistics(java.lang.String, boolean)">enableStatistics(String, boolean)</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Enables or disables statistics gathering for a managed <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> at + runtime.</div> +</dd> +<dt><a href="./javax/cache/processor/EntryProcessor.html" title="interface in javax.cache.processor"><span class="strong">EntryProcessor</span></a><<a href="./javax/cache/processor/EntryProcessor.html" title="type parameter in EntryProcessor">K</a>,<a href="./javax/cache/processor/EntryProcessor.html" title="type parameter in EntryProcessor">V</a>,<a href="./javax/cache/processor/EntryProcessor.html" title="type parameter in EntryProcessor">T</a>> - Interface in <a href="./javax/cache/processor/package-summary.html">javax.cache.processor</a></dt> +<dd> +<div class="block">An invocable function that allows applications to perform compound operations + on a <a href="./javax/cache/Cache.Entry.html" title="interface in javax.cache"><code>Cache.Entry</code></a> atomically, according the defined + consistency of a <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>.</div> +</dd> +<dt><a href="./javax/cache/processor/EntryProcessorException.html" title="class in javax.cache.processor"><span class="strong">EntryProcessorException</span></a> - Exception in <a href="./javax/cache/processor/package-summary.html">javax.cache.processor</a></dt> +<dd> +<div class="block">An exception to indicate a problem occurred attempting to execute an + <a href="./javax/cache/processor/EntryProcessor.html" title="interface in javax.cache.processor"><code>EntryProcessor</code></a> against an entry.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/processor/EntryProcessorException.html#EntryProcessorException()">EntryProcessorException()</a></span> - Constructor for exception javax.cache.processor.<a href="./javax/cache/processor/EntryProcessorException.html" title="class in javax.cache.processor">EntryProcessorException</a></dt> +<dd> +<div class="block">Constructs a new CacheLoaderException.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/processor/EntryProcessorException.html#EntryProcessorException(java.lang.String)">EntryProcessorException(String)</a></span> - Constructor for exception javax.cache.processor.<a href="./javax/cache/processor/EntryProcessorException.html" title="class in javax.cache.processor">EntryProcessorException</a></dt> +<dd> +<div class="block">Constructs a new CacheLoaderException with a message string.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/processor/EntryProcessorException.html#EntryProcessorException(java.lang.String, java.lang.Throwable)">EntryProcessorException(String, Throwable)</a></span> - Constructor for exception javax.cache.processor.<a href="./javax/cache/processor/EntryProcessorException.html" title="class in javax.cache.processor">EntryProcessorException</a></dt> +<dd> +<div class="block">Constructs a CacheLoaderException with a message string, and + a base exception</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/processor/EntryProcessorException.html#EntryProcessorException(java.lang.Throwable)">EntryProcessorException(Throwable)</a></span> - Constructor for exception javax.cache.processor.<a href="./javax/cache/processor/EntryProcessorException.html" title="class in javax.cache.processor">EntryProcessorException</a></dt> +<dd> +<div class="block">Constructs a new CacheLoaderException with the specified cause and a + detail message of <tt>(cause==null ? null : cause.toString())</tt> + (that typically contains the class and detail message of + <tt>cause</tt>).</div> +</dd> +<dt><a href="./javax/cache/processor/EntryProcessorResult.html" title="interface in javax.cache.processor"><span class="strong">EntryProcessorResult</span></a><<a href="./javax/cache/processor/EntryProcessorResult.html" title="type parameter in EntryProcessorResult">T</a>> - Interface in <a href="./javax/cache/processor/package-summary.html">javax.cache.processor</a></dt> +<dd> +<div class="block">A mechanism to represent and obtain the result of processing + a <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> entry using an <a href="./javax/cache/processor/EntryProcessor.html" title="interface in javax.cache.processor"><code>EntryProcessor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/annotation/GeneratedCacheKey.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in interface javax.cache.annotation.<a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation">GeneratedCacheKey</a></dt> +<dd> +<div class="block">Compare this <a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> with another.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration">FactoryBuilder.ClassFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="class in javax.cache.configuration">FactoryBuilder.SingletonFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableCacheEntryListenerConfiguration.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableCacheEntryListenerConfiguration.html" title="class in javax.cache.configuration">MutableCacheEntryListenerConfiguration</a></dt> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/AccessedExpiryPolicy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/AccessedExpiryPolicy.html" title="class in javax.cache.expiry">AccessedExpiryPolicy</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/CreatedExpiryPolicy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/CreatedExpiryPolicy.html" title="class in javax.cache.expiry">CreatedExpiryPolicy</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/EternalExpiryPolicy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry">EternalExpiryPolicy</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/ModifiedExpiryPolicy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/ModifiedExpiryPolicy.html" title="class in javax.cache.expiry">ModifiedExpiryPolicy</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/TouchedExpiryPolicy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/TouchedExpiryPolicy.html" title="class in javax.cache.expiry">TouchedExpiryPolicy</a></dt> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#ETERNAL">ETERNAL</a></span> - Static variable in class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dd> +<div class="block">ETERNAL (forever).</div> +</dd> +<dt><a href="./javax/cache/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry"><span class="strong">EternalExpiryPolicy</span></a> - Class in <a href="./javax/cache/expiry/package-summary.html">javax.cache.expiry</a></dt> +<dd> +<div class="block">An eternal <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a> specifies that Cache Entries + won't expire.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/EternalExpiryPolicy.html#EternalExpiryPolicy()">EternalExpiryPolicy()</a></span> - Constructor for class javax.cache.expiry.<a href="./javax/cache/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry">EternalExpiryPolicy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/event/CacheEntryEventFilter.html#evaluate(javax.cache.event.CacheEntryEvent)">evaluate(CacheEntryEvent<? extends K, ? extends V>)</a></span> - Method in interface javax.cache.event.<a href="./javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event">CacheEntryEventFilter</a></dt> +<dd> +<div class="block">Evaluates specified <a href="./javax/cache/event/CacheEntryEvent.html" title="class in javax.cache.event"><code>CacheEntryEvent</code></a>.</div> +</dd> +<dt><a href="./javax/cache/event/EventType.html" title="enum in javax.cache.event"><span class="strong">EventType</span></a> - Enum in <a href="./javax/cache/event/package-summary.html">javax.cache.event</a></dt> +<dd> +<div class="block">The type of event received by the listener.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/processor/MutableEntry.html#exists()">exists()</a></span> - Method in interface javax.cache.processor.<a href="./javax/cache/processor/MutableEntry.html" title="interface in javax.cache.processor">MutableEntry</a></dt> +<dd> +<div class="block">Checks for the existence of the entry in the cache</div> +</dd> +<dt><a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><span class="strong">ExpiryPolicy</span></a> - Interface in <a href="./javax/cache/expiry/package-summary.html">javax.cache.expiry</a></dt> +<dd> +<div class="block">Defines functions to determine when cache entries will expire based on + creation, access and modification operations.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#expiryPolicyFactory">expiryPolicyFactory</a></span> - Variable in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dd> +<div class="block">The <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +</dl> +<a name="_F_"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><span class="strong">Factory</span></a><<a href="./javax/cache/configuration/Factory.html" title="type parameter in Factory">T</a>> - Interface in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">Constructs and returns a fully configured instance of a specific factory type.</div> +</dd> +<dt><a href="./javax/cache/configuration/FactoryBuilder.html" title="class in javax.cache.configuration"><span class="strong">FactoryBuilder</span></a> - Class in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">A convenience class that defines generically typed static methods to aid in + the building of <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> instances.</div> +</dd> +<dt><a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration"><span class="strong">FactoryBuilder.ClassFactory</span></a><<a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="type parameter in FactoryBuilder.ClassFactory">T</a>> - Class in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">A <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that instantiates a specific Class.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html#FactoryBuilder.ClassFactory(java.lang.Class)">FactoryBuilder.ClassFactory(Class<T>)</a></span> - Constructor for class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration">FactoryBuilder.ClassFactory</a></dt> +<dd> +<div class="block">Constructor for the <a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration"><code>FactoryBuilder.ClassFactory</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html#FactoryBuilder.ClassFactory(java.lang.String)">FactoryBuilder.ClassFactory(String)</a></span> - Constructor for class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration">FactoryBuilder.ClassFactory</a></dt> +<dd> +<div class="block">Constructor for the <a href="./javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration"><code>FactoryBuilder.ClassFactory</code></a>.</div> +</dd> +<dt><a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="class in javax.cache.configuration"><span class="strong">FactoryBuilder.SingletonFactory</span></a><<a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="type parameter in FactoryBuilder.SingletonFactory">T</a>> - Class in <a href="./javax/cache/configuration/package-summary.html">javax.cache.configuration</a></dt> +<dd> +<div class="block">A <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that always returns a specific instance.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html#FactoryBuilder.SingletonFactory(T)">FactoryBuilder.SingletonFactory(T)</a></span> - Constructor for class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="class in javax.cache.configuration">FactoryBuilder.SingletonFactory</a></dt> +<dd> +<div class="block">Constructor for the <a href="./javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="class in javax.cache.configuration"><code>FactoryBuilder.SingletonFactory</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.html#factoryOf(java.lang.Class)">factoryOf(Class<T>)</a></span> - Static method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.html" title="class in javax.cache.configuration">FactoryBuilder</a></dt> +<dd> +<div class="block">Constructs a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will produce factory instances of the + specified class.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.html#factoryOf(java.lang.String)">factoryOf(String)</a></span> - Static method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.html" title="class in javax.cache.configuration">FactoryBuilder</a></dt> +<dd> +<div class="block">Constructs a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will produce factory instances of the + specified class.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/FactoryBuilder.html#factoryOf(T)">factoryOf(T)</a></span> - Static method in class javax.cache.configuration.<a href="./javax/cache/configuration/FactoryBuilder.html" title="class in javax.cache.configuration">FactoryBuilder</a></dt> +<dd> +<div class="block">Constructs a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will return the specified factory + Serializable instance.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/AccessedExpiryPolicy.html#factoryOf(javax.cache.expiry.Duration)">factoryOf(Duration)</a></span> - Static method in class javax.cache.expiry.<a href="./javax/cache/expiry/AccessedExpiryPolicy.html" title="class in javax.cache.expiry">AccessedExpiryPolicy</a></dt> +<dd> +<div class="block">Obtains a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for an Accessed <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/CreatedExpiryPolicy.html#factoryOf(javax.cache.expiry.Duration)">factoryOf(Duration)</a></span> - Static method in class javax.cache.expiry.<a href="./javax/cache/expiry/CreatedExpiryPolicy.html" title="class in javax.cache.expiry">CreatedExpiryPolicy</a></dt> +<dd> +<div class="block">Obtains a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for a Created <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/EternalExpiryPolicy.html#factoryOf()">factoryOf()</a></span> - Static method in class javax.cache.expiry.<a href="./javax/cache/expiry/EternalExpiryPolicy.html" title="class in javax.cache.expiry">EternalExpiryPolicy</a></dt> +<dd> +<div class="block">Obtains a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for an Eternal <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/ModifiedExpiryPolicy.html#factoryOf(javax.cache.expiry.Duration)">factoryOf(Duration)</a></span> - Static method in class javax.cache.expiry.<a href="./javax/cache/expiry/ModifiedExpiryPolicy.html" title="class in javax.cache.expiry">ModifiedExpiryPolicy</a></dt> +<dd> +<div class="block">Obtains a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for a Modified <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/TouchedExpiryPolicy.html#factoryOf(javax.cache.expiry.Duration)">factoryOf(Duration)</a></span> - Static method in class javax.cache.expiry.<a href="./javax/cache/expiry/TouchedExpiryPolicy.html" title="class in javax.cache.expiry">TouchedExpiryPolicy</a></dt> +<dd> +<div class="block">Obtains a <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for a Touched <a href="./javax/cache/expiry/ExpiryPolicy.html" title="interface in javax.cache.expiry"><code>ExpiryPolicy</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#FIVE_MINUTES">FIVE_MINUTES</a></span> - Static variable in class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dd> +<div class="block">Five minutes.</div> +</dd> +</dl> +<a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="strong"><a href="./javax/cache/annotation/CacheKeyGenerator.html#generateCacheKey(javax.cache.annotation.CacheKeyInvocationContext)">generateCacheKey(CacheKeyInvocationContext<? extends Annotation>)</a></span> - Method in interface javax.cache.annotation.<a href="./javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation">CacheKeyGenerator</a></dt> +<dd> +<div class="block">Called for each intercepted method invocation to generate a suitable + cache key (as a <a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a>) from the + <a href="./javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><code>CacheKeyInvocationContext</code></a> data.</div> +</dd> +<dt><a href="./javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><span class="strong">GeneratedCacheKey</span></a> - Interface in <a href="./javax/cache/annotation/package-summary.html">javax.cache.annotation</a></dt> +<dd> +<div class="block">A <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io"><code>Serializable</code></a>, immutable, thread-safe object that is used as a key, + automatically generated by a <a href="./javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><code>CacheKeyGenerator</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#get(K)">get(K)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Gets an entry from the cache.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CompletionListenerFuture.html#get()">get()</a></span> - Method in class javax.cache.integration.<a href="./javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration">CompletionListenerFuture</a></dt> +<dd> +<div class="block">Waits if necessary for the computation to complete, and then + retrieves its result.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/integration/CompletionListenerFuture.html#get(long, java.util.concurrent.TimeUnit)">get(long, TimeUnit)</a></span> - Method in class javax.cache.integration.<a href="./javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration">CompletionListenerFuture</a></dt> +<dd> +<div class="block">Waits if necessary for at most the given time for the computation + to complete, and then retrieves its result, if available.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/processor/EntryProcessorResult.html#get()">get()</a></span> - Method in interface javax.cache.processor.<a href="./javax/cache/processor/EntryProcessorResult.html" title="interface in javax.cache.processor">EntryProcessorResult</a></dt> +<dd> +<div class="block">Obtain the result of processing an entry with an <a href="./javax/cache/processor/EntryProcessor.html" title="interface in javax.cache.processor"><code>EntryProcessor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/expiry/Duration.html#getAdjustedTime(long)">getAdjustedTime(long)</a></span> - Method in class javax.cache.expiry.<a href="./javax/cache/expiry/Duration.html" title="class in javax.cache.expiry">Duration</a></dt> +<dd> +<div class="block">Calculates the adjusted time (from the Epoc) given a specified time + (to be adjusted) by the duration.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#getAll(java.util.Set)">getAll(Set<? extends K>)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Gets a collection of entries from the <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>, returning them as + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util"><code>Map</code></a> of the values associated with the set of keys requested.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/annotation/CacheInvocationContext.html#getAllParameters()">getAllParameters()</a></span> - Method in interface javax.cache.annotation.<a href="./javax/cache/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation">CacheInvocationContext</a></dt> +<dd> +<div class="block">Returns a clone of the array of all method parameters.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#getAndPut(K, V)">getAndPut(K, V)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Associates the specified value with the specified key in this cache, + returning an existing value if one existed.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#getAndRemove(K)">getAndRemove(K)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Atomically removes the entry for a key only if currently mapped to some + value.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#getAndReplace(K, V)">getAndReplace(K, V)</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Atomically replaces the value for a given key if and only if there is a + value currently mapped by the key.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/annotation/CacheInvocationParameter.html#getAnnotations()">getAnnotations()</a></span> - Method in interface javax.cache.annotation.<a href="./javax/cache/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation">CacheInvocationParameter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./javax/cache/annotation/CacheMethodDetails.html#getAnnotations()">getAnnotations()</a></span> - Method in interface javax.cache.annotation.<a href="./javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation">CacheMethodDetails</a></dt> +<dd> +<div class="block">An immutable Set of all Annotations on this method</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getAverageGetTime()">getAverageGetTime()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">The mean time to execute gets.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getAveragePutTime()">getAveragePutTime()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">The mean time to execute puts.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getAverageRemoveTime()">getAverageRemoveTime()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">The mean time to execute removes.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#getCache(java.lang.String, java.lang.Class, java.lang.Class)">getCache(String, Class<K>, Class<V>)</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Looks up a managed <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> given its name.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/CacheManager.html#getCache(java.lang.String)">getCache(String)</a></span> - Method in interface javax.cache.<a href="./javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></dt> +<dd> +<div class="block">Looks up a managed <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> given its name.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Caching.html#getCache(java.lang.String, java.lang.Class, java.lang.Class)">getCache(String, Class<K>, Class<V>)</a></span> - Static method in class javax.cache.<a href="./javax/cache/Caching.html" title="class in javax.cache">Caching</a></dt> +<dd> +<div class="block">A convenience that method that looks up a managed <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> given its + name.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/annotation/CacheMethodDetails.html#getCacheAnnotation()">getCacheAnnotation()</a></span> - Method in interface javax.cache.annotation.<a href="./javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation">CacheMethodDetails</a></dt> +<dd> +<div class="block">The caching related annotation on the method.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html#getCacheEntryEventFilterFactory()">getCacheEntryEventFilterFactory()</a></span> - Method in interface javax.cache.configuration.<a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="interface in javax.cache.configuration">CacheEntryListenerConfiguration</a></dt> +<dd> +<div class="block">Obtains the <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="./javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event"><code>CacheEntryEventFilter</code></a> that should be + applied prior to notifying the <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableCacheEntryListenerConfiguration.html#getCacheEntryEventFilterFactory()">getCacheEntryEventFilterFactory()</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableCacheEntryListenerConfiguration.html" title="class in javax.cache.configuration">MutableCacheEntryListenerConfiguration</a></dt> +<dd> +<div class="block">Obtains the <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the <a href="./javax/cache/event/CacheEntryEventFilter.html" title="interface in javax.cache.event"><code>CacheEntryEventFilter</code></a> that should be + applied prior to notifying the <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/CompleteConfiguration.html#getCacheEntryListenerConfigurations()">getCacheEntryListenerConfigurations()</a></span> - Method in interface javax.cache.configuration.<a href="./javax/cache/configuration/CompleteConfiguration.html" title="interface in javax.cache.configuration">CompleteConfiguration</a></dt> +<dd> +<div class="block">Obtains the <a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="interface in javax.cache.configuration"><code>CacheEntryListenerConfiguration</code></a>s + for <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>s to be configured on a + <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#getCacheEntryListenerConfigurations()">getCacheEntryListenerConfigurations()</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dd> +<div class="block">Obtains the <a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="interface in javax.cache.configuration"><code>CacheEntryListenerConfiguration</code></a>s + for <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>s to be configured on a + <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html#getCacheEntryListenerFactory()">getCacheEntryListenerFactory()</a></span> - Method in interface javax.cache.configuration.<a href="./javax/cache/configuration/CacheEntryListenerConfiguration.html" title="interface in javax.cache.configuration">CacheEntryListenerConfiguration</a></dt> +<dd> +<div class="block">Obtains the <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the + <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableCacheEntryListenerConfiguration.html#getCacheEntryListenerFactory()">getCacheEntryListenerFactory()</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableCacheEntryListenerConfiguration.html" title="class in javax.cache.configuration">MutableCacheEntryListenerConfiguration</a></dt> +<dd> +<div class="block">Obtains the <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the + <a href="./javax/cache/event/CacheEntryListener.html" title="interface in javax.cache.event"><code>CacheEntryListener</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getCacheEvictions()">getCacheEvictions()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">The total number of evictions from the cache.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getCacheGets()">getCacheGets()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">The total number of requests to the cache.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getCacheHitPercentage()">getCacheHitPercentage()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">This is a measure of cache efficiency.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/management/CacheStatisticsMXBean.html#getCacheHits()">getCacheHits()</a></span> - Method in interface javax.cache.management.<a href="./javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management">CacheStatisticsMXBean</a></dt> +<dd> +<div class="block">The number of get requests that were satisfied by the cache.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/CompleteConfiguration.html#getCacheLoaderFactory()">getCacheLoaderFactory()</a></span> - Method in interface javax.cache.configuration.<a href="./javax/cache/configuration/CompleteConfiguration.html" title="interface in javax.cache.configuration">CompleteConfiguration</a></dt> +<dd> +<div class="block">Gets the <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the + <a href="./javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a>, if any.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/configuration/MutableConfiguration.html#getCacheLoaderFactory()">getCacheLoaderFactory()</a></span> - Method in class javax.cache.configuration.<a href="./javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration">MutableConfiguration</a></dt> +<dd> +<div class="block">Gets the <a href="./javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the + <a href="./javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a>, if any.</div> +</dd> +<dt><span class="strong"><a href="./javax/cache/Cache.html#getCacheManager()">getCacheManager()</a></span> - Method in interface javax.cache.<a href="./javax/cache/Cache.html" title="interface in javax.cache">Cache</a></dt> +<dd> +<div class="block">Gets the <a href="./javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> that owns and manages the <a href="./javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>.</div> +</dd>
[... 1016 lines stripped ...]
