http://git-wip-us.apache.org/repos/asf/geode-site/blob/22311e92/releases/10M2/javadoc/com/gemstone/gemfire/CancelCriterion.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/CancelCriterion.html b/releases/10M2/javadoc/com/gemstone/gemfire/CancelCriterion.html deleted file mode 100644 index b87e94b..0000000 --- a/releases/10M2/javadoc/com/gemstone/gemfire/CancelCriterion.html +++ /dev/null @@ -1,383 +0,0 @@ -<!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 (1.8.0_66-internal) on Wed Apr 13 11:47:04 PDT 2016 --> -<title>CancelCriterion (Apache Geode 1.0.0-incubating.M2)</title> -<meta name="date" content="2016-04-13"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CancelCriterion (Apache Geode 1.0.0-incubating.M2)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":10,"i2":10,"i3":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CancelCriterion.html" target="_top">Frames</a></li> -<li><a href="CancelCriterion.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="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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">com.gemstone.gemfire</div> -<h2 title="Class CancelCriterion" class="title">Class CancelCriterion</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>com.gemstone.gemfire.CancelCriterion</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">CancelCriterion</span> -extends java.lang.Object</pre> -<div class="block">Abstract cancellation proxy for cancelling an operation, esp. a thread. - - Creators of services or threads should implement a subclass of CancelCriterion, - and implement the two methods - cancelInProgress, and generateCancelledException(e). - - Code inside the service can check to see if the service is cancelled by calling - <a href="../../../com/gemstone/gemfire/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>. Generally the pattern is to check - before performing an operation, check if the service is canceled before propgrating - an exception futher up the stack, and check for cancelation inside a long loop. - Eg. - - <code> - while(true) { - c.checkCancelInProgress(null); - try { - dispatchEvents(); - } catch(IOException e) { - c.checkCancelInProgress(e); - throw e; - } - } - </code></div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>5.1</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire"><code>CancelException</code></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="memberSummary" 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><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelCriterion.html#CancelCriterion--">CancelCriterion</a></span>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>abstract java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelCriterion.html#cancelInProgress--">cancelInProgress</a></span>()</code> -<div class="block">Indicate if the service is in the progress of being cancelled.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-">checkCancelInProgress</a></span>(java.lang.Throwable e)</code> -<div class="block">See if the current operation is being cancelled.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>protected java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelCriterion.html#checkFailure--">checkFailure</a></span>()</code> -<div class="block">Use this utility function in your implementation of cancelInProgress() - and cancelled() to indicate a system failure</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>abstract java.lang.RuntimeException</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelCriterion.html#generateCancelledException-java.lang.Throwable-">generateCancelledException</a></span>(java.lang.Throwable e)</code> -<div class="block">Template factory method for generating the exception to be thrown by - <a href="../../../com/gemstone/gemfire/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="CancelCriterion--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>CancelCriterion</h4> -<pre>public CancelCriterion()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="cancelInProgress--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>cancelInProgress</h4> -<pre>public abstract java.lang.String cancelInProgress()</pre> -<div class="block">Indicate if the service is in the progress of being cancelled. The - typical use of this is to indicate, in the case of an <code>InterruptedException</code>, - that the current operation should be cancelled.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>null if the service is not shutting down, or a message that can be used to - construct an exception indicating the service is shut down.</dd> -</dl> -</li> -</ul> -<a name="checkFailure--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>checkFailure</h4> -<pre>protected final java.lang.String checkFailure()</pre> -<div class="block">Use this utility function in your implementation of cancelInProgress() - and cancelled() to indicate a system failure</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>failure string if system failure has occurred</dd> -</dl> -</li> -</ul> -<a name="checkCancelInProgress-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>checkCancelInProgress</h4> -<pre>public final void checkCancelInProgress(java.lang.Throwable e)</pre> -<div class="block">See if the current operation is being cancelled. If so, it either - throws a <code>RuntimeException</code> (usually a <a href="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire"><code>CancelException</code></a>).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>e</code> - an underlying exception or null if there is no exception - that triggered this check</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/CancelCriterion.html#cancelInProgress--"><code>cancelInProgress()</code></a></dd> -</dl> -</li> -</ul> -<a name="generateCancelledException-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>generateCancelledException</h4> -<pre>public abstract java.lang.RuntimeException generateCancelledException(java.lang.Throwable e)</pre> -<div class="block">Template factory method for generating the exception to be thrown by - <a href="../../../com/gemstone/gemfire/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>. Override this to specify - different exception for checkCancelInProgress() to throw. - - This method should wrap the exception in a service specific - CancelationException (eg CacheClosedException). - or return null if the service is not being canceled.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>e</code> - an underlying exception, if any</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>RuntimeException to be thrown by checkCancelInProgress(), null if - the receiver has not been cancelled.</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CancelCriterion.html" target="_top">Frames</a></li> -<li><a href="CancelCriterion.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="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/geode-site/blob/22311e92/releases/10M2/javadoc/com/gemstone/gemfire/CancelException.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/CancelException.html b/releases/10M2/javadoc/com/gemstone/gemfire/CancelException.html deleted file mode 100644 index 7eab22b..0000000 --- a/releases/10M2/javadoc/com/gemstone/gemfire/CancelException.html +++ /dev/null @@ -1,360 +0,0 @@ -<!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 (1.8.0_66-internal) on Wed Apr 13 11:47:04 PDT 2016 --> -<title>CancelException (Apache Geode 1.0.0-incubating.M2)</title> -<meta name="date" content="2016-04-13"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CancelException (Apache Geode 1.0.0-incubating.M2)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CancelCriterion.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/CanonicalInstantiator.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CancelException.html" target="_top">Frames</a></li> -<li><a href="CancelException.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.com.gemstone.gemfire.cache.CacheRuntimeException">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">com.gemstone.gemfire</div> -<h2 title="Class CancelException" class="title">Class CancelException</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>java.lang.Throwable</li> -<li> -<ul class="inheritance"> -<li>java.lang.Exception</li> -<li> -<ul class="inheritance"> -<li>java.lang.RuntimeException</li> -<li> -<ul class="inheritance"> -<li><a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> -<li> -<ul class="inheritance"> -<li><a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.CacheRuntimeException</a></li> -<li> -<ul class="inheritance"> -<li>com.gemstone.gemfire.CancelException</li> -</ul> -</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>java.io.Serializable</dd> -</dl> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../com/gemstone/gemfire/cache/CacheClosedException.html" title="class in com.gemstone.gemfire.cache">CacheClosedException</a>, <a href="../../../com/gemstone/gemfire/distributed/DistributedSystemDisconnectedException.html" title="class in com.gemstone.gemfire.distributed">DistributedSystemDisconnectedException</a>, <a href="../../../com/gemstone/gemfire/ForcedDisconnectException.html" title="class in com.gemstone.gemfire">ForcedDisconnectException</a>, <a href="../../../com/gemstone/gemfire/distributed/FutureCancelledException.html" title="class in com.gemstone.gemfire.distributed">FutureCancelledException</a>, <a href="../../../com/gemstone/gemfire/distributed/GatewayCancelledException.html" title="class in com.gemstone.gemfire.distributed">GatewayCancelledException</a>, <a href="../../../com/gemstone/gemfire/distributed/OplogCancelledException.html" title="class in com.gemstone.gemfire.distributed">OplogCancelledException</a>, <a href="../../../com/gemstone/gemf ire/OutOfOffHeapMemoryException.html" title="class in com.gemstone.gemfire">OutOfOffHeapMemoryException</a>, <a href="../../../com/gemstone/gemfire/distributed/PoolCancelledException.html" title="class in com.gemstone.gemfire.distributed">PoolCancelledException</a>, <a href="../../../com/gemstone/gemfire/ThreadInterruptedException.html" title="class in com.gemstone.gemfire">ThreadInterruptedException</a>, <a href="../../../com/gemstone/gemfire/distributed/TXManagerCancelledException.html" title="class in com.gemstone.gemfire.distributed">TXManagerCancelledException</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">CancelException</span> -extends <a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">CacheRuntimeException</a></pre> -<div class="block">Abstract root class of all GemFire exceptions representing system - cancellation</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>6.0</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../serialized-form.html#com.gemstone.gemfire.CancelException">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="memberSummary" 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><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelException.html#CancelException--">CancelException</a></span>()</code> -<div class="block">for serialization</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelException.html#CancelException-java.lang.String-">CancelException</a></span>(java.lang.String message)</code> -<div class="block">Create instance with given message</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelException.html#CancelException-java.lang.String-java.lang.Throwable-">CancelException</a></span>(java.lang.String message, - java.lang.Throwable cause)</code> -<div class="block">Create instance with given message and cause</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CancelException.html#CancelException-java.lang.Throwable-">CancelException</a></span>(java.lang.Throwable cause)</code> -<div class="block">Create instance with empty message and given cause</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.com.gemstone.gemfire.cache.CacheRuntimeException"> -<!-- --> -</a> -<h3>Methods inherited from class com.gemstone.gemfire.cache.<a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">CacheRuntimeException</a></h3> -<code><a href="../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#toString--">toString</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException"> -<!-- --> -</a> -<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> -<code><a href="../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Throwable</h3> -<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</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.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="CancelException--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CancelException</h4> -<pre>public CancelException()</pre> -<div class="block">for serialization</div> -</li> -</ul> -<a name="CancelException-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CancelException</h4> -<pre>public CancelException(java.lang.String message)</pre> -<div class="block">Create instance with given message</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>message</code> - the message</dd> -</dl> -</li> -</ul> -<a name="CancelException-java.lang.String-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CancelException</h4> -<pre>public CancelException(java.lang.String message, - java.lang.Throwable cause)</pre> -<div class="block">Create instance with given message and cause</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>message</code> - the message</dd> -<dd><code>cause</code> - the cause</dd> -</dl> -</li> -</ul> -<a name="CancelException-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>CancelException</h4> -<pre>public CancelException(java.lang.Throwable cause)</pre> -<div class="block">Create instance with empty message and given cause</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>cause</code> - the cause</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CancelCriterion.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/CanonicalInstantiator.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CancelException.html" target="_top">Frames</a></li> -<li><a href="CancelException.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.com.gemstone.gemfire.cache.CacheRuntimeException">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 ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/geode-site/blob/22311e92/releases/10M2/javadoc/com/gemstone/gemfire/CanonicalInstantiator.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/CanonicalInstantiator.html b/releases/10M2/javadoc/com/gemstone/gemfire/CanonicalInstantiator.html deleted file mode 100644 index f8d535e..0000000 --- a/releases/10M2/javadoc/com/gemstone/gemfire/CanonicalInstantiator.html +++ /dev/null @@ -1,364 +0,0 @@ -<!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 (1.8.0_66-internal) on Wed Apr 13 11:47:04 PDT 2016 --> -<title>CanonicalInstantiator (Apache Geode 1.0.0-incubating.M2)</title> -<meta name="date" content="2016-04-13"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CanonicalInstantiator (Apache Geode 1.0.0-incubating.M2)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/CopyException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CanonicalInstantiator.html" target="_top">Frames</a></li> -<li><a href="CanonicalInstantiator.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="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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">com.gemstone.gemfire</div> -<h2 title="Class CanonicalInstantiator" class="title">Class CanonicalInstantiator</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li><a href="../../../com/gemstone/gemfire/Instantiator.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.Instantiator</a></li> -<li> -<ul class="inheritance"> -<li>com.gemstone.gemfire.CanonicalInstantiator</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">CanonicalInstantiator</span> -extends <a href="../../../com/gemstone/gemfire/Instantiator.html" title="class in com.gemstone.gemfire">Instantiator</a></pre> -<div class="block"><code>CanonicalInstantiator</code> is much like its parent - <code>Instantiator</code> except that instead of - needing to implement <code>newInstance()</code> - you now must implement <code>newInstance(DataInput)</code>. - The addition of the <code>DataInput</code> parameter allows the instance - creator to optionally read data from the data input stream and use it to - decide the instance to create. This allows a value that represents a - canonical instance to be written by a class's <a href="../../../com/gemstone/gemfire/DataSerializer.html#toData-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.toData(java.lang.Object, java.io.DataOutput)</code></a> - and then be read by <code>newInstance(DataInput)</code> - and map it back to a canonical instance. - <p> - Note that <a href="../../../com/gemstone/gemfire/DataSerializer.html#fromData-java.io.DataInput-"><code>DataSerializer.fromData(java.io.DataInput)</code></a> is always called on the instance - returned from <code>newInstance(DataInput)</code>.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>5.1</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="memberSummary" 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><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CanonicalInstantiator.html#CanonicalInstantiator-java.lang.Class-int-">CanonicalInstantiator</a></span>(java.lang.Class<? extends <a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a>> c, - int classId)</code> -<div class="block">Creates a new <code>CanonicalInstantiator</code> that instantiates a given - class.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CanonicalInstantiator.html#newInstance--">newInstance</a></span>()</code> -<div class="block">This method is not supported and if called will - throw UnsupportedOperationException.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>abstract <a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CanonicalInstantiator.html#newInstance-java.io.DataInput-">newInstance</a></span>(java.io.DataInput in)</code> -<div class="block">Creates a new "empty" instance of a <Code>DataSerializable</code> - class whose state will be filled in by invoking its - <a href="../../../com/gemstone/gemfire/DataSerializable.html#fromData-java.io.DataInput-"><code>fromData</code></a> method.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.Instantiator"> -<!-- --> -</a> -<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../com/gemstone/gemfire/Instantiator.html" title="class in com.gemstone.gemfire">Instantiator</a></h3> -<code><a href="../../../com/gemstone/gemfire/Instantiator.html#getContext--">getContext</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#getEventId--">getEventId</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#getId--">getId</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#getInstantiatedClass--">getInstantiatedClass</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#register-com.gemstone.gemfire.Instantiator-">register</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#register-com.gemstone.gemfire.Instantiator-boolean-">register</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#setContext-java.lang.Object-">setContext</a>, <a href="../../../com/gemstone/gemfire/Instantiator.html#setEventId-java.lang.Object-">setEventId</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.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="CanonicalInstantiator-java.lang.Class-int-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>CanonicalInstantiator</h4> -<pre>public CanonicalInstantiator(java.lang.Class<? extends <a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a>> c, - int classId)</pre> -<div class="block">Creates a new <code>CanonicalInstantiator</code> that instantiates a given - class.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>c</code> - The <code>DataSerializable</code> class to register. This - class must have a static initializer that registers this - <code>Instantiator</code>.</dd> -<dd><code>classId</code> - A unique id for class <code>c</code>. The - <code>classId</code> must not be zero. - This has been an <code>int</code> since dsPhase1.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalArgumentException</code> - If <code>c</code> does not implement - <code>DataSerializable</code>, <code>classId</code> is - less than or equal to zero.</dd> -<dd><code>java.lang.NullPointerException</code> - If <code>c</code> is <code>null</code></dd> -</dl> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="newInstance--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newInstance</h4> -<pre>public final <a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a> newInstance()</pre> -<div class="block">This method is not supported and if called will - throw UnsupportedOperationException. - Use <a href="../../../com/gemstone/gemfire/CanonicalInstantiator.html#newInstance-java.io.DataInput-"><code>newInstance(DataInput)</code></a> instead.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../com/gemstone/gemfire/Instantiator.html#newInstance--">newInstance</a></code> in class <code><a href="../../../com/gemstone/gemfire/Instantiator.html" title="class in com.gemstone.gemfire">Instantiator</a></code></dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.UnsupportedOperationException</code> - in all cases</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/DataSerializer.html#readObject-java.io.DataInput-"><code>DataSerializer.readObject(java.io.DataInput)</code></a></dd> -</dl> -</li> -</ul> -<a name="newInstance-java.io.DataInput-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>newInstance</h4> -<pre>public abstract <a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a> newInstance(java.io.DataInput in) - throws java.io.IOException</pre> -<div class="block">Creates a new "empty" instance of a <Code>DataSerializable</code> - class whose state will be filled in by invoking its - <a href="../../../com/gemstone/gemfire/DataSerializable.html#fromData-java.io.DataInput-"><code>fromData</code></a> method.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>in</code> - the data input that can be read to decide what instance to create.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the new "empty" instance.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.io.IOException</code> - if a read from <code>in</code> fails.</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>5.1</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/CopyException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CanonicalInstantiator.html" target="_top">Frames</a></li> -<li><a href="CanonicalInstantiator.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="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/geode-site/blob/22311e92/releases/10M2/javadoc/com/gemstone/gemfire/CopyException.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/CopyException.html b/releases/10M2/javadoc/com/gemstone/gemfire/CopyException.html deleted file mode 100644 index a5d1d5f..0000000 --- a/releases/10M2/javadoc/com/gemstone/gemfire/CopyException.html +++ /dev/null @@ -1,346 +0,0 @@ -<!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 (1.8.0_66-internal) on Wed Apr 13 11:47:04 PDT 2016 --> -<title>CopyException (Apache Geode 1.0.0-incubating.M2)</title> -<meta name="date" content="2016-04-13"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CopyException (Apache Geode 1.0.0-incubating.M2)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CanonicalInstantiator.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/CopyHelper.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CopyException.html" target="_top">Frames</a></li> -<li><a href="CopyException.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.com.gemstone.gemfire.GemFireException">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">com.gemstone.gemfire</div> -<h2 title="Class CopyException" class="title">Class CopyException</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>java.lang.Throwable</li> -<li> -<ul class="inheritance"> -<li>java.lang.Exception</li> -<li> -<ul class="inheritance"> -<li>java.lang.RuntimeException</li> -<li> -<ul class="inheritance"> -<li><a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> -<li> -<ul class="inheritance"> -<li>com.gemstone.gemfire.CopyException</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>java.io.Serializable</dd> -</dl> -<hr> -<br> -<pre>public class <span class="typeNameLabel">CopyException</span> -extends <a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></pre> -<div class="block">Indicates a failure to copy an object.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>4.0</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/CopyHelper.html#copy-T-"><code>CopyHelper.copy(T)</code></a>, -<a href="../../../serialized-form.html#com.gemstone.gemfire.CopyException">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="memberSummary" 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><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyException.html#CopyException--">CopyException</a></span>()</code> -<div class="block">Constructs a new <code>CopyException</code>.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyException.html#CopyException-java.lang.String-">CopyException</a></span>(java.lang.String msg)</code> -<div class="block">Constructs a new <code>CopyException</code> with a message string.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyException.html#CopyException-java.lang.String-java.lang.Throwable-">CopyException</a></span>(java.lang.String msg, - java.lang.Throwable cause)</code> -<div class="block">Constructs a new <code>CopyException</code> with a message string - and a cause.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyException.html#CopyException-java.lang.Throwable-">CopyException</a></span>(java.lang.Throwable cause)</code> -<div class="block">Constructs a new <code>CopyException</code> with a cause.</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.com.gemstone.gemfire.GemFireException"> -<!-- --> -</a> -<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> -<code><a href="../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Throwable</h3> -<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="CopyException--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CopyException</h4> -<pre>public CopyException()</pre> -<div class="block">Constructs a new <code>CopyException</code>.</div> -</li> -</ul> -<a name="CopyException-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CopyException</h4> -<pre>public CopyException(java.lang.String msg)</pre> -<div class="block">Constructs a new <code>CopyException</code> with a message string.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>msg</code> - a message string</dd> -</dl> -</li> -</ul> -<a name="CopyException-java.lang.String-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CopyException</h4> -<pre>public CopyException(java.lang.String msg, - java.lang.Throwable cause)</pre> -<div class="block">Constructs a new <code>CopyException</code> with a message string - and a cause.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>msg</code> - the message string</dd> -<dd><code>cause</code> - a causal Throwable</dd> -</dl> -</li> -</ul> -<a name="CopyException-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>CopyException</h4> -<pre>public CopyException(java.lang.Throwable cause)</pre> -<div class="block">Constructs a new <code>CopyException</code> with a cause.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>cause</code> - a causal Throwable</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CanonicalInstantiator.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/CopyHelper.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CopyException.html" target="_top">Frames</a></li> -<li><a href="CopyException.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.com.gemstone.gemfire.GemFireException">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 ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/geode-site/blob/22311e92/releases/10M2/javadoc/com/gemstone/gemfire/CopyHelper.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/CopyHelper.html b/releases/10M2/javadoc/com/gemstone/gemfire/CopyHelper.html deleted file mode 100644 index b1b4778..0000000 --- a/releases/10M2/javadoc/com/gemstone/gemfire/CopyHelper.html +++ /dev/null @@ -1,372 +0,0 @@ -<!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 (1.8.0_66-internal) on Wed Apr 13 11:47:04 PDT 2016 --> -<title>CopyHelper (Apache Geode 1.0.0-incubating.M2)</title> -<meta name="date" content="2016-04-13"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CopyHelper (Apache Geode 1.0.0-incubating.M2)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":9,"i1":9,"i2":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CopyException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CopyHelper.html" target="_top">Frames</a></li> -<li><a href="CopyHelper.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">com.gemstone.gemfire</div> -<h2 title="Class CopyHelper" class="title">Class CopyHelper</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>com.gemstone.gemfire.CopyHelper</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public final class <span class="typeNameLabel">CopyHelper</span> -extends java.lang.Object</pre> -<div class="block">A static helper for optimally creating copies. Creating copies - of cache values provides improved concurrency as well as isolation. - For transactions, creating a copy is the guaranteed way to enforce - "Read Committed" isolation on changes to cache - <code>Entries</code>. - - <p>Here is a simple example of how to use <code>CopyHelper.copy</code> - <pre> - Object o = r.get("stringBuf"); - StringBuffer s = (StringBuffer) CopyHelper.copy(o); - s.append("... and they lived happily ever after. The End."); - r.put("stringBuf", s); - </pre></div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>4.0</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><code>Cloneable</code>, -<code>Serializable</code>, -<a href="../../../com/gemstone/gemfire/DataSerializer.html" title="class in com.gemstone.gemfire"><code>DataSerializer</code></a>, -<a href="../../../com/gemstone/gemfire/cache/GemFireCache.html#setCopyOnRead-boolean-"><code>GemFireCache.setCopyOnRead(boolean)</code></a>, -<a href="../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache"><code>CacheTransactionManager</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>static <T> T</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyHelper.html#copy-T-">copy</a></span>(T o)</code> -<div class="block">Makes a copy of the specified object.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>static <T> T</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyHelper.html#deepCopy-T-">deepCopy</a></span>(T o)</code> -<div class="block">Makes a deep copy of the specified object o using serialization, so the object - has to be serializable by GemFire.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>static boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/CopyHelper.html#isWellKnownImmutableInstance-java.lang.Object-">isWellKnownImmutableInstance</a></span>(java.lang.Object o)</code> -<div class="block">Return true if the given object is an instance of a well known - immutable class.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="isWellKnownImmutableInstance-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isWellKnownImmutableInstance</h4> -<pre>public static boolean isWellKnownImmutableInstance(java.lang.Object o)</pre> -<div class="block">Return true if the given object is an instance of a well known - immutable class. - The well known classes are: - <ul> - <li>String - <li>Byte - <li>Character - <li>Short - <li>Integer - <li>Long - <li>Float - <li>Double - <li>BigInteger - <li>BigDecimal - <li>UUID - <li>PdxInstance but not WritablePdxInstance - </ul></div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>o</code> - the object to check</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if o is an instance of a well known immutable class.</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>6.6.2</dd> -</dl> -</li> -</ul> -<a name="copy-java.lang.Object-"> -<!-- --> -</a><a name="copy-T-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>copy</h4> -<pre>public static <T> T copy(T o)</pre> -<div class="block"><p>Makes a copy of the specified object. The object returned is not guaranteed - to be a deep copy of the original object, as explained below. - - <p>Copies can only be made if the original is a <tt>Cloneable</tt> or serializable by - GemFire. - If o is a <a href="../../../com/gemstone/gemfire/CopyHelper.html#isWellKnownImmutableInstance-java.lang.Object-"><code>well known immutable instance</code></a> - then it will be returned without copying it. - - <p>If the argument o is an instance of <code>Cloneable</code>, a copy is - made by invoking <tt>clone</tt> on it. Note that not all implementations of <tt>clone</tt> - make deep copies (e.g. <code>HashMap.clone</code>). Otherwise, if the - argument is not an instance of <tt>Cloneable</tt>, a copy is made using serialization: if - GemFire serialization is implemented, it is used; otherwise, java serialization is used. - - <p> The difference between this method and <a href="../../../com/gemstone/gemfire/CopyHelper.html#deepCopy-T-"><code>deepCopy</code></a>, is that - this method uses <tt>clone</tt> if available, whereas <tt>deepCopy</tt> does not. As a - result, for <tt>Cloneable</tt> objects copied using this method, how deep a copy the - returned object is depends on its implementation of <tt>clone</tt>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>o</code> - the original object that a copy is needed of</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the new instance that is a copy of of the original</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../com/gemstone/gemfire/CopyException.html" title="class in com.gemstone.gemfire">CopyException</a></code> - if copying fails because a class could not - be found or could not be serialized.</dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>4.0</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/CopyHelper.html#deepCopy-T-"><code>deepCopy(Object)</code></a></dd> -</dl> -</li> -</ul> -<a name="deepCopy-java.lang.Object-"> -<!-- --> -</a><a name="deepCopy-T-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>deepCopy</h4> -<pre>public static <T> T deepCopy(T o)</pre> -<div class="block">Makes a deep copy of the specified object o using serialization, so the object - has to be serializable by GemFire. - - <p>If o is a <a href="../../../com/gemstone/gemfire/CopyHelper.html#isWellKnownImmutableInstance-java.lang.Object-"><code>well known immutable - instance</code></a> then it will be returned without copying it. - - <p>The passed in object is serialized in memory, and then deserialized into - a new instance, which is returned. If GemFire serialization is implemented - for the object, it is used; otherwise, java serialization is used.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>o</code> - the original object to be copied</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the new instance that is a copy of the original</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../com/gemstone/gemfire/CopyException.html" title="class in com.gemstone.gemfire">CopyException</a></code> - if copying fails because a class could not - be found or could not be serialized</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/CopyHelper.html#copy-T-"><code>copy(Object)</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> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/CopyException.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/CopyHelper.html" target="_top">Frames</a></li> -<li><a href="CopyHelper.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 ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/geode-site/blob/22311e92/releases/10M2/javadoc/com/gemstone/gemfire/DataSerializable.Replaceable.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/DataSerializable.Replaceable.html b/releases/10M2/javadoc/com/gemstone/gemfire/DataSerializable.Replaceable.html deleted file mode 100644 index cfd3683..0000000 --- a/releases/10M2/javadoc/com/gemstone/gemfire/DataSerializable.Replaceable.html +++ /dev/null @@ -1,248 +0,0 @@ -<!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 (1.8.0_66-internal) on Wed Apr 13 11:47:04 PDT 2016 --> -<title>DataSerializable.Replaceable (Apache Geode 1.0.0-incubating.M2)</title> -<meta name="date" content="2016-04-13"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="DataSerializable.Replaceable (Apache Geode 1.0.0-incubating.M2)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/DataSerializer.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/DataSerializable.Replaceable.html" target="_top">Frames</a></li> -<li><a href="DataSerializable.Replaceable.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">com.gemstone.gemfire</div> -<h2 title="Interface DataSerializable.Replaceable" class="title">Interface DataSerializable.Replaceable</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>Enclosing interface:</dt> -<dd><a href="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a></dd> -</dl> -<hr> -<br> -<pre>public static interface <span class="typeNameLabel">DataSerializable.Replaceable</span></pre> -<div class="block"><code>Replaceable</code> allows an object to write an alternative - version of itself to a <code>DataOutput</code>. It is similar to - the <code>writeReplace</code> method of standard Java - serialization. - - <P> - - Note that if a <code>Replaceable</code> is also - <code>DataSerializable</code>, its <code>toData</code> method - will <B>not</B> be invoked. Instead, its replacement object will - be written to the stream using <a href="../../../com/gemstone/gemfire/DataSerializer.html#writeObject-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.writeObject(Object, DataOutput)</code></a>.</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../com/gemstone/gemfire/DataSerializer.html#writeObject-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.writeObject(Object, DataOutput)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/gemstone/gemfire/DataSerializable.Replaceable.html#replace--">replace</a></span>()</code> -<div class="block">Replaces this object with another in the "output stream" - written by <a href="../../../com/gemstone/gemfire/DataSerializer.html#writeObject-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.writeObject(Object, DataOutput)</code></a>.</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="replace--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>replace</h4> -<pre>java.lang.Object replace() - throws java.io.IOException</pre> -<div class="block">Replaces this object with another in the "output stream" - written by <a href="../../../com/gemstone/gemfire/DataSerializer.html#writeObject-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.writeObject(Object, DataOutput)</code></a>.</div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.io.IOException</code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="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="../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../com/gemstone/gemfire/DataSerializer.html" title="class in com.gemstone.gemfire"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?com/gemstone/gemfire/DataSerializable.Replaceable.html" target="_top">Frames</a></li> -<li><a href="DataSerializable.Replaceable.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 ======= --> -</body> -</html>
