http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/GemFireException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/GemFireException.html b/releases/latest/javadoc/org/apache/geode/GemFireException.html new file mode 100644 index 0000000..516c01b --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/GemFireException.html @@ -0,0 +1,412 @@ +<!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>GemFireException (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="GemFireException (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/GemFireConfigException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/GemFireIOException.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/GemFireException.html" target="_top">Frames</a></li> +<li><a href="GemFireException.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">org.apache.geode</div> +<h2 title="Class GemFireException" class="title">Class GemFireException</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>org.apache.geode.GemFireException</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="../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a>, <a href="../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache">CacheRuntimeException</a>, <a href="../../../org/apache/geode/compression/CompressionException.html" title="class in org.apache.geode.compression">CompressionException</a>, <a href="../../../org/apache/geode/cache/persistence/ConflictingPersistentDataException.html" title="class in org.apache.geode.cache.persistence">ConflictingPersistentDataException</a>, <a href="../../../org/apache/geode/CopyException.html" title="class in org.apache.geode">CopyException</a>, <a href="../../../org/apache/geode/management/DependenciesNotFoundException.html" title="class in org.apache.geode.management">DependenciesNotFoundException</a>, <a href="../../../org/apache/geode/cache/DuplicatePrimaryPartitionException.html" title="class in org.apache.geode.cache">DuplicatePr imaryPartitionException</a>, <a href="../../../org/apache/geode/cache/EntryNotFoundInRegion.html" title="class in org.apache.geode.cache">EntryNotFoundInRegion</a>, <a href="../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a>, <a href="../../../org/apache/geode/GemFireCacheException.html" title="class in org.apache.geode">GemFireCacheException</a>, <a href="../../../org/apache/geode/GemFireConfigException.html" title="class in org.apache.geode">GemFireConfigException</a>, <a href="../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a>, <a href="../../../org/apache/geode/security/GemFireSecurityException.html" title="class in org.apache.geode.security">GemFireSecurityException</a>, <a href="../../../org/apache/geode/IncompatibleSystemException.html" title="class in org.apache.geode">IncompatibleSystemException</a>, <a href="../../../org/apache/geode/c ache/query/IndexInvalidException.html" title="class in org.apache.geode.cache.query">IndexInvalidException</a>, <a href="../../../org/apache/geode/InternalGemFireException.html" title="class in org.apache.geode">InternalGemFireException</a>, <a href="../../../org/apache/geode/InvalidDeltaException.html" title="class in org.apache.geode">InvalidDeltaException</a>, <a href="../../../org/apache/geode/InvalidValueException.html" title="class in org.apache.geode">InvalidValueException</a>, <a href="../../../org/apache/geode/InvalidVersionException.html" title="class in org.apache.geode">InvalidVersionException</a>, <a href="../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a>, <a href="../../../org/apache/geode/distributed/LeaseExpiredException.html" title="class in org.apache.geode.distributed">LeaseExpiredException</a>, <a href="../../../org/apache/geode/LicenseException.html" title="class in org.apache.geode">Licen seException</a>, <a href="../../../org/apache/geode/management/ManagementException.html" title="class in org.apache.geode.management">ManagementException</a>, <a href="../../../org/apache/geode/NoSystemException.html" title="class in org.apache.geode">NoSystemException</a>, <a href="../../../org/apache/geode/cache/partition/PartitionNotAvailableException.html" title="class in org.apache.geode.cache.partition">PartitionNotAvailableException</a>, <a href="../../../org/apache/geode/cache/persistence/PartitionOfflineException.html" title="class in org.apache.geode.cache.persistence">PartitionOfflineException</a>, <a href="../../../org/apache/geode/pdx/PdxConfigurationException.html" title="class in org.apache.geode.pdx">PdxConfigurationException</a>, <a href="../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a>, <a href="../../../org/apache/geode/pdx/PdxFieldDoesNotExistException.html" title="class in org.apache.geode.pdx">PdxFieldDoesNotExistException</a>, <a href="../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a>, <a href="../../../org/apache/geode/pdx/PdxInitializationException.html" title="class in org.apache.geode.pdx">PdxInitializationException</a>, <a href="../../../org/apache/geode/pdx/PdxRegistryMismatchException.html" title="class in org.apache.geode.pdx">PdxRegistryMismatchException</a>, <a href="../../../org/apache/geode/cache/persistence/PersistentReplicatesOfflineException.html" title="class in org.apache.geode.cache.persistence">PersistentReplicatesOfflineException</a>, <a href="../../../org/apache/geode/cache/query/QueryInvalidException.html" title="class in org.apache.geode.cache.query">QueryInvalidException</a>, <a href="../../../org/apache/geode/cache/persistence/RevokedPersistentDataException.html" title="class in org.apache.geode.cache.persistence">RevokedPersistentDataEx ception</a>, <a href="../../../org/apache/geode/cache/persistence/RevokeFailedException.html" title="class in org.apache.geode.cache.persistence">RevokeFailedException</a>, <a href="../../../org/apache/geode/admin/RuntimeAdminException.html" title="class in org.apache.geode.admin">RuntimeAdminException</a>, <a href="../../../org/apache/geode/cache/client/ServerConnectivityException.html" title="class in org.apache.geode.cache.client">ServerConnectivityException</a>, <a href="../../../org/apache/geode/SystemConnectException.html" title="class in org.apache.geode">SystemConnectException</a>, <a href="../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a>, <a href="../../../org/apache/geode/UnmodifiableException.html" title="class in org.apache.geode">UnmodifiableException</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">GemFireException</span> +extends java.lang.RuntimeException</pre> +<div class="block">This is the abstract superclass of exceptions that are thrown to + indicate incorrect usage of GemFire. + + Since these exceptions are unchecked, this class really + <em>ought</em> to be called <code>GemFireRuntimeException</code>; + however, the current name is retained for compatibility's sake.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/geode/GemFireCheckedException.html" title="class in org.apache.geode"><code>GemFireCheckedException</code></a>, +<a href="../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache"><code>CacheRuntimeException</code></a>, +<a href="../../../serialized-form.html#org.apache.geode.GemFireException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireException.html#serialVersionUID">serialVersionUID</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/GemFireException.html#GemFireException--">GemFireException</a></span>()</code> +<div class="block">Creates a new <code>GemFireException</code> with no detailed message.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireException.html#GemFireException-java.lang.String-">GemFireException</a></span>(java.lang.String message)</code> +<div class="block">Creates a new <code>GemFireException</code> with the given detail + message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireException.html#GemFireException-java.lang.String-java.lang.Throwable-">GemFireException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Creates a new <code>GemFireException</code> with the given detail + message and cause.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireException.html#GemFireException-java.lang.Throwable-">GemFireException</a></span>(java.lang.Throwable cause)</code> +<div class="block">Creates a new <code>GemFireException</code> with the given cause and + no detail message</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="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>java.lang.Throwable</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireException.html#getRootCause--">getRootCause</a></span>()</code> +<div class="block">Returns the root cause of this <code>GemFireException</code> or + <code>null</code> if the cause is nonexistent or unknown.</div> +</td> +</tr> +</table> +<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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="serialVersionUID"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>serialVersionUID</h4> +<pre>public static final long serialVersionUID</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.geode.GemFireException.serialVersionUID">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GemFireException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GemFireException</h4> +<pre>public GemFireException()</pre> +<div class="block">Creates a new <code>GemFireException</code> with no detailed message.</div> +</li> +</ul> +<a name="GemFireException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GemFireException</h4> +<pre>public GemFireException(java.lang.String message)</pre> +<div class="block">Creates a new <code>GemFireException</code> with the given detail + message.</div> +</li> +</ul> +<a name="GemFireException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GemFireException</h4> +<pre>public GemFireException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Creates a new <code>GemFireException</code> with the given detail + message and cause.</div> +</li> +</ul> +<a name="GemFireException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GemFireException</h4> +<pre>public GemFireException(java.lang.Throwable cause)</pre> +<div class="block">Creates a new <code>GemFireException</code> with the given cause and + no detail message</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getRootCause--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRootCause</h4> +<pre>public java.lang.Throwable getRootCause()</pre> +<div class="block">Returns the root cause of this <code>GemFireException</code> or + <code>null</code> if the cause is nonexistent or unknown.</div> +</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/GemFireConfigException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/GemFireIOException.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/GemFireException.html" target="_top">Frames</a></li> +<li><a href="GemFireException.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/GemFireIOException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/GemFireIOException.html b/releases/latest/javadoc/org/apache/geode/GemFireIOException.html new file mode 100644 index 0000000..5c64734 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/GemFireIOException.html @@ -0,0 +1,300 @@ +<!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>GemFireIOException (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="GemFireIOException (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/GemFireException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/GemFireRethrowable.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/GemFireIOException.html" target="_top">Frames</a></li> +<li><a href="GemFireIOException.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 GemFireIOException" class="title">Class GemFireIOException</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.GemFireIOException</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="../../../org/apache/geode/SerializationException.html" title="class in org.apache.geode">SerializationException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">GemFireIOException</span> +extends <a href="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></pre> +<div class="block">A <code>GemFireIOException</code> is thrown when a + GemFire operation failure is caused by an <code>IOException</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.apache.geode.GemFireIOException">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/GemFireIOException.html#GemFireIOException-java.lang.String-">GemFireIOException</a></span>(java.lang.String message)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireIOException.html#GemFireIOException-java.lang.String-java.lang.Throwable-">GemFireIOException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Creates a new <code>GemFireIOException</code>.</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="GemFireIOException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GemFireIOException</h4> +<pre>public GemFireIOException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Creates a new <code>GemFireIOException</code>.</div> +</li> +</ul> +<a name="GemFireIOException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GemFireIOException</h4> +<pre>public GemFireIOException(java.lang.String message)</pre> +</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/GemFireException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/GemFireRethrowable.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/GemFireIOException.html" target="_top">Frames</a></li> +<li><a href="GemFireIOException.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/GemFireRethrowable.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/GemFireRethrowable.html b/releases/latest/javadoc/org/apache/geode/GemFireRethrowable.html new file mode 100644 index 0000000..3df8add --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/GemFireRethrowable.html @@ -0,0 +1,291 @@ +<!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>GemFireRethrowable (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="GemFireRethrowable (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/GemFireIOException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/IncompatibleSystemException.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/GemFireRethrowable.html" target="_top">Frames</a></li> +<li><a href="GemFireRethrowable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.geode</div> +<h2 title="Class GemFireRethrowable" class="title">Class GemFireRethrowable</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.Error</li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.GemFireRethrowable</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">GemFireRethrowable</span> +extends java.lang.Error</pre> +<div class="block">This error is used by GemFire for internal purposes. + It does not indicate an error condition. + For this reason it is named "Rethrowable" instead of the standard "Error". + It was made an <code>Error</code> to make it easier for user code that typically would + catch <code>Exception</code> to not accidently catch this exception. + <p> Note: if user code catches this error (or its subclasses) then it <em>must</em> + be rethrown.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.apache.geode.GemFireRethrowable">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/GemFireRethrowable.html#GemFireRethrowable--">GemFireRethrowable</a></span>()</code> +<div class="block">Create a GemFireRethrowable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/GemFireRethrowable.html#GemFireRethrowable-java.lang.String-">GemFireRethrowable</a></span>(java.lang.String message)</code> +<div class="block">Create a GemFireRethrowable with the specified message.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.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="GemFireRethrowable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GemFireRethrowable</h4> +<pre>public GemFireRethrowable()</pre> +<div class="block">Create a GemFireRethrowable.</div> +</li> +</ul> +<a name="GemFireRethrowable-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GemFireRethrowable</h4> +<pre>public GemFireRethrowable(java.lang.String message)</pre> +<div class="block">Create a GemFireRethrowable with the specified message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</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/GemFireIOException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/IncompatibleSystemException.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/GemFireRethrowable.html" target="_top">Frames</a></li> +<li><a href="GemFireRethrowable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/IncompatibleSystemException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/IncompatibleSystemException.html b/releases/latest/javadoc/org/apache/geode/IncompatibleSystemException.html new file mode 100644 index 0000000..4b002a4 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/IncompatibleSystemException.html @@ -0,0 +1,286 @@ +<!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>IncompatibleSystemException (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="IncompatibleSystemException (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/GemFireRethrowable.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/Instantiator.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/IncompatibleSystemException.html" target="_top">Frames</a></li> +<li><a href="IncompatibleSystemException.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 IncompatibleSystemException" class="title">Class IncompatibleSystemException</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.IncompatibleSystemException</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">IncompatibleSystemException</span> +extends <a href="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></pre> +<div class="block">An <code>IncompatibleSystemException</code> is thrown when a + new GemFire process tries to connect to an + existing distributed system and its version is not the same as + that of the distributed system. In this case the new member is + not allowed to connect to the distributed system. + <p>As of GemFire 5.0 this exception should be named IncompatibleDistributedSystemException</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.apache.geode.IncompatibleSystemException">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/IncompatibleSystemException.html#IncompatibleSystemException-java.lang.String-">IncompatibleSystemException</a></span>(java.lang.String message)</code> +<div class="block">Creates a new <code>IncompatibleSystemException</code>.</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="IncompatibleSystemException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IncompatibleSystemException</h4> +<pre>public IncompatibleSystemException(java.lang.String message)</pre> +<div class="block">Creates a new <code>IncompatibleSystemException</code>.</div> +</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/GemFireRethrowable.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/Instantiator.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/IncompatibleSystemException.html" target="_top">Frames</a></li> +<li><a href="IncompatibleSystemException.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/Instantiator.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/Instantiator.html b/releases/latest/javadoc/org/apache/geode/Instantiator.html new file mode 100644 index 0000000..a304d23 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/Instantiator.html @@ -0,0 +1,600 @@ +<!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>Instantiator (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="Instantiator (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":6,"i5":9,"i6":41,"i7":10,"i8":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/IncompatibleSystemException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/InternalGemFireError.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/Instantiator.html" target="_top">Frames</a></li> +<li><a href="Instantiator.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">org.apache.geode</div> +<h2 title="Class Instantiator" class="title">Class Instantiator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.Instantiator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/apache/geode/CanonicalInstantiator.html" title="class in org.apache.geode">CanonicalInstantiator</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">Instantiator</span> +extends java.lang.Object</pre> +<div class="block"><code>Instantiator</code> allows classes that implement <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><code>DataSerializable</code></a> to be registered with the data serialization + framework. Knowledge of <code>DataSerializable</code> classes + allows the framework to optimize how instances of those classes are + data serialized. + + <P> + + Ordinarily, when a <code>DataSerializable</code> object is written + using <a href="../../../org/apache/geode/DataSerializer.html#writeObject-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.writeObject(Object, java.io.DataOutput)</code></a>, a special marker class id + is written to the stream followed by the class name of the + <code>DataSerializable</code> object. After the marker class id is + read by <a href="../../../org/apache/geode/DataSerializer.html#readObject-java.io.DataInput-"><code>DataSerializer.readObject(java.io.DataInput)</code></a> it performs the following + operations, + + <OL> + + <LI>The class name is read</LI> + + <LI>The class is loaded using <code>Class.forName(java.lang.String)</code></LI> + + <LI>An instance of the class is created using reflection</LI> + + <LI><a href="../../../org/apache/geode/DataSerializable.html#fromData-java.io.DataInput-"><code>DataSerializable.fromData(java.io.DataInput)</code></a> is invoked on the + newly-created object</LI> + + </OL> + + However, if a <code>DataSerializable</code> class is <a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-">registered</a> with the data serialization framework and + assigned a unique class id, an important optimization can be + performed that avoid the expense of using reflection to instantiate + the <code>DataSerializable</code> class. When the object is + written using <a href="../../../org/apache/geode/DataSerializer.html#writeObject-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.writeObject(Object, java.io.DataOutput)</code></a>, the object's + registered class id is written to the stream. Consequently, when + the data is read from the stream, the <a href="../../../org/apache/geode/Instantiator.html#newInstance--"><code>newInstance()</code></a> method + of the appropriate <code>Instantiator</code> instance is invoked to + create an "empty" instance of the <code>DataSerializable</code> + instead of using reflection to create the new instance. + + <P> + + Commonly, a <code>DataSerializable</code> class will register + itself with the <code>Instantiator</code> in a static initializer + as shown in the below example code. + + <!-- + The source code for the CompanySerializer class resides in + tests/com/examples/ds/User.java + Please keep the below code snippet in sync with that file. + --> + + <PRE> +public class User implements DataSerializable { + private String name; + private int userId; + + static { + Instantiator.register(new Instantiator(User.class, 45) { + public DataSerializable newInstance() { + return new User(); + } + }); + } + + public User(String name, int userId) { + this.name = name; + this.userId = userId; + } + + /** + Creates an "empty" User whose contents are filled in by + invoking its toData() method +/ + private User() { + + } + + public void toData(DataOutput out) throws IOException { + out.writeUTF(this.name); + out.writeInt(this.userId); + } + + public void fromData(DataInput in) + throws IOException, ClassNotFoundException { + this.name = in.readUTF(); + this.userId = in.readInt(); + } +} + </PRE> + + <code>Instantiator</code>s may be distributed to other members of + the distributed system when they are registered. Consider the + following scenario in which VM1 and VM2 are members of the same + distributed system. Both VMs define the sameRegion and VM2's + region replicates the contents of VM1's using replication. + VM1 puts an instance of the above <code>User</code> class into the + region. The act of instantiating <code>User</code> will load the + <code>User</code> class and invoke its static initializer, thus + registering the <code>Instantiator</code> with the data + serialization framework. Because the region is a replicate, the + <code>User</code> will be data serialized and sent to VM2. + However, when VM2 attempts to data deserialize the + <code>User</code>, its <code>Instantiator</code> will not + necessarily be registered because <code>User</code>'s static + initializer may not have been invoked yet. As a result, an + exception would be logged while deserializing the <code>User</code> + and the replicate would not appear to have the new value. So, in + order to ensure that the <code>Instantiator</code> is registered in + VM2, the data serialization framework distributes a message to each + member when an <code>Instantiator</code> is <a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-">registered</a>. <p>Note that the framework does not require that an + <code>Instantiator</code> be <code>Serializable</code>, but it + does require that it provide + a <a href="../../../org/apache/geode/Instantiator.html#Instantiator-java.lang.Class-int-">two-argument constructor</a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-"><code>register(Instantiator)</code></a>, +<a href="../../../org/apache/geode/Instantiator.html#newInstance--"><code>newInstance()</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="../../../org/apache/geode/Instantiator.html#Instantiator-java.lang.Class-int-">Instantiator</a></span>(java.lang.Class<? extends <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a>> c, + int classId)</code> +<div class="block">Creates a new <code>Instantiator</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/Instantiator.html#getContext--">getContext</a></span>()</code> +<div class="block">Returns the context of this + <code>Instantiator</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#getEventId--">getEventId</a></span>()</code> +<div class="block">Returns the unique <code>eventId</code> of this + <code>Instantiator</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#getId--">getId</a></span>()</code> +<div class="block">Returns the unique <code>id</code> of this + <code>Instantiator</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#getInstantiatedClass--">getInstantiatedClass</a></span>()</code> +<div class="block">Returns the <code>DataSerializable</code> class that is + instantiated by this <code>Instantiator</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#newInstance--">newInstance</a></span>()</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="../../../org/apache/geode/DataSerializable.html#fromData-java.io.DataInput-"><code>fromData</code></a> method.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-">register</a></span>(<a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode">Instantiator</a> instantiator)</code> +<div class="block">Registers a <code>DataSerializable</code> class with the data + serialization framework.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-boolean-">register</a></span>(<a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode">Instantiator</a> instantiator, + boolean distribute)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 9.0 use <a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-"><code>register(Instantiator)</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#setContext-java.lang.Object-">setContext</a></span>(java.lang.Object context)</code> +<div class="block">sets the context of this + <code>Instantiator</code>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/Instantiator.html#setEventId-java.lang.Object-">setEventId</a></span>(java.lang.Object eventId)</code> +<div class="block">sets the unique <code>eventId</code> of this + <code>Instantiator</code>.</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="Instantiator-java.lang.Class-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Instantiator</h4> +<pre>public Instantiator(java.lang.Class<? extends <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a>> c, + int classId)</pre> +<div class="block">Creates a new <code>Instantiator</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="register-org.apache.geode.Instantiator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>public static void register(<a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode">Instantiator</a> instantiator)</pre> +<div class="block">Registers a <code>DataSerializable</code> class with the data + serialization framework. This method is usually invoked from the + static initializer of a class that implements + <code>DataSerializable</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instantiator</code> - An <code>Instantiator</code> whose <a href="../../../org/apache/geode/Instantiator.html#newInstance--"><code>newInstance()</code></a> + method is invoked when an object is data deserialized.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - If class <code>c</code> is + already registered with a different class id, or another + class has already been registered with id + <code>classId</code></dd> +<dd><code>java.lang.NullPointerException</code> - If <code>instantiator</code> is <code>null</code>.</dd> +</dl> +</li> +</ul> +<a name="register-org.apache.geode.Instantiator-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>public static void register(<a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode">Instantiator</a> instantiator, + boolean distribute)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 9.0 use <a href="../../../org/apache/geode/Instantiator.html#register-org.apache.geode.Instantiator-"><code>register(Instantiator)</code></a> instead</span></div> +<div class="block">Registers a <code>DataSerializable</code> class with the data + serialization framework. This method is usually invoked from the + static initializer of a class that implements + <code>DataSerializable</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instantiator</code> - An <code>Instantiator</code> whose <a href="../../../org/apache/geode/Instantiator.html#newInstance--"><code>newInstance()</code></a> + method is invoked when an object is data deserialized.</dd> +<dd><code>distribute</code> - True if the registered <code>Instantiator</code> has to be + distributed to other members of the distributed system. + Note that if distribute is set to false it may still be distributed + in some cases.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - If class <code>c</code> is + already registered with a different class id, or another + class has already been registered with id + <code>classId</code></dd> +<dd><code>java.lang.NullPointerException</code> - If <code>instantiator</code> is <code>null</code>.</dd> +</dl> +</li> +</ul> +<a name="newInstance--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newInstance</h4> +<pre>public abstract <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a> newInstance()</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="../../../org/apache/geode/DataSerializable.html#fromData-java.io.DataInput-"><code>fromData</code></a> method.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/geode/DataSerializer.html#readObject-java.io.DataInput-"><code>DataSerializer.readObject(java.io.DataInput)</code></a></dd> +</dl> +</li> +</ul> +<a name="getInstantiatedClass--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstantiatedClass</h4> +<pre>public final java.lang.Class<? extends <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a>> getInstantiatedClass()</pre> +<div class="block">Returns the <code>DataSerializable</code> class that is + instantiated by this <code>Instantiator</code>.</div> +</li> +</ul> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public final int getId()</pre> +<div class="block">Returns the unique <code>id</code> of this + <code>Instantiator</code>.</div> +</li> +</ul> +<a name="setEventId-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEventId</h4> +<pre>public final void setEventId(java.lang.Object eventId)</pre> +<div class="block">sets the unique <code>eventId</code> of this + <code>Instantiator</code>. For internal use only.</div> +</li> +</ul> +<a name="getEventId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEventId</h4> +<pre>public final java.lang.Object getEventId()</pre> +<div class="block">Returns the unique <code>eventId</code> of this + <code>Instantiator</code>. For internal use only.</div> +</li> +</ul> +<a name="setContext-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContext</h4> +<pre>public final void setContext(java.lang.Object context)</pre> +<div class="block">sets the context of this + <code>Instantiator</code>. For internal use only.</div> +</li> +</ul> +<a name="getContext--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getContext</h4> +<pre>public final java.lang.Object getContext()</pre> +<div class="block">Returns the context of this + <code>Instantiator</code>. For internal use only.</div> +</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/IncompatibleSystemException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/InternalGemFireError.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/Instantiator.html" target="_top">Frames</a></li> +<li><a href="Instantiator.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>