http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/LogWriter.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/LogWriter.html b/releases/latest/javadoc/org/apache/geode/LogWriter.html new file mode 100644 index 0000000..be3a940 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/LogWriter.html @@ -0,0 +1,955 @@ +<!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>LogWriter (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="LogWriter (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":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/LicenseException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/NoSystemException.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/LogWriter.html" target="_top">Frames</a></li> +<li><a href="LogWriter.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 LogWriter" class="title">Interface LogWriter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">LogWriter</span></pre> +<div class="block">Defines methods available to clients that want to write a log message + to their GemFire distributed system log file. + <p> + Instances of this interface can be obtained by calling + <a href="../../../org/apache/geode/distributed/DistributedSystem.html#getLogWriter--"><code>DistributedSystem.getLogWriter()</code></a>. + <p> + For any logged message the log file will contain: + <ul> + <li> The message's level. + <li> The time the message was logged. + <li> The id of the thread that logged the message. + <li> The message itself which can be a string and/or an exception + including the exception's stack trace. + </ul> + <p> + A message always has a level. + Logging levels are ordered. Enabling logging at a given level also + enables logging at higher levels. The higher the level the more + important and urgent the message. + <p> + The levels, in descending order, are: + <ul> + <li> <code>severe</code> (highest value) is a message level indicating a serious failure. + In general <code>severe</code> messages should describe events that + are of considerable importance and which will prevent normal program + execution. They should be reasonably intelligible to end users and + to information managers. + <li> <code>error</code> + In general <code>error</code> messages should describe events that + are of considerable importance but will not prevent normal program + execution. They should be reasonably intelligible to end users and + to information managers. They are weaker than <code>severe</code> and + stronger than <code>warning</code>. + <li> <code>warning</code> is a message level indicating a potential problem. + In general <code>warning</code> messages should describe events that + will be of interest to end users or information managers, or which indicate + potential problems. + <li> <code>info</code> is a message level for informational messages. + Typically <code>info</code> messages should be reasonably significant + and should make sense to end users and system administrators. + <li> <code>config</code> is a message level for static configuration messages. + <code>config</code> messages are intended to provide a variety of static + configuration information, to assist in debugging problems that may be + associated with particular configurations. + <li> <code>fine</code> is a message level providing tracing information. + In general the <code>fine</code> level should be used for information + that will be broadly interesting to developers. This level is for + the lowest volume, and most important, tracing messages. + <li> <code>finer</code> indicates a fairly detailed tracing message. + Logging calls for entering, returning, or throwing an exception + are traced at the <code>finer</code> level. + <li> <code>finest</code> (lowest value) indicates a highly detailed tracing message. + In general the <code>finest</code> level should be used for the most + voluminous detailed tracing messages. + </ul> + <p> + For each level methods exist that will request a message, at that + level, to be logged. These methods are all named after their level. + <p> + For each level a method exists that returns a boolean indicating + if messages at that level will currently be logged. The names + of these methods are of the form: <em>level</em><code>Enabled</code>.</div> +</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#config-java.lang.String-">config</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</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/LogWriter.html#config-java.lang.String-java.lang.Throwable-">config</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#config-java.lang.Throwable-">config</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#configEnabled--">configEnabled</a></span>()</code> +<div class="block">Returns true if "config" log messages are enabled.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/i18n/LogWriterI18n.html" title="interface in org.apache.geode.i18n">LogWriterI18n</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#convertToLogWriterI18n--">convertToLogWriterI18n</a></span>()</code> +<div class="block">A mechanism for accessing the abstraction layer used for + internationalization.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#entering-java.lang.String-java.lang.String-">entering</a></span>(java.lang.String sourceClass, + java.lang.String sourceMethod)</code> +<div class="block">Log a method entry.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#error-java.lang.String-">error</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</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/LogWriter.html#error-java.lang.String-java.lang.Throwable-">error</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</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/LogWriter.html#error-java.lang.Throwable-">error</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#errorEnabled--">errorEnabled</a></span>()</code> +<div class="block">Returns true if "error" log messages are enabled.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#exiting-java.lang.String-java.lang.String-">exiting</a></span>(java.lang.String sourceClass, + java.lang.String sourceMethod)</code> +<div class="block">Log a method return.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#fine-java.lang.String-">fine</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#fine-java.lang.String-java.lang.Throwable-">fine</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#fine-java.lang.Throwable-">fine</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#fineEnabled--">fineEnabled</a></span>()</code> +<div class="block">Returns true if "fine" log messages are enabled.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finer-java.lang.String-">finer</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finer-java.lang.String-java.lang.Throwable-">finer</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finer-java.lang.Throwable-">finer</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finerEnabled--">finerEnabled</a></span>()</code> +<div class="block">Returns true if "finer" log messages are enabled.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finest-java.lang.String-">finest</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finest-java.lang.String-java.lang.Throwable-">finest</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finest-java.lang.Throwable-">finest</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#finestEnabled--">finestEnabled</a></span>()</code> +<div class="block">Returns true if "finest" log messages are enabled.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>java.util.logging.Handler</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#getHandler--">getHandler</a></span>()</code> +<div class="block">Returns a 1.4 logging handler that can be used to direct application + output to this GemFire logger using the standard JDK logger APIs.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#info-java.lang.String-">info</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#info-java.lang.String-java.lang.Throwable-">info</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#info-java.lang.Throwable-">info</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#infoEnabled--">infoEnabled</a></span>()</code> +<div class="block">Returns true if "info" log messages are enabled.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#severe-java.lang.String-">severe</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#severe-java.lang.String-java.lang.Throwable-">severe</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#severe-java.lang.Throwable-">severe</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#severeEnabled--">severeEnabled</a></span>()</code> +<div class="block">Returns true if "severe" log messages are enabled.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#throwing-java.lang.String-java.lang.String-java.lang.Throwable-">throwing</a></span>(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.Throwable thrown)</code> +<div class="block">Log throwing an exception.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#warning-java.lang.String-">warning</a></span>(java.lang.String msg)</code> +<div class="block">Writes a message to this writer.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#warning-java.lang.String-java.lang.Throwable-">warning</a></span>(java.lang.String msg, + java.lang.Throwable ex)</code> +<div class="block">Writes both a message and exception to this writer.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#warning-java.lang.Throwable-">warning</a></span>(java.lang.Throwable ex)</code> +<div class="block">Writes an exception to this writer.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/LogWriter.html#warningEnabled--">warningEnabled</a></span>()</code> +<div class="block">Returns true if "warning" log messages are enabled.</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="severeEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>severeEnabled</h4> +<pre>boolean severeEnabled()</pre> +<div class="block">Returns true if "severe" log messages are enabled. + Returns false if "severe" log messages are disabled.</div> +</li> +</ul> +<a name="severe-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>severe</h4> +<pre>void severe(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "severe".</div> +</li> +</ul> +<a name="severe-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>severe</h4> +<pre>void severe(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "severe".</div> +</li> +</ul> +<a name="severe-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>severe</h4> +<pre>void severe(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "severe".</div> +</li> +</ul> +<a name="errorEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>errorEnabled</h4> +<pre>boolean errorEnabled()</pre> +<div class="block">Returns true if "error" log messages are enabled. + Returns false if "error" log messages are disabled.</div> +</li> +</ul> +<a name="error-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>error</h4> +<pre>void error(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "error".</div> +</li> +</ul> +<a name="error-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>error</h4> +<pre>void error(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "error".</div> +</li> +</ul> +<a name="error-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>error</h4> +<pre>void error(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "error".</div> +</li> +</ul> +<a name="warningEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warningEnabled</h4> +<pre>boolean warningEnabled()</pre> +<div class="block">Returns true if "warning" log messages are enabled. + Returns false if "warning" log messages are disabled.</div> +</li> +</ul> +<a name="warning-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warning</h4> +<pre>void warning(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "warning".</div> +</li> +</ul> +<a name="warning-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warning</h4> +<pre>void warning(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "warning".</div> +</li> +</ul> +<a name="warning-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warning</h4> +<pre>void warning(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "warning".</div> +</li> +</ul> +<a name="infoEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>infoEnabled</h4> +<pre>boolean infoEnabled()</pre> +<div class="block">Returns true if "info" log messages are enabled. + Returns false if "info" log messages are disabled.</div> +</li> +</ul> +<a name="info-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>info</h4> +<pre>void info(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "information".</div> +</li> +</ul> +<a name="info-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>info</h4> +<pre>void info(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "information".</div> +</li> +</ul> +<a name="info-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>info</h4> +<pre>void info(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "information".</div> +</li> +</ul> +<a name="configEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>configEnabled</h4> +<pre>boolean configEnabled()</pre> +<div class="block">Returns true if "config" log messages are enabled. + Returns false if "config" log messages are disabled.</div> +</li> +</ul> +<a name="config-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>config</h4> +<pre>void config(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "config".</div> +</li> +</ul> +<a name="config-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>config</h4> +<pre>void config(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "config".</div> +</li> +</ul> +<a name="config-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>config</h4> +<pre>void config(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "config".</div> +</li> +</ul> +<a name="fineEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fineEnabled</h4> +<pre>boolean fineEnabled()</pre> +<div class="block">Returns true if "fine" log messages are enabled. + Returns false if "fine" log messages are disabled.</div> +</li> +</ul> +<a name="fine-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fine</h4> +<pre>void fine(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "fine".</div> +</li> +</ul> +<a name="fine-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fine</h4> +<pre>void fine(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "fine".</div> +</li> +</ul> +<a name="fine-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fine</h4> +<pre>void fine(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "fine".</div> +</li> +</ul> +<a name="finerEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finerEnabled</h4> +<pre>boolean finerEnabled()</pre> +<div class="block">Returns true if "finer" log messages are enabled. + Returns false if "finer" log messages are disabled.</div> +</li> +</ul> +<a name="finer-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finer</h4> +<pre>void finer(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "finer".</div> +</li> +</ul> +<a name="finer-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finer</h4> +<pre>void finer(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "finer".</div> +</li> +</ul> +<a name="finer-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finer</h4> +<pre>void finer(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "finer".</div> +</li> +</ul> +<a name="entering-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entering</h4> +<pre>void entering(java.lang.String sourceClass, + java.lang.String sourceMethod)</pre> +<div class="block">Log a method entry. + <p>The logging is done using the <code>finer</code> level. + The string message will start with <code>"ENTRY"</code> and + include the class and method names.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sourceClass</code> - Name of class that issued the logging request.</dd> +<dd><code>sourceMethod</code> - Name of the method that issued the logging request.</dd> +</dl> +</li> +</ul> +<a name="exiting-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exiting</h4> +<pre>void exiting(java.lang.String sourceClass, + java.lang.String sourceMethod)</pre> +<div class="block">Log a method return. + <p>The logging is done using the <code>finer</code> level. + The string message will start with <code>"RETURN"</code> and + include the class and method names.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sourceClass</code> - Name of class that issued the logging request.</dd> +<dd><code>sourceMethod</code> - Name of the method that issued the logging request.</dd> +</dl> +</li> +</ul> +<a name="throwing-java.lang.String-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>throwing</h4> +<pre>void throwing(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.Throwable thrown)</pre> +<div class="block">Log throwing an exception. + <p> Use to log that a method is + terminating by throwing an exception. The logging is done using + the <code>finer</code> level. + <p> This is a convenience method that could be done + instead by calling <a href="../../../org/apache/geode/LogWriter.html#finer-java.lang.String-java.lang.Throwable-"><code>finer(String, Throwable)</code></a>. + The string message will start with <code>"THROW"</code> and + include the class and method names.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sourceClass</code> - Name of class that issued the logging request.</dd> +<dd><code>sourceMethod</code> - Name of the method that issued the logging request.</dd> +<dd><code>thrown</code> - The Throwable that is being thrown.</dd> +</dl> +</li> +</ul> +<a name="finestEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finestEnabled</h4> +<pre>boolean finestEnabled()</pre> +<div class="block">Returns true if "finest" log messages are enabled. + Returns false if "finest" log messages are disabled.</div> +</li> +</ul> +<a name="finest-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finest</h4> +<pre>void finest(java.lang.String msg, + java.lang.Throwable ex)</pre> +<div class="block">Writes both a message and exception to this writer. + The message level is "finest".</div> +</li> +</ul> +<a name="finest-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finest</h4> +<pre>void finest(java.lang.String msg)</pre> +<div class="block">Writes a message to this writer. + The message level is "finest".</div> +</li> +</ul> +<a name="finest-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finest</h4> +<pre>void finest(java.lang.Throwable ex)</pre> +<div class="block">Writes an exception to this writer. + The exception level is "finest".</div> +</li> +</ul> +<a name="getHandler--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandler</h4> +<pre>java.util.logging.Handler getHandler()</pre> +<div class="block">Returns a 1.4 logging handler that can be used to direct application + output to this GemFire logger using the standard JDK logger APIs. + Each time this method is called it creates a new instance of a + Handler so care should be taken to not call this method too often.</div> +</li> +</ul> +<a name="convertToLogWriterI18n--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>convertToLogWriterI18n</h4> +<pre><a href="../../../org/apache/geode/i18n/LogWriterI18n.html" title="interface in org.apache.geode.i18n">LogWriterI18n</a> convertToLogWriterI18n()</pre> +<div class="block">A mechanism for accessing the abstraction layer used for + internationalization.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>LogWriterI18n</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/LicenseException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/NoSystemException.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/LogWriter.html" target="_top">Frames</a></li> +<li><a href="LogWriter.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/NoSystemException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/NoSystemException.html b/releases/latest/javadoc/org/apache/geode/NoSystemException.html new file mode 100644 index 0000000..12bbdf8 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/NoSystemException.html @@ -0,0 +1,312 @@ +<!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>NoSystemException (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="NoSystemException (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/LogWriter.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/OutOfOffHeapMemoryException.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/NoSystemException.html" target="_top">Frames</a></li> +<li><a href="NoSystemException.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 NoSystemException" class="title">Class NoSystemException</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.NoSystemException</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/UncreatedSystemException.html" title="class in org.apache.geode">UncreatedSystemException</a>, <a href="../../../org/apache/geode/UnstartedSystemException.html" title="class in org.apache.geode">UnstartedSystemException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">NoSystemException</span> +extends <a href="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></pre> +<div class="block">A <code>NoSystemException</code> is thrown when a + locator can not be found or connected to. + In most cases one of the following subclasses is used instead + of <code>NoSystemException</code>: + <ul> + <li> <a href="../../../org/apache/geode/UncreatedSystemException.html" title="class in org.apache.geode"><code>UncreatedSystemException</code></a> + <li> <a href="../../../org/apache/geode/UnstartedSystemException.html" title="class in org.apache.geode"><code>UnstartedSystemException</code></a> + </ul> + <p>As of GemFire 5.0 this exception should be named NoLocatorException.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.apache.geode.NoSystemException">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/NoSystemException.html#NoSystemException-java.lang.String-">NoSystemException</a></span>(java.lang.String message)</code> +<div class="block">Creates a new <code>NoSystemException</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/NoSystemException.html#NoSystemException-java.lang.String-java.lang.Throwable-">NoSystemException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Creates a new <code>NoSystemException</code> with the given message + and 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="NoSystemException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NoSystemException</h4> +<pre>public NoSystemException(java.lang.String message)</pre> +<div class="block">Creates a new <code>NoSystemException</code>.</div> +</li> +</ul> +<a name="NoSystemException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NoSystemException</h4> +<pre>public NoSystemException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Creates a new <code>NoSystemException</code> with the given message + and cause.</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/LogWriter.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/OutOfOffHeapMemoryException.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/NoSystemException.html" target="_top">Frames</a></li> +<li><a href="NoSystemException.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/OutOfOffHeapMemoryException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/OutOfOffHeapMemoryException.html b/releases/latest/javadoc/org/apache/geode/OutOfOffHeapMemoryException.html new file mode 100644 index 0000000..60153d4 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/OutOfOffHeapMemoryException.html @@ -0,0 +1,321 @@ +<!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>OutOfOffHeapMemoryException (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="OutOfOffHeapMemoryException (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/NoSystemException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/SerializationException.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/OutOfOffHeapMemoryException.html" target="_top">Frames</a></li> +<li><a href="OutOfOffHeapMemoryException.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.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.geode</div> +<h2 title="Class OutOfOffHeapMemoryException" class="title">Class OutOfOffHeapMemoryException</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><a href="../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache">org.apache.geode.cache.CacheRuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode">org.apache.geode.CancelException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.OutOfOffHeapMemoryException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">OutOfOffHeapMemoryException</span> +extends <a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode">CancelException</a></pre> +<div class="block">Indicates that attempts to allocate more objects in off-heap memory has + failed and the Cache will be closed to prevent it from losing distributed + consistency.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.apache.geode.OutOfOffHeapMemoryException">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/OutOfOffHeapMemoryException.html#OutOfOffHeapMemoryException--">OutOfOffHeapMemoryException</a></span>()</code> +<div class="block">Constructs an <code>OutOfOffHeapMemoryError</code> with no detail message.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/OutOfOffHeapMemoryException.html#OutOfOffHeapMemoryException-java.lang.String-">OutOfOffHeapMemoryException</a></span>(java.lang.String message)</code> +<div class="block">Constructs an <code>OutOfOffHeapMemoryError</code> with the specified + 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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.CacheRuntimeException"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.geode.cache.<a href="../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache">CacheRuntimeException</a></h3> +<code><a href="../../../org/apache/geode/cache/CacheRuntimeException.html#toString--">toString</a></code></li> +</ul> +<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</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="OutOfOffHeapMemoryException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutOfOffHeapMemoryException</h4> +<pre>public OutOfOffHeapMemoryException()</pre> +<div class="block">Constructs an <code>OutOfOffHeapMemoryError</code> with no detail message.</div> +</li> +</ul> +<a name="OutOfOffHeapMemoryException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OutOfOffHeapMemoryException</h4> +<pre>public OutOfOffHeapMemoryException(java.lang.String message)</pre> +<div class="block">Constructs an <code>OutOfOffHeapMemoryError</code> with the specified + detail message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the detail message.</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/NoSystemException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/SerializationException.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/OutOfOffHeapMemoryException.html" target="_top">Frames</a></li> +<li><a href="OutOfOffHeapMemoryException.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.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/SerializationException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/SerializationException.html b/releases/latest/javadoc/org/apache/geode/SerializationException.html new file mode 100644 index 0000000..02a7116 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/SerializationException.html @@ -0,0 +1,318 @@ +<!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>SerializationException (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="SerializationException (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/OutOfOffHeapMemoryException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/StatisticDescriptor.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/SerializationException.html" target="_top">Frames</a></li> +<li><a href="SerializationException.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 SerializationException" class="title">Class SerializationException</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><a href="../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">org.apache.geode.GemFireIOException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.SerializationException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a>, <a href="../../../org/apache/geode/ToDataException.html" title="class in org.apache.geode">ToDataException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SerializationException</span> +extends <a href="../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></pre> +<div class="block">An exception indicating that a serialization or deserialization failed.</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.SerializationException">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/SerializationException.html#SerializationException-java.lang.String-">SerializationException</a></span>(java.lang.String message)</code> +<div class="block">Create a new instance of SerializationException with a detail message</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/SerializationException.html#SerializationException-java.lang.String-java.lang.Throwable-">SerializationException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Create a new instance of SerializationException with a detail message and 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="SerializationException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SerializationException</h4> +<pre>public SerializationException(java.lang.String message)</pre> +<div class="block">Create a new instance of SerializationException with a detail message</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the detail message</dd> +</dl> +</li> +</ul> +<a name="SerializationException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SerializationException</h4> +<pre>public SerializationException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Create a new instance of SerializationException with a detail message and cause</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the detail message</dd> +<dd><code>cause</code> - the cause</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/geode/OutOfOffHeapMemoryException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/StatisticDescriptor.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/SerializationException.html" target="_top">Frames</a></li> +<li><a href="SerializationException.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/StatisticDescriptor.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/StatisticDescriptor.html b/releases/latest/javadoc/org/apache/geode/StatisticDescriptor.html new file mode 100644 index 0000000..1ad4974 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/StatisticDescriptor.html @@ -0,0 +1,350 @@ +<!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>StatisticDescriptor (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="StatisticDescriptor (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/SerializationException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/Statistics.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/StatisticDescriptor.html" target="_top">Frames</a></li> +<li><a href="StatisticDescriptor.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 StatisticDescriptor" class="title">Interface StatisticDescriptor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.lang.Comparable<<a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a>></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">StatisticDescriptor</span> +extends java.lang.Comparable<<a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a>></pre> +<div class="block">Describes an individual statistic whose value is updated by an + application and may be archived by GemFire. These descriptions are + gathered together in a <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a>. + + <P> + To get an instance of this interface use an instance of + <a href="../../../org/apache/geode/StatisticsFactory.html" title="interface in org.apache.geode"><code>StatisticsFactory</code></a>. + <P> + <code>StatisticDescriptor</code>s are naturally ordered by their name.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.0</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.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#getDescription--">getDescription</a></span>()</code> +<div class="block">Returns a description of this statistic</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#getId--">getId</a></span>()</code> +<div class="block">Returns the id of this statistic in a <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>statistics type</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#getName--">getName</a></span>()</code> +<div class="block">Returns the name of this statistic</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#getType--">getType</a></span>()</code> +<div class="block">Returns the type of this statistic</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#getUnit--">getUnit</a></span>()</code> +<div class="block">Returns the unit in which this statistic is measured</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#isCounter--">isCounter</a></span>()</code> +<div class="block">Returns true if this statistic is a counter; false if its a gauge.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticDescriptor.html#isLargerBetter--">isLargerBetter</a></span>()</code> +<div class="block">Returns true if a larger statistic value indicates better performance.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Comparable"> +<!-- --> +</a> +<h3>Methods inherited from interface java.lang.Comparable</h3> +<code>compareTo</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="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>int getId()</pre> +<div class="block">Returns the id of this statistic in a <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>statistics type</code></a>. The id is initialized when its statistics + type is created.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - The id has not been initialized yet</dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this statistic</div> +</li> +</ul> +<a name="getDescription--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>java.lang.String getDescription()</pre> +<div class="block">Returns a description of this statistic</div> +</li> +</ul> +<a name="getType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>java.lang.Class<?> getType()</pre> +<div class="block">Returns the type of this statistic</div> +</li> +</ul> +<a name="isCounter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCounter</h4> +<pre>boolean isCounter()</pre> +<div class="block">Returns true if this statistic is a counter; false if its a gauge. + Counter statistics have values that always increase. + Gauge statistics have unconstrained values.</div> +</li> +</ul> +<a name="isLargerBetter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLargerBetter</h4> +<pre>boolean isLargerBetter()</pre> +<div class="block">Returns true if a larger statistic value indicates better performance.</div> +</li> +</ul> +<a name="getUnit--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getUnit</h4> +<pre>java.lang.String getUnit()</pre> +<div class="block">Returns the unit in which this statistic is measured</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/SerializationException.html" title="class in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/Statistics.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/StatisticDescriptor.html" target="_top">Frames</a></li> +<li><a href="StatisticDescriptor.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>
