Added: incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheInvocationParameter.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheInvocationParameter.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheInvocationParameter.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheInvocationParameter.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,263 @@ +<!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>CacheInvocationParameter (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="CacheInvocationParameter (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/CacheInvocationParameter.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/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheInvocationParameter.html" target="_top">Frames</a></li> +<li><a href="CacheInvocationParameter.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.annotation</div> +<h2 title="Interface CacheInvocationParameter" class="title">Interface CacheInvocationParameter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">CacheInvocationParameter</span></pre> +<div class="block">A parameter to an intercepted method invocation. Contains the parameter value + as well static type and annotation information about the parameter.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Eric Dalquist</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="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<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>></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheInvocationParameter.html#getAnnotations()">getAnnotations</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheInvocationParameter.html#getParameterPosition()">getParameterPosition</a></strong>()</code> +<div class="block">The index of the parameter in the original parameter array as returned by + <a href="../../../javax/cache/annotation/CacheInvocationContext.html#getAllParameters()"><code>CacheInvocationContext.getAllParameters()</code></a></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheInvocationParameter.html#getRawType()">getRawType</a></strong>()</code> +<div class="block">The parameter type as declared on the method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheInvocationParameter.html#getValue()">getValue</a></strong>()</code> </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="getRawType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRawType</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> getRawType()</pre> +<div class="block">The parameter type as declared on the method.</div> +</li> +</ul> +<a name="getValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValue</h4> +<pre><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> getValue()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The parameter value</dd></dl> +</li> +</ul> +<a name="getAnnotations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotations</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<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>> getAnnotations()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>An immutable Set of all Annotations on this method parameter, never + null.</dd></dl> +</li> +</ul> +<a name="getParameterPosition()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getParameterPosition</h4> +<pre>int getParameterPosition()</pre> +<div class="block">The index of the parameter in the original parameter array as returned by + <a href="../../../javax/cache/annotation/CacheInvocationContext.html#getAllParameters()"><code>CacheInvocationContext.getAllParameters()</code></a></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The index of the parameter in the original parameter array.</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/CacheInvocationParameter.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/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheInvocationParameter.html" target="_top">Frames</a></li> +<li><a href="CacheInvocationParameter.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/annotation/CacheKey.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKey.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKey.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKey.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,166 @@ +<!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>CacheKey (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="CacheKey (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/CacheKey.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/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheKey.html" target="_top">Frames</a></li> +<li><a href="CacheKey.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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.annotation</div> +<h2 title="Annotation Type CacheKey" class="title">Annotation Type CacheKey</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER"; title="class or interface in java.lang.annotation">PARAMETER</a>) +<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) +public @interface <span class="strong">CacheKey</span></pre> +<div class="block">Marks a method argument as part of the cache key. + If no arguments are marked all arguments are used. The exception is + for a method annotated with <a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a> where the <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a> + parameter is never included in the key</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Rick Hightower</dd> +<dt><span class="strong">See Also:</span></dt><dd><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>, +<a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html#getKeyParameters()"><code>CacheKeyInvocationContext.getKeyParameters()</code></a></dd></dl> +</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/CacheKey.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/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheKey.html" target="_top">Frames</a></li> +<li><a href="CacheKey.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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/annotation/CacheKeyGenerator.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKeyGenerator.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKeyGenerator.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKeyGenerator.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,225 @@ +<!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>CacheKeyGenerator (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="CacheKeyGenerator (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/CacheKeyGenerator.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/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheKeyGenerator.html" target="_top">Frames</a></li> +<li><a href="CacheKeyGenerator.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.annotation</div> +<h2 title="Interface CacheKeyGenerator" class="title">Interface CacheKeyGenerator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">CacheKeyGenerator</span></pre> +<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>. + <p> + Implementations must be thread-safe.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Eric Dalquist</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/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation">GeneratedCacheKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheKeyGenerator.html#generateCacheKey(javax.cache.annotation.CacheKeyInvocationContext)">generateCacheKey</a></strong>(<a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation">CacheKeyInvocationContext</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>> cacheKeyInvocationContext)</code> +<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> +</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="generateCacheKey(javax.cache.annotation.CacheKeyInvocationContext)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>generateCacheKey</h4> +<pre><a href="../../../javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation">GeneratedCacheKey</a> generateCacheKey(<a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation">CacheKeyInvocationContext</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>> cacheKeyInvocationContext)</pre> +<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> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheKeyInvocationContext</code> - Information about the intercepted method invocation</dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-null cache key for the invocation.</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/CacheKeyGenerator.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/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheKeyGenerator.html" target="_top">Frames</a></li> +<li><a href="CacheKeyGenerator.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/annotation/CacheKeyInvocationContext.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKeyInvocationContext.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKeyInvocationContext.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheKeyInvocationContext.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,277 @@ +<!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>CacheKeyInvocationContext (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="CacheKeyInvocationContext (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/CacheKeyInvocationContext.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/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheKeyInvocationContext.html" target="_top">Frames</a></li> +<li><a href="CacheKeyInvocationContext.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.annotation</div> +<h2 title="Interface CacheKeyInvocationContext" class="title">Interface CacheKeyInvocationContext<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>></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>A</code> - The type of annotation this context information is for. 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>, or <a href="../../../javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><code>CacheRemove</code></a>.</dd></dl> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../javax/cache/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation">CacheInvocationContext</a><A>, <a href="../../../javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation">CacheMethodDetails</a><A></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">CacheKeyInvocationContext<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>></span> +extends <a href="../../../javax/cache/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation">CacheInvocationContext</a><A></pre> +<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>. + <p> + Used with <a href="../../../javax/cache/annotation/CacheKeyGenerator.html#generateCacheKey(javax.cache.annotation.CacheKeyInvocationContext)"><code>CacheKeyGenerator.generateCacheKey(CacheKeyInvocationContext)</code></a> + to generate a <a href="../../../javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> for the invocation.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Eric Dalquist</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><code>CacheKeyGenerator</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/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation">CacheInvocationParameter</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html#getKeyParameters()">getKeyParameters</a></strong>()</code> +<div class="block">Returns a clone of the array of all method parameters to be used by the + <a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><code>CacheKeyGenerator</code></a> in creating a <a href="../../../javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/cache/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation">CacheInvocationParameter</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html#getValueParameter()">getValueParameter</a></strong>()</code> +<div class="block">When a method is annotated with <a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a> this is the parameter + annotated with <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a></div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.cache.annotation.CacheInvocationContext"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.cache.annotation.<a href="../../../javax/cache/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation">CacheInvocationContext</a></h3> +<code><a href="../../../javax/cache/annotation/CacheInvocationContext.html#getAllParameters()">getAllParameters</a>, <a href="../../../javax/cache/annotation/CacheInvocationContext.html#getTarget()">getTarget</a>, <a href="../../../javax/cache/annotation/CacheInvocationContext.html#unwrap(java.lang.Class)">unwrap</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.cache.annotation.CacheMethodDetails"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.cache.annotation.<a href="../../../javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation">CacheMethodDetails</a></h3> +<code><a href="../../../javax/cache/annotation/CacheMethodDetails.html#getAnnotations()">getAnnotations</a>, <a href="../../../javax/cache/annotation/CacheMethodDetails.html#getCacheAnnotation()">getCacheAnnotation</a>, <a href="../../../javax/cache/annotation/CacheMethodDetails.html#getCacheName()">getCacheName</a>, <a href="../../../javax/cache/annotation/CacheMethodDetails.html#getMethod()">getMethod</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getKeyParameters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyParameters</h4> +<pre><a href="../../../javax/cache/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation">CacheInvocationParameter</a>[] getKeyParameters()</pre> +<div class="block">Returns a clone of the array of all method parameters to be used by the + <a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><code>CacheKeyGenerator</code></a> in creating a <a href="../../../javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a>. The returned array + may be the same as or a subset of the array returned by + <a href="../../../javax/cache/annotation/CacheInvocationContext.html#getAllParameters()"><code>CacheInvocationContext.getAllParameters()</code></a> + <p> + Parameters in this array are selected by the following rules: + <ul> + <li>If no parameters are annotated with <a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><code>CacheKey</code></a> or <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a> + then all parameters are included</li> + <li>If a <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a> annotation exists and no <a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><code>CacheKey</code></a> then + all + parameters except the one annotated with <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a> are included</li> + <li>If one or more <a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><code>CacheKey</code></a> annotations exist only those parameters + with the <a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><code>CacheKey</code></a> annotation are included</li> + </ul></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>An array of all parameters to be used in cache key generation</dd></dl> +</li> +</ul> +<a name="getValueParameter()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getValueParameter</h4> +<pre><a href="../../../javax/cache/annotation/CacheInvocationParameter.html" title="interface in javax.cache.annotation">CacheInvocationParameter</a> getValueParameter()</pre> +<div class="block">When a method is annotated with <a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a> this is the parameter + annotated with <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The parameter to cache, will never be null for methods annotated with + <a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a>, will be null for methods not annotated with <a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><code>CachePut</code></a></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/CacheKeyInvocationContext.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/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheKeyInvocationContext.html" target="_top">Frames</a></li> +<li><a href="CacheKeyInvocationContext.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/annotation/CacheMethodDetails.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheMethodDetails.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheMethodDetails.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CacheMethodDetails.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,303 @@ +<!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>CacheMethodDetails (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="CacheMethodDetails (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/CacheMethodDetails.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/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheMethodDetails.html" target="_top">Frames</a></li> +<li><a href="CacheMethodDetails.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.annotation</div> +<h2 title="Interface CacheMethodDetails" class="title">Interface CacheMethodDetails<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>></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>A</code> - The type of annotation this context information is for. 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>.</dd></dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../javax/cache/annotation/CacheInvocationContext.html" title="interface in javax.cache.annotation">CacheInvocationContext</a><A>, <a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation">CacheKeyInvocationContext</a><A></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">CacheMethodDetails<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>></span></pre> +<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> + <p> + Used with <a href="../../../javax/cache/annotation/CacheResolverFactory.html#getCacheResolver(javax.cache.annotation.CacheMethodDetails)"><code>CacheResolverFactory.getCacheResolver(CacheMethodDetails)</code></a> to + determine the <a href="../../../javax/cache/annotation/CacheResolver.html" title="interface in javax.cache.annotation"><code>CacheResolver</code></a> to use with the method.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Eric Dalquist</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/annotation/CacheResolverFactory.html" title="interface in javax.cache.annotation"><code>CacheResolverFactory</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="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<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>></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheMethodDetails.html#getAnnotations()">getAnnotations</a></strong>()</code> +<div class="block">An immutable Set of all Annotations on this method</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../javax/cache/annotation/CacheMethodDetails.html" title="type parameter in CacheMethodDetails">A</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheMethodDetails.html#getCacheAnnotation()">getCacheAnnotation</a></strong>()</code> +<div class="block">The caching related annotation on the method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheMethodDetails.html#getCacheName()">getCacheName</a></strong>()</code> +<div class="block">The cache name resolved by the implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CacheMethodDetails.html#getMethod()">getMethod</a></strong>()</code> +<div class="block">The annotated method</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="getMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMethod</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> getMethod()</pre> +<div class="block">The annotated method</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The annotated method</dd></dl> +</li> +</ul> +<a name="getAnnotations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotations</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<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>> getAnnotations()</pre> +<div class="block">An immutable Set of all Annotations on this method</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>An immutable Set of all Annotations on this method</dd></dl> +</li> +</ul> +<a name="getCacheAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheAnnotation</h4> +<pre><a href="../../../javax/cache/annotation/CacheMethodDetails.html" title="type parameter in CacheMethodDetails">A</a> getCacheAnnotation()</pre> +<div class="block">The caching related annotation on the method. + 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> +<dl><dt><span class="strong">Returns:</span></dt><dd>The caching related annotation on the method.</dd></dl> +</li> +</ul> +<a name="getCacheName()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCacheName</h4> +<pre><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> getCacheName()</pre> +<div class="block">The cache name resolved by the implementation. + <p> + The cache name is determined by first looking at the cacheName attribute of + the method level annotation. If that attribute is not set then the class + level <a href="../../../javax/cache/annotation/CacheDefaults.html" title="annotation in javax.cache.annotation"><code>CacheDefaults</code></a> annotation is checked. If that annotation does + not exist or does not have its cacheName attribute set then the following + cache name generation rules are followed: + <p> + "fully qualified class name"."method name"("fully qualified parameter class + names") + <p> + For example: + <pre><code> + package my.app; + + public class DomainDao { + @CacheResult + public Domain getDomain(String domainId, int index) { + ... + } + } + </code></pre> + <p> + Results in the cache name: "my.app.DomainDao.getDomain(java.lang.String,int)"</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The fully resolved cache name</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/CacheMethodDetails.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/annotation/CacheKeyInvocationContext.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CachePut.html" title="annotation in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CacheMethodDetails.html" target="_top">Frames</a></li> +<li><a href="CacheMethodDetails.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/annotation/CachePut.html URL: http://svn.apache.org/viewvc/incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CachePut.html?rev=1662900&view=auto ============================================================================== --- incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CachePut.html (added) +++ incubator/ignite/site/trunk/jcache/1.0.0/javaodc/javax/cache/annotation/CachePut.html Sat Feb 28 04:53:18 2015 @@ -0,0 +1,385 @@ +<!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>CachePut (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="CachePut (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/CachePut.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/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CachePut.html" target="_top">Frames</a></li> +<li><a href="CachePut.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.annotation</div> +<h2 title="Annotation Type CachePut" class="title">Annotation Type CachePut</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE"; title="class or interface in java.lang.annotation">TYPE</a>}) +<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) +public @interface <span class="strong">CachePut</span></pre> +<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>. + <p> + The default behavior is to call <a href="../../../javax/cache/Cache.html#put(K, V)"><code>Cache.put(Object, Object)</code></a> + after the annotated method is invoked, this behavior can be changed by setting + <a href="../../../javax/cache/annotation/CachePut.html#afterInvocation()"><code>afterInvocation()</code></a> to false in which case + <a href="../../../javax/cache/Cache.html#put(K, V)"><code>Cache.put(Object, Object)</code></a> will be called before the annotated method is + invoked. + <p> + Example of caching the Domain object with a key generated from the String and + int parameters. The <a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a> annotation is used to designate which + parameter should be stored in the "domainDao" cache. + <pre><code> + package my.app; + + public class DomainDao { + @CachePut(cacheName="domainCache") + public void updateDomain(String domainId, int index, @CacheValue Domain + domain) { + ... + } + } + </code></pre> + <p> + Exception Handling, only used if <a href="../../../javax/cache/annotation/CachePut.html#afterInvocation()"><code>afterInvocation()</code></a> is true. + <ol> + <li>If <a href="../../../javax/cache/annotation/CachePut.html#cacheFor()"><code>cacheFor()</code></a> and <a href="../../../javax/cache/annotation/CachePut.html#noCacheFor()"><code>noCacheFor()</code></a> are both empty then all + exceptions prevent the put</li> + <li>If <a href="../../../javax/cache/annotation/CachePut.html#cacheFor()"><code>cacheFor()</code></a> is specified and <a href="../../../javax/cache/annotation/CachePut.html#noCacheFor()"><code>noCacheFor()</code></a> is not + specified then only exceptions that pass an instanceof check against the + cacheFor list result in a put</li> + <li>If <a href="../../../javax/cache/annotation/CachePut.html#noCacheFor()"><code>noCacheFor()</code></a> is specified and <a href="../../../javax/cache/annotation/CachePut.html#cacheFor()"><code>cacheFor()</code></a> is not + specified then all exceptions that do not pass an instanceof check against the + noCacheFor result in a put</li> + <li>If <a href="../../../javax/cache/annotation/CachePut.html#cacheFor()"><code>cacheFor()</code></a> and <a href="../../../javax/cache/annotation/CachePut.html#noCacheFor()"><code>noCacheFor()</code></a> are both specified then + exceptions that pass an instanceof check against the cacheFor list but do not + pass an instanceof check against the noCacheFor list result in a put</li> + </ol></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Eric Dalquist, Rick Hightower</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/annotation/CacheValue.html" title="annotation in javax.cache.annotation"><code>CacheValue</code></a>, +<a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><code>CacheKey</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CachePut.html#afterInvocation()">afterInvocation</a></strong></code> +<div class="block">When <a href="../../../javax/cache/Cache.html#put(K, V)"><code>Cache.put(Object, Object)</code></a> should be called.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <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>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CachePut.html#cacheFor()">cacheFor</a></strong></code> +<div class="block">Defines zero (0) or more exception <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang"><code>classes</code></a>, that must be a + subclass of <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang"><code>Throwable</code></a>, indicating the exception types that <b>must</b> + cause the parameter to be cached.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation">CacheKeyGenerator</a>></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CachePut.html#cacheKeyGenerator()">cacheKeyGenerator</a></strong></code> +<div class="block">The <a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><code>CacheKeyGenerator</code></a> to use to generate the <a href="../../../javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> for interacting with the specified Cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CachePut.html#cacheName()">cacheName</a></strong></code> +<div class="block">The name of the cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../javax/cache/annotation/CacheResolverFactory.html" title="interface in javax.cache.annotation">CacheResolverFactory</a>></code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CachePut.html#cacheResolverFactory()">cacheResolverFactory</a></strong></code> +<div class="block">The <a href="../../../javax/cache/annotation/CacheResolverFactory.html" title="interface in javax.cache.annotation"><code>CacheResolverFactory</code></a> used to find the <a href="../../../javax/cache/annotation/CacheResolver.html" title="interface in javax.cache.annotation"><code>CacheResolver</code></a> to + use at runtime.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <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>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../javax/cache/annotation/CachePut.html#noCacheFor()">noCacheFor</a></strong></code> +<div class="block">Defines zero (0) or more exception <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang"><code>Classes</code></a>, which must be a + subclass of <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang"><code>Throwable</code></a>, indicating which exception types <b>must + not</b> cause the parameter to be cached.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="cacheName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cacheName</h4> +<pre>public abstract <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> cacheName</pre> +<div class="block">The name of the cache. + <p> + If not specified defaults first to <a href="../../../javax/cache/annotation/CacheDefaults.html#cacheName()"><code>CacheDefaults.cacheName()</code></a> and if + that is not set it defaults to: + package.name.ClassName.methodName(package.ParameterType,package.ParameterType)</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="afterInvocation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterInvocation</h4> +<pre>public abstract boolean afterInvocation</pre> +<div class="block">When <a href="../../../javax/cache/Cache.html#put(K, V)"><code>Cache.put(Object, Object)</code></a> should be called. If true it is called + after the annotated method invocation completes successfully. If false it is + called before the annotated method is invoked. + <p> + Defaults to true. + <p> + If true and the annotated method throws an exception the rules governing + <a href="../../../javax/cache/annotation/CachePut.html#cacheFor()"><code>cacheFor()</code></a> and <a href="../../../javax/cache/annotation/CachePut.html#noCacheFor()"><code>noCacheFor()</code></a> will be followed.</div> +<dl> +<dt>Default:</dt> +<dd>true</dd> +</dl> +</li> +</ul> +<a name="cacheResolverFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cacheResolverFactory</h4> +<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../javax/cache/annotation/CacheResolverFactory.html" title="interface in javax.cache.annotation">CacheResolverFactory</a>> cacheResolverFactory</pre> +<div class="block">The <a href="../../../javax/cache/annotation/CacheResolverFactory.html" title="interface in javax.cache.annotation"><code>CacheResolverFactory</code></a> used to find the <a href="../../../javax/cache/annotation/CacheResolver.html" title="interface in javax.cache.annotation"><code>CacheResolver</code></a> to + use at runtime. + <p> + The default resolver pair will resolve the cache by name from the default + <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a></div> +<dl> +<dt>Default:</dt> +<dd>javax.cache.annotation.CacheResolverFactory.class</dd> +</dl> +</li> +</ul> +<a name="cacheKeyGenerator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cacheKeyGenerator</h4> +<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation">CacheKeyGenerator</a>> cacheKeyGenerator</pre> +<div class="block">The <a href="../../../javax/cache/annotation/CacheKeyGenerator.html" title="interface in javax.cache.annotation"><code>CacheKeyGenerator</code></a> to use to generate the <a href="../../../javax/cache/annotation/GeneratedCacheKey.html" title="interface in javax.cache.annotation"><code>GeneratedCacheKey</code></a> for interacting with the specified Cache. + <p> + Defaults to a key generator that uses <a href="http://download.oracle.com/javase/6/docs/api/java/util/Arrays.html?is-external=true#deepHashCode(java.lang.Object[])" title="class or interface in java.util"><code>Arrays.deepHashCode(Object[])</code></a> + and <a href="http://download.oracle.com/javase/6/docs/api/java/util/Arrays.html?is-external=true#deepEquals(java.lang.Object[], java.lang.Object[])" title="class or interface in java.util"><code>Arrays.deepEquals(Object[], Object[])</code></a> with the array + returned by <a href="../../../javax/cache/annotation/CacheKeyInvocationContext.html#getKeyParameters()"><code>CacheKeyInvocationContext.getKeyParameters()</code></a></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/annotation/CacheKey.html" title="annotation in javax.cache.annotation"><code>CacheKey</code></a></dd></dl> +<dl> +<dt>Default:</dt> +<dd>javax.cache.annotation.CacheKeyGenerator.class</dd> +</dl> +</li> +</ul> +<a name="cacheFor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cacheFor</h4> +<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <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>>[] cacheFor</pre> +<div class="block">Defines zero (0) or more exception <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang"><code>classes</code></a>, that must be a + subclass of <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang"><code>Throwable</code></a>, indicating the exception types that <b>must</b> + cause the parameter to be cached. Only used if <a href="../../../javax/cache/annotation/CachePut.html#afterInvocation()"><code>afterInvocation()</code></a> is + true.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="noCacheFor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>noCacheFor</h4> +<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <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>>[] noCacheFor</pre> +<div class="block">Defines zero (0) or more exception <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang"><code>Classes</code></a>, which must be a + subclass of <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang"><code>Throwable</code></a>, indicating which exception types <b>must + not</b> cause the parameter to be cached. Only used if + <a href="../../../javax/cache/annotation/CachePut.html#afterInvocation()"><code>afterInvocation()</code></a> is true.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/CachePut.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/annotation/CacheMethodDetails.html" title="interface in javax.cache.annotation"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../javax/cache/annotation/CacheRemove.html" title="annotation in javax.cache.annotation"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?javax/cache/annotation/CachePut.html" target="_top">Frames</a></li> +<li><a href="CachePut.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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>
