Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/expiry/package-use.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/expiry/package-use.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/expiry/package-use.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/expiry/package-use.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,184 @@ +<!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>Uses of Package javax.cache.expiry (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="Uses of Package javax.cache.expiry (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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/expiry/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="header"> +<h1 title="Uses of Package javax.cache.expiry" class="title">Uses of Package<br>javax.cache.expiry</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../javax/cache/expiry/package-summary.html">javax.cache.expiry</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#javax.cache.configuration">javax.cache.configuration</a></td> +<td class="colLast"> +<div class="block">This package contains configuration classes and interfaces.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#javax.cache.expiry">javax.cache.expiry</a></td> +<td class="colLast"> +<div class="block">This package contains expiry policies</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="javax.cache.configuration"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../javax/cache/expiry/package-summary.html">javax.cache.expiry</a> used by <a href="../../../javax/cache/configuration/package-summary.html">javax.cache.configuration</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../javax/cache/expiry/class-use/ExpiryPolicy.html#javax.cache.configuration">ExpiryPolicy</a> +<div class="block">Defines functions to determine when cache entries will expire based on + creation, access and modification operations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="javax.cache.expiry"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../javax/cache/expiry/package-summary.html">javax.cache.expiry</a> used by <a href="../../../javax/cache/expiry/package-summary.html">javax.cache.expiry</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../javax/cache/expiry/class-use/Duration.html#javax.cache.expiry">Duration</a> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../javax/cache/expiry/class-use/ExpiryPolicy.html#javax.cache.expiry">ExpiryPolicy</a> +<div class="block">Defines functions to determine when cache entries will expire based on + creation, access and modification operations.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/expiry/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014. All Rights Reserved.</small></p> +</body> +</html>
Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoader.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoader.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoader.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoader.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,256 @@ +<!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:25 EST 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CacheLoader (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="CacheLoader (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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CacheLoader.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheLoader.html" target="_top">Frames</a></li> +<li><a href="CacheLoader.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">javax.cache.integration</div> +<h2 title="Interface CacheLoader" class="title">Interface CacheLoader<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> - the type of keys handled by this loader</dd><dd><code>V</code> - the type of values generated by this loader</dd></dl> +<hr> +<br> +<pre>public interface <span class="strong">CacheLoader<K,V></span></pre> +<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> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Greg Luck, Yannis Cosmadopoulos</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/configuration/CompleteConfiguration.html#isReadThrough()"><code>CompleteConfiguration.isReadThrough()</code></a>, +<a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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><a href="../../../javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/integration/CacheLoader.html#load(K)">load</a></strong>(<a href="../../../javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">K</a> key)</code> +<div class="block">Loads an object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/integration/CacheLoader.html#loadAll(java.lang.Iterable)">loadAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><? extends <a href="../../../javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">K</a>> keys)</code> +<div class="block">Loads multiple objects.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="load(java.lang.Object)"> +<!-- --> +</a><a name="load(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>load</h4> +<pre><a href="../../../javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">V</a> load(<a href="../../../javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">K</a> key) + throws <a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></pre> +<div class="block">Loads an object. Application developers should implement this + method to customize the loading of a value for a cache entry. This method + is called by a cache when a requested entry is not in the cache. If + the object can't be loaded <code>null</code> should be returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key identifying the object being loaded</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value for the entry that is to be stored in the cache or + <code>null</code> if the object can't be loaded</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></code> - if there is problem executing the loader.</dd></dl> +</li> +</ul> +<a name="loadAll(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>loadAll</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>> loadAll(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><? extends <a href="../../../javax/cache/integration/CacheLoader.html" title="type parameter in CacheLoader">K</a>> keys) + throws <a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></pre> +<div class="block">Loads multiple objects. Application developers should implement this + method to customize the loading of cache entries. This method is called + when the requested object is not in the cache. If an object can't be loaded, + it is not returned in the resulting map.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - keys identifying the values to be loaded</dd> +<dt><span class="strong">Returns:</span></dt><dd>A map of key, values to be stored in the cache.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration">CacheLoaderException</a></code> - if there is problem executing the loader.</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/CacheLoader.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheLoader.html" target="_top">Frames</a></li> +<li><a href="CacheLoader.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>Copyright © 2014. All Rights Reserved.</small></p> +</body> +</html> Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoaderException.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoaderException.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoaderException.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheLoaderException.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,341 @@ +<!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:25 EST 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CacheLoaderException (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="CacheLoaderException (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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CacheLoaderException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheLoaderException.html" target="_top">Frames</a></li> +<li><a href="CacheLoaderException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.cache.integration</div> +<h2 title="Class CacheLoaderException" class="title">Class CacheLoaderException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">java.lang.RuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../javax/cache/CacheException.html" title="class in javax.cache">javax.cache.CacheException</a></li> +<li> +<ul class="inheritance"> +<li>javax.cache.integration.CacheLoaderException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CacheLoaderException</span> +extends <a href="../../../javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></pre> +<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>. + <p> + A Caching Implementation must wrap any <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a> thrown by a <a href="../../../javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a> in this exception.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Greg Luck</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#javax.cache.integration.CacheLoaderException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheLoaderException.html#CacheLoaderException()">CacheLoaderException</a></strong>()</code> +<div class="block">Constructs a new CacheLoaderException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheLoaderException.html#CacheLoaderException(java.lang.String)">CacheLoaderException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</code> +<div class="block">Constructs a new CacheLoaderException with a message string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheLoaderException.html#CacheLoaderException(java.lang.String, java.lang.Throwable)">CacheLoaderException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<div class="block">Constructs a CacheLoaderException with a message string, and + a base exception</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheLoaderException.html#CacheLoaderException(java.lang.Throwable)">CacheLoaderException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<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> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace( )" title="class or interface in java.lang">getStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http: //download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CacheLoaderException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException()</pre> +<div class="block">Constructs a new CacheLoaderException.</div> +</li> +</ul> +<a name="CacheLoaderException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</pre> +<div class="block">Constructs a new CacheLoaderException with a message string.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the detail message. The detail message is saved for + later retrieval by the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang"><code>Throwable.getMessage()</code></a> method.</dd></dl> +</li> +</ul> +<a name="CacheLoaderException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<div class="block">Constructs a CacheLoaderException with a message string, and + a base exception</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the detail message. The detail message is saved for + later retrieval by the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang"><code>Throwable.getMessage()</code></a> method.</dd><dd><code>cause</code> - the cause (that is saved for later retrieval by the + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang"><code>Throwable.getCause()</code></a> method). (A <tt>null</tt> value is + permitted, and indicates that the cause is nonexistent or + unknown.)</dd><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd></dl> +</li> +</ul> +<a name="CacheLoaderException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<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>). This constructor is useful for runtime exceptions + that are little more than wrappers for other throwables.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - the cause (that is saved for later retrieval by the + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang"><code>Throwable.getCause()</code></a> method). (A <tt>null</tt> value is + permitted, and indicates that the cause is nonexistent or + unknown.)</dd><dt><span class="strong">Since:</span></dt> + <dd>1.0</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/CacheLoaderException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheLoaderException.html" target="_top">Frames</a></li> +<li><a href="CacheLoaderException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014. All Rights Reserved.</small></p> +</body> +</html> Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriter.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriter.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriter.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriter.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,343 @@ +<!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:25 EST 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CacheWriter (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="CacheWriter (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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CacheWriter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheWriter.html" target="_top">Frames</a></li> +<li><a href="CacheWriter.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">javax.cache.integration</div> +<h2 title="Interface CacheWriter" class="title">Interface CacheWriter<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> - the type of keys maintained by this map</dd><dd><code>V</code> - the type of mapped values</dd></dl> +<hr> +<br> +<pre>public interface <span class="strong">CacheWriter<K,V></span></pre> +<div class="block">A CacheWriter is used for write-through to an external resource. + <p> + Under Default Consistency, the non-batch writer methods are atomic with respect + to the corresponding cache operation. + <p> + For batch methods under Default Consistency, the entire cache operation + is not required to be atomic in <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> and is therefore not required to + be atomic in the writer. As individual writer operations can fail, cache + operations are not required to occur until after the writer batch method has + returned or, in the case of partial success, thrown an exception. In the case + of partial success, the collection of entries return must only contain + those entries that failed. + <p> + The entry passed into <a href="../../../javax/cache/integration/CacheWriter.html#write(javax.cache.Cache.Entry)"><code>write(Cache.Entry)</code></a> is independent + of the cache mapping for that key, meaning that if the value changes in the + cache or is removed it does not change the entry.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Greg Luck, Brian Oliver</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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="../../../javax/cache/integration/CacheWriter.html#delete(java.lang.Object)">delete</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key)</code> +<div class="block">Delete the cache entry from the external resource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/integration/CacheWriter.html#deleteAll(java.util.Collection)">deleteAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><?> keys)</code> +<div class="block">Remove data and keys from the external resource for the given collection of + keys, if present.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/integration/CacheWriter.html#write(javax.cache.Cache.Entry)">write</a></strong>(<a href="../../../javax/cache/Cache.Entry.html" title="interface in javax.cache">Cache.Entry</a><? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">K</a>,? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">V</a>> entry)</code> +<div class="block">Write the specified value under the specified key to the external resource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/integration/CacheWriter.html#writeAll(java.util.Collection)">writeAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../javax/cache/Cache.Entry.html" title="interface in javax.cache">Cache.Entry</a><? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">K</a>,? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">V</a>>> entries)</code> +<div class="block">Write the specified entries to the external resource.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="write(javax.cache.Cache.Entry)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>void write(<a href="../../../javax/cache/Cache.Entry.html" title="interface in javax.cache">Cache.Entry</a><? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">K</a>,? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">V</a>> entry) + throws <a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></pre> +<div class="block">Write the specified value under the specified key to the external resource. + <p> + This method is intended to support both key/value creation and value update + for a specific key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - the entry to be written</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></code> - if the write fails. If thrown the + cache mutation will not occur.</dd></dl> +</li> +</ul> +<a name="writeAll(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeAll</h4> +<pre>void writeAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../javax/cache/Cache.Entry.html" title="interface in javax.cache">Cache.Entry</a><? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">K</a>,? extends <a href="../../../javax/cache/integration/CacheWriter.html" title="type parameter in CacheWriter">V</a>>> entries) + throws <a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></pre> +<div class="block">Write the specified entries to the external resource. This method is intended + to support both insert and update. + <p> + The order that individual writes occur is undefined, as + <a href="../../../javax/cache/Cache.html#putAll(java.util.Map)"><code>Cache.putAll(java.util.Map)</code></a> also has undefined ordering. + <p> + If this operation fails (by throwing an exception) after a partial success, + the writer must remove any successfully written entries from the entries + collection so that the caching implementation knows what succeeded and can + mutate the cache.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entries</code> - a mutable collection to write. Upon invocation, it contains + the entries to write for write-through. Upon return the + collection must only contain entries that were not + successfully written. (see partial success above)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></code> - if one or more of the writes fail. If + thrown cache mutations will occur for + entries that succeeded.</dd></dl> +</li> +</ul> +<a name="delete(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>void delete(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key) + throws <a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></pre> +<div class="block">Delete the cache entry from the external resource. + <p> + Expiry of a cache entry is not a delete hence will not cause this method to + be invoked. + <p> + This method is invoked even if no mapping for the key exists.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key that is used for the delete operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></code> - if delete fails. If thrown the cache delete will + not occur.</dd></dl> +</li> +</ul> +<a name="deleteAll(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>void deleteAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><?> keys) + throws <a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></pre> +<div class="block">Remove data and keys from the external resource for the given collection of + keys, if present. + <p> + The order that individual deletes occur is undefined, as + <a href="../../../javax/cache/Cache.html#removeAll(java.util.Set)"><code>Cache.removeAll(java.util.Set)</code></a> also has undefined ordering. + <p> + If this operation fails (by throwing an exception) after a partial success, + the writer must remove any successfully written entries from the entries + collection so that the caching implementation knows what succeeded and can + mutate the cache. + <p> + Expiry of a cache entry is not a delete hence will not cause this method to + be invoked. + <p> + This method may include keys even if there is no mapping for that key, + in which case the data represented by that key should be removed from the + underlying resource.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - a mutable collection of keys for entries to delete. Upon + invocation, it contains the keys to delete for write-through. + Upon return the collection must only contain the keys that were + not successfully deleted. (see partial success above)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration">CacheWriterException</a></code> - if one or more deletes fail. If thrown + cache deletes will occur for entries that + succeeded.</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/CacheWriter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheLoaderException.html" title="class in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheWriter.html" target="_top">Frames</a></li> +<li><a href="CacheWriter.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>Copyright © 2014. All Rights Reserved.</small></p> +</body> +</html> Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriterException.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriterException.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriterException.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CacheWriterException.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,341 @@ +<!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:25 EST 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CacheWriterException (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="CacheWriterException (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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CacheWriterException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CompletionListener.html" title="interface in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheWriterException.html" target="_top">Frames</a></li> +<li><a href="CacheWriterException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.cache.integration</div> +<h2 title="Class CacheWriterException" class="title">Class CacheWriterException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">java.lang.RuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../javax/cache/CacheException.html" title="class in javax.cache">javax.cache.CacheException</a></li> +<li> +<ul class="inheritance"> +<li>javax.cache.integration.CacheWriterException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CacheWriterException</span> +extends <a href="../../../javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></pre> +<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>. + <p> + A Caching Implementation must wrap any <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a> thrown by a <a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a> in this exception.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Greg Luck</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#javax.cache.integration.CacheWriterException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheWriterException.html#CacheWriterException()">CacheWriterException</a></strong>()</code> +<div class="block">Constructs a new CacheWriterException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheWriterException.html#CacheWriterException(java.lang.String)">CacheWriterException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</code> +<div class="block">Constructs a new CacheWriterException with a message string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheWriterException.html#CacheWriterException(java.lang.String, java.lang.Throwable)">CacheWriterException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<div class="block">Constructs a CacheWriterException with a message string, and + a base exception</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../javax/cache/integration/CacheWriterException.html#CacheWriterException(java.lang.Throwable)">CacheWriterException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</code> +<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> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace( )" title="class or interface in java.lang">getStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http: //download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CacheWriterException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheWriterException</h4> +<pre>public CacheWriterException()</pre> +<div class="block">Constructs a new CacheWriterException.</div> +</li> +</ul> +<a name="CacheWriterException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheWriterException</h4> +<pre>public CacheWriterException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</pre> +<div class="block">Constructs a new CacheWriterException with a message string.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the detail message. The detail message is saved for + later retrieval by the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang"><code>Throwable.getMessage()</code></a> method.</dd></dl> +</li> +</ul> +<a name="CacheWriterException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheWriterException</h4> +<pre>public CacheWriterException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<div class="block">Constructs a CacheWriterException with a message string, and + a base exception</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the detail message. The detail message is saved for + later retrieval by the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang"><code>Throwable.getMessage()</code></a> method.</dd><dd><code>cause</code> - the cause (that is saved for later retrieval by the + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang"><code>Throwable.getCause()</code></a> method). (A <tt>null</tt> value is + permitted, and indicates that the cause is nonexistent or + unknown.)</dd><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd></dl> +</li> +</ul> +<a name="CacheWriterException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CacheWriterException</h4> +<pre>public CacheWriterException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause)</pre> +<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>). This constructor is useful for runtime exceptions + that are little more than wrappers for other throwables.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - the cause (that is saved for later retrieval by the + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang"><code>Throwable.getCause()</code></a> method). (A <tt>null</tt> value is + permitted, and indicates that the cause is nonexistent or + unknown.)</dd><dt><span class="strong">Since:</span></dt> + <dd>1.0</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/CacheWriterException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CompletionListener.html" title="interface in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CacheWriterException.html" target="_top">Frames</a></li> +<li><a href="CacheWriterException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014. All Rights Reserved.</small></p> +</body> +</html> Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CompletionListener.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CompletionListener.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CompletionListener.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/integration/CompletionListener.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,250 @@ +<!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:25 EST 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CompletionListener (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="CompletionListener (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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CompletionListener.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CompletionListener.html" target="_top">Frames</a></li> +<li><a href="CompletionListener.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">javax.cache.integration</div> +<h2 title="Interface CompletionListener" class="title">Interface CompletionListener</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration">CompletionListenerFuture</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">CompletionListener</span></pre> +<div class="block">A CompletionListener is implemented by an application when it needs to be + notified of the completion of some Cache operation. + <p> + When the operation is complete, the Cache provider notifies the application + by calling the <a href="../../../javax/cache/integration/CompletionListener.html#onCompletion()"><code>onCompletion()</code></a> method of the <a href="../../../javax/cache/integration/CompletionListener.html" title="interface in javax.cache.integration"><code>CompletionListener</code></a>. + <p> + If the operation fails for any reason, the Cache provider calls the + <a href="../../../javax/cache/integration/CompletionListener.html#onException(java.lang.Exception)"><code>onException(Exception)</code></a> method of the <a href="../../../javax/cache/integration/CompletionListener.html" title="interface in javax.cache.integration"><code>CompletionListener</code></a>. + <p> + To support a Java Future-based approach to synchronously wait for a Cache + operation to complete, use a <a href="../../../javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration"><code>CompletionListenerFuture</code></a>. + <p> + A CompletionListener will use an implementation specific thread for the call.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian Oliver</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration"><code>CompletionListenerFuture</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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="../../../javax/cache/integration/CompletionListener.html#onCompletion()">onCompletion</a></strong>()</code> +<div class="block">Notifies the application that the operation completed successfully.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/integration/CompletionListener.html#onException(java.lang.Exception)">onException</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> e)</code> +<div class="block">Notifies the application that the operation failed.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="onCompletion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onCompletion</h4> +<pre>void onCompletion()</pre> +<div class="block">Notifies the application that the operation completed successfully.</div> +</li> +</ul> +<a name="onException(java.lang.Exception)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onException</h4> +<pre>void onException(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> e)</pre> +<div class="block">Notifies the application that the operation failed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the Exception that occurred</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/CompletionListener.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../javax/cache/integration/CacheWriterException.html" title="class in javax.cache.integration"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/integration/CompletionListenerFuture.html" title="class in javax.cache.integration"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/integration/CompletionListener.html" target="_top">Frames</a></li> +<li><a href="CompletionListener.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>Copyright © 2014. All Rights Reserved.</small></p> +</body> +</html>
