http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/CopyException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/CopyException.html b/releases/latest/javadoc/org/apache/geode/CopyException.html new file mode 100644 index 0000000..360ea7f --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/CopyException.html @@ -0,0 +1,346 @@ +<!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_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>CopyException (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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 (incubating) 1.0.0-incubating)"; + } + } + 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="../../../org/apache/geode/CanonicalInstantiator.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/CopyHelper.html" title="class in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/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.org.apache.geode.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">org.apache.geode</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="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">org.apache.geode.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.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="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></pre> +<div class="block">Indicates a failure to copy an object.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/geode/CopyHelper.html#copy-T-"><code>CopyHelper.copy(T)</code></a>, +<a href="../../../serialized-form.html#org.apache.geode.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="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/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.org.apache.geode.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.geode.<a href="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></h3> +<code><a href="../../../org/apache/geode/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="../../../org/apache/geode/CanonicalInstantiator.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/CopyHelper.html" title="class in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/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.org.apache.geode.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/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/CopyHelper.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/CopyHelper.html b/releases/latest/javadoc/org/apache/geode/CopyHelper.html new file mode 100644 index 0000000..6d76cf8 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/CopyHelper.html @@ -0,0 +1,372 @@ +<!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_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>CopyHelper (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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 (incubating) 1.0.0-incubating)"; + } + } + 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="../../../org/apache/geode/CopyException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/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">org.apache.geode</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>org.apache.geode.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>GemFire 4.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Cloneable</code>, +<code>Serializable</code>, +<a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><code>DataSerializer</code></a>, +<a href="../../../org/apache/geode/cache/GemFireCache.html#setCopyOnRead-boolean-"><code>GemFireCache.setCopyOnRead(boolean)</code></a>, +<a href="../../../org/apache/geode/cache/CacheTransactionManager.html" title="interface in org.apache.geode.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="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/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>GemFire 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="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/CopyException.html" title="class in org.apache.geode">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>GemFire 4.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/CopyException.html" title="class in org.apache.geode">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="../../../org/apache/geode/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="../../../org/apache/geode/CopyException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/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/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/DataSerializable.Replaceable.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/DataSerializable.Replaceable.html b/releases/latest/javadoc/org/apache/geode/DataSerializable.Replaceable.html new file mode 100644 index 0000000..4484751 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/DataSerializable.Replaceable.html @@ -0,0 +1,248 @@ +<!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_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>DataSerializable.Replaceable (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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 (incubating) 1.0.0-incubating)"; + } + } + 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="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/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">org.apache.geode</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="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">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="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/DataSerializable.Replaceable.html#replace--">replace</a></span>()</code> +<div class="block">Replaces this object with another in the "output stream" + written by <a href="../../../org/apache/geode/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="../../../org/apache/geode/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="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/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> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/DataSerializable.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/DataSerializable.html b/releases/latest/javadoc/org/apache/geode/DataSerializable.html new file mode 100644 index 0000000..549665f --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/DataSerializable.html @@ -0,0 +1,357 @@ +<!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_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>DataSerializable (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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 (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":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="../../../org/apache/geode/CopyHelper.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/DataSerializable.Replaceable.html" title="interface in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/DataSerializable.html" target="_top">Frames</a></li> +<li><a href="DataSerializable.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.geode</div> +<h2 title="Interface DataSerializable" class="title">Interface DataSerializable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../org/apache/geode/cache/query/types/CollectionType.html" title="interface in org.apache.geode.cache.query.types">CollectionType</a>, <a href="../../../org/apache/geode/cache/query/types/MapType.html" title="interface in org.apache.geode.cache.query.types">MapType</a>, <a href="../../../org/apache/geode/cache/query/types/ObjectType.html" title="interface in org.apache.geode.cache.query.types">ObjectType</a>, <a href="../../../org/apache/geode/cache/persistence/PersistentID.html" title="interface in org.apache.geode.cache.persistence">PersistentID</a>, <a href="../../../org/apache/geode/cache/query/types/StructType.html" title="interface in org.apache.geode.cache.query.types">StructType</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/geode/modules/gatewaydelta/AbstractGatewayDeltaEvent.html" title="class in org.apache.geode.modules.gatewaydelta">AbstractGatewayDeltaEvent</a>, <a href="../../../org/apache/geode/modules/session/catalina/DeltaSession.html" title="class in org.apache.geode.modules.session.catalina">DeltaSession</a>, <a href="../../../org/apache/geode/modules/session/catalina/DeltaSession7.html" title="class in org.apache.geode.modules.session.catalina">DeltaSession7</a>, <a href="../../../org/apache/geode/modules/session/catalina/DeltaSession8.html" title="class in org.apache.geode.modules.session.catalina">DeltaSession8</a>, <a href="../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache">EvictionAttributes</a>, <a href="../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a>, <a href="../../../org/apache/geode/modules/gatewaydelta/GatewayDeltaCreateEvent.htm l" title="class in org.apache.geode.modules.gatewaydelta">GatewayDeltaCreateEvent</a>, <a href="../../../org/apache/geode/modules/gatewaydelta/GatewayDeltaDestroyEvent.html" title="class in org.apache.geode.modules.gatewaydelta">GatewayDeltaDestroyEvent</a>, <a href="../../../org/apache/geode/cache/MembershipAttributes.html" title="class in org.apache.geode.cache">MembershipAttributes</a>, <a href="../../../org/apache/geode/modules/util/RegionConfiguration.html" title="class in org.apache.geode.modules.util">RegionConfiguration</a>, <a href="../../../org/apache/geode/admin/RegionSubRegionSnapshot.html" title="class in org.apache.geode.admin">RegionSubRegionSnapshot</a>, <a href="../../../org/apache/geode/cache/server/ServerLoad.html" title="class in org.apache.geode.cache.server">ServerLoad</a>, <a href="../../../org/apache/geode/cache/SubscriptionAttributes.html" title="class in org.apache.geode.cache">SubscriptionAttributes</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DataSerializable</span> +extends java.io.Serializable</pre> +<div class="block">An interface for objects whose state can be written/read as + primitive types and strings ("data"). That is, instead of + serializing itself to an <code>ObjectOutputStream</code>, a + <code>DataSerializable</code> can serialize itself to a <code>DataOutput</code>. By implementing this interface, objects can be + serialized faster and in a more compact format than standard Java + serialization. The <a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><code>DataSerializer</code></a> class contains a number + of static methods that may be helpful to implementations of + <code>DataSerializable</code>. + + <P> + + When possible, GemFire respects the <code>DataSerializable</code> + contract to provide optimal object serialization. For instance, if + a <code>DataSerializable</code> object is + <a href="../../../org/apache/geode/cache/Region.html#put-K-V-">placed</a> into a distributed + cache region, its <code>toData</code> method will be used to + serialize it when it is sent to another member of the distributed + system. + + <P> + + To avoid the overhead of Java reflection, + <code>DataSerializable</code> classes may register an <a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode"><code>Instantiator</code></a> to be used during deserialization. Alternatively, + classes that implement <code>DataSerializable</code> can provide a + zero-argument constructor that will be invoked when they are read + with <a href="../../../org/apache/geode/DataSerializer.html#readObject-java.io.DataInput-"><code>DataSerializer.readObject(java.io.DataInput)</code></a>. + + <P> + + Some classes (especially third-party classes that you may not have + the source code to) cannot be modified to implement + <code>DataSerializable</code>. These classes can be data + serialized by an instance of <a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><code>DataSerializer</code></a>. + + <P> + + <code>DataSerializable</code> offers improved performance over + standard Java serialization, but does not offer all of the features + of standard Java serialization. In particular, data serialization + does not attempt to maintain referential integrity among the + objects it is writing or reading. As a result, data serialization + should not be used with complex object graphs. Attempting to data + serialize graphs that contain object cycles will result in infinite + recursion and a <code>StackOverflowError</code>. Attempting to + deserialize an object graph that contains multiple reference + paths to the same object will result in multiple copies of the + objects that are referred to through multiple paths. + + <P> + + <CENTER> + <IMG src="../../../javadoc-images/data-serialization-exceptions.gif" + HEIGHT="219" WIDTH="698"> + </CENTER></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Serializable</code>, +<a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><code>DataSerializer</code></a>, +<a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode"><code>Instantiator</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/DataSerializable.Replaceable.html" title="interface in org.apache.geode">DataSerializable.Replaceable</a></span></code> +<div class="block"><code>Replaceable</code> allows an object to write an alternative + version of itself to a <code>DataOutput</code>.</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></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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/DataSerializable.html#fromData-java.io.DataInput-">fromData</a></span>(java.io.DataInput in)</code> +<div class="block">Reads the state of this object as primitive data from the given + <code>DataInput</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/DataSerializable.html#toData-java.io.DataOutput-">toData</a></span>(java.io.DataOutput out)</code> +<div class="block">Writes the state of this object as primitive data to the given + <code>DataOutput</code>.</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="toData-java.io.DataOutput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toData</h4> +<pre>void toData(java.io.DataOutput out) + throws java.io.IOException</pre> +<div class="block">Writes the state of this object as primitive data to the given + <code>DataOutput</code>. + <p> + Since 5.7 it is possible for any method call to the specified + <code>DataOutput</code> to throw <a href="../../../org/apache/geode/GemFireRethrowable.html" title="class in org.apache.geode"><code>GemFireRethrowable</code></a>. + It should <em>not</em> be caught by user code. + If it is it <em>must</em> be rethrown.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - A problem occurs while writing to <code>out</code></dd> +</dl> +</li> +</ul> +<a name="fromData-java.io.DataInput-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fromData</h4> +<pre>void fromData(java.io.DataInput in) + throws java.io.IOException, + java.lang.ClassNotFoundException</pre> +<div class="block">Reads the state of this object as primitive data from the given + <code>DataInput</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - A problem occurs while reading from <code>in</code></dd> +<dd><code>java.lang.ClassNotFoundException</code> - A class could not be loaded while reading from + <code>in</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="../../../org/apache/geode/CopyHelper.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/DataSerializable.Replaceable.html" title="interface in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/geode/DataSerializable.html" target="_top">Frames</a></li> +<li><a href="DataSerializable.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><a href="#nested.class.summary">Nested</a> | </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>
