http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/StatisticsFactory.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/StatisticsFactory.html b/releases/latest/javadoc/org/apache/geode/StatisticsFactory.html new file mode 100644 index 0000000..d024b2b --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/StatisticsFactory.html @@ -0,0 +1,482 @@ +<!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>StatisticsFactory (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="StatisticsFactory (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}; +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/Statistics.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/StatisticsType.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/StatisticsFactory.html" target="_top">Frames</a></li> +<li><a href="StatisticsFactory.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 StatisticsFactory" class="title">Interface StatisticsFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../org/apache/geode/StatisticsTypeFactory.html" title="interface in org.apache.geode">StatisticsTypeFactory</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">StatisticsFactory</span> +extends <a href="../../../org/apache/geode/StatisticsTypeFactory.html" title="interface in org.apache.geode">StatisticsTypeFactory</a></pre> +<div class="block">Instances of this interface provide methods that create instances + of <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a>. + It can also be used to create instances of <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> + and <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> because it implements <a href="../../../org/apache/geode/StatisticsTypeFactory.html" title="interface in org.apache.geode"><code>StatisticsTypeFactory</code></a>. + <a href="../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a> is the only + instance of this interface. + + <P> + + A <code>StatisticsFactory</code> can create a <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>statistic</code></a> of three numeric types: + <code>int</code>, <code>long</code>, and <code>double</code>. A + statistic (<code>StatisticDescriptor</code>) can either be a + <I>gauge</I> meaning that its value can increase and decrease or a + <I>counter</I> meaning that its value is strictly increasing. + Marking a statistic as a counter allows statistic display tools + to properly display a statistics whose value "wraps around" (that + is, exceeds its maximum value). + + <P>The following code is an example of how to create a type using the api. + In this example the type has two stats whose values always increase: + <pre> + StatisticsFactory f = ...; + StatisticsType t = f.createType( + "StatSampler", + "Stats on the statistic sampler.", + new StatisticDescriptor[] { + f.createIntCounter("sampleCount", + "Total number of samples taken by this sampler.", + "samples"), + f.createLongCounter("sampleTime", + "Total amount of time spent taking samples.", + "milliseconds"), + } + ); + this.samplerStats = f.createStatistics(t, "statSampler"); + this.sampleCountId = this.samplerStats.nameToId("sampleCount"); + this.sampleTimeId = this.samplerStats.nameToId("sampleTime"); + </pre> + Later on the stat ids can be used to increment the stats: + <pre> + this.samplerStats.incInt(this.sampleCountId, 1); + this.samplerStats.incLong(this.sampleTimeId, nanosSpentWorking / 1000000); + </pre> + <P>The following is an example of how to create the same type using XML. + The XML data: + <pre> + <?xml version="1.0" encoding="UTF-8"?> + <!DOCTYPE statistics PUBLIC + "-//GemStone Systems, Inc.//GemFire Statistics Type//EN" + "http://www.gemstone.com/dtd/statisticsType.dtd"> + <statistics> + <type name="StatSampler"> + <description>Stats on the statistic sampler.</description> + <stat name="sampleCount" storage="int" counter="true"> + <description>Total number of samples taken by this sampler.</description> + <unit>samples</unit> + </stat> + <stat name="sampleTime" storage="long" counter="true"> + <description>Total amount of time spent taking samples.</description> + <unit>milliseconds</unit> + </stat> + </type> + </statistics> + </pre> + The code to create the type: + <pre> + StatisticsFactory f = ...; + Reader r = new InputStreamReader("fileContainingXmlData")); + StatisticsType type = f.createTypesFromXml(r)[0]; + </pre> + <P></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><A href="package-summary.html#statistics">Package introduction</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.geode.StatisticsTypeFactory"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.geode.<a href="../../../org/apache/geode/StatisticsTypeFactory.html" title="interface in org.apache.geode">StatisticsTypeFactory</a></h3> +<code><a href="../../../org/apache/geode/StatisticsTypeFactory.html#MAX_DESCRIPTORS_PER_TYPE">MAX_DESCRIPTORS_PER_TYPE</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#createAtomicStatistics-org.apache.geode.StatisticsType-">createAtomicStatistics</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type)</code> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a> with default ids.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#createAtomicStatistics-org.apache.geode.StatisticsType-java.lang.String-">createAtomicStatistics</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId)</code> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and with a default numeric id.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#createAtomicStatistics-org.apache.geode.StatisticsType-java.lang.String-long-">createAtomicStatistics</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId, + long numericId)</code> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and <code>numericId</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#createStatistics-org.apache.geode.StatisticsType-">createStatistics</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type)</code> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a> with default ids.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#createStatistics-org.apache.geode.StatisticsType-java.lang.String-">createStatistics</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId)</code> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and with a default numeric id.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#createStatistics-org.apache.geode.StatisticsType-java.lang.String-long-">createStatistics</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId, + long numericId)</code> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and <code>numericId</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#findStatisticsByNumericId-long-">findStatisticsByNumericId</a></span>(long numericId)</code> +<div class="block">Returns an array of all the existing statistics with the given numericId.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#findStatisticsByTextId-java.lang.String-">findStatisticsByTextId</a></span>(java.lang.String textId)</code> +<div class="block">Returns an array of all the existing statistics with the given textId.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsFactory.html#findStatisticsByType-org.apache.geode.StatisticsType-">findStatisticsByType</a></span>(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type)</code> +<div class="block">Returns an array of all the existing statistics of the given type.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.StatisticsTypeFactory"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.geode.<a href="../../../org/apache/geode/StatisticsTypeFactory.html" title="interface in org.apache.geode">StatisticsTypeFactory</a></h3> +<code><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleCounter-java.lang.String-java.lang.String-java.lang.String-">createDoubleCounter</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleCounter-java.lang.String-java.lang.String-java.lang.String-boolean-">createDoubleCounter</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleGauge-java.lang.String-java.lang.String-java.lang.String-">createDoubleGauge</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleGauge-java.lang.String-java.lang.String-java.lang.String-boolean-">createDoubleGauge</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntCounter-java.lang.String-java.lang.String-java.lang.String-">createIntCounter</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntCounter-java.lang.String-java.lang.String-java.lang.String-boolean-">createIntCounter</a>, <a href="../../../org/apach e/geode/StatisticsTypeFactory.html#createIntGauge-java.lang.String-java.lang.String-java.lang.String-">createIntGauge</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntGauge-java.lang.String-java.lang.String-java.lang.String-boolean-">createIntGauge</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongCounter-java.lang.String-java.lang.String-java.lang.String-">createLongCounter</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongCounter-java.lang.String-java.lang.String-java.lang.String-boolean-">createLongCounter</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongGauge-java.lang.String-java.lang.String-java.lang.String-">createLongGauge</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongGauge-java.lang.String-java.lang.String-java.lang.String-boolean-">createLongGauge</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createType-java.lang.S tring-java.lang.String-org.apache.geode.StatisticDescriptor:A-">createType</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#createTypesFromXml-java.io.Reader-">createTypesFromXml</a>, <a href="../../../org/apache/geode/StatisticsTypeFactory.html#findType-java.lang.String-">findType</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createStatistics-org.apache.geode.StatisticsType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStatistics</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a> createStatistics(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type)</pre> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a> with default ids. + <p> + The created instance may not be <a href="../../../org/apache/geode/Statistics.html#isAtomic--"><code>atomic</code></a>.</div> +</li> +</ul> +<a name="createStatistics-org.apache.geode.StatisticsType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStatistics</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a> createStatistics(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId)</pre> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and with a default numeric id. + <p> + The created instance may not be <a href="../../../org/apache/geode/Statistics.html#isAtomic--"><code>atomic</code></a>.</div> +</li> +</ul> +<a name="createStatistics-org.apache.geode.StatisticsType-java.lang.String-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStatistics</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a> createStatistics(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId, + long numericId)</pre> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and <code>numericId</code>. + <p> + The created instance may not be <a href="../../../org/apache/geode/Statistics.html#isAtomic--"><code>atomic</code></a>.</div> +</li> +</ul> +<a name="createAtomicStatistics-org.apache.geode.StatisticsType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAtomicStatistics</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a> createAtomicStatistics(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type)</pre> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a> with default ids. + <p> + The created instance will be <a href="../../../org/apache/geode/Statistics.html#isAtomic--"><code>atomic</code></a>.</div> +</li> +</ul> +<a name="createAtomicStatistics-org.apache.geode.StatisticsType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAtomicStatistics</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a> createAtomicStatistics(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId)</pre> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and with a default numeric id. + <p> + The created instance will be <a href="../../../org/apache/geode/Statistics.html#isAtomic--"><code>atomic</code></a>.</div> +</li> +</ul> +<a name="createAtomicStatistics-org.apache.geode.StatisticsType-java.lang.String-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAtomicStatistics</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a> createAtomicStatistics(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type, + java.lang.String textId, + long numericId)</pre> +<div class="block">Creates and returns a <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> instance of the given <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>type</code></a>, <code>textId</code>, and <code>numericId</code>. + <p> + The created instance will be <a href="../../../org/apache/geode/Statistics.html#isAtomic--"><code>atomic</code></a>.</div> +</li> +</ul> +<a name="findStatisticsByType-org.apache.geode.StatisticsType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findStatisticsByType</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a>[] findStatisticsByType(<a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> type)</pre> +<div class="block">Returns an array of all the existing statistics of the given type.</div> +</li> +</ul> +<a name="findStatisticsByTextId-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findStatisticsByTextId</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a>[] findStatisticsByTextId(java.lang.String textId)</pre> +<div class="block">Returns an array of all the existing statistics with the given textId.</div> +</li> +</ul> +<a name="findStatisticsByNumericId-long-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>findStatisticsByNumericId</h4> +<pre><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a>[] findStatisticsByNumericId(long numericId)</pre> +<div class="block">Returns an array of all the existing statistics with the given numericId.</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/Statistics.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/StatisticsType.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/StatisticsFactory.html" target="_top">Frames</a></li> +<li><a href="StatisticsFactory.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/StatisticsType.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/StatisticsType.html b/releases/latest/javadoc/org/apache/geode/StatisticsType.html new file mode 100644 index 0000000..9af14a9 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/StatisticsType.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>StatisticsType (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="StatisticsType (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/StatisticsFactory.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/StatisticsTypeFactory.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/StatisticsType.html" target="_top">Frames</a></li> +<li><a href="StatisticsType.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 StatisticsType" class="title">Interface StatisticsType</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">StatisticsType</span></pre> +<div class="block">Used to describe a logical collection of statistics. These descriptions + are used to create an instance of <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</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>.</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/StatisticsType.html#getDescription--">getDescription</a></span>()</code> +<div class="block">Returns a description of this statistics type</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsType.html#getName--">getName</a></span>()</code> +<div class="block">Returns the name of this statistics type</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsType.html#getStatistics--">getStatistics</a></span>()</code> +<div class="block">Returns descriptions of the statistics that this statistics type + gathers together</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsType.html#nameToDescriptor-java.lang.String-">nameToDescriptor</a></span>(java.lang.String name)</code> +<div class="block">Returns the descriptor of the statistic with the given name in this + statistics instance.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsType.html#nameToId-java.lang.String-">nameToId</a></span>(java.lang.String name)</code> +<div class="block">Returns the id of the statistic with the given name in this + statistics instance.</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="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 statistics type</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 statistics type</div> +</li> +</ul> +<a name="getStatistics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatistics</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a>[] getStatistics()</pre> +<div class="block">Returns descriptions of the statistics that this statistics type + gathers together</div> +</li> +</ul> +<a name="nameToId-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nameToId</h4> +<pre>int nameToId(java.lang.String name)</pre> +<div class="block">Returns the id of the statistic with the given name in this + statistics instance.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - No statistic named <code>name</code> exists in this + statistics instance.</dd> +</dl> +</li> +</ul> +<a name="nameToDescriptor-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>nameToDescriptor</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> nameToDescriptor(java.lang.String name)</pre> +<div class="block">Returns the descriptor of the statistic with the given name in this + statistics instance.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - No statistic named <code>name</code> exists in this + statistics instance.</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/StatisticsFactory.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/StatisticsTypeFactory.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/StatisticsType.html" target="_top">Frames</a></li> +<li><a href="StatisticsType.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/StatisticsTypeFactory.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/StatisticsTypeFactory.html b/releases/latest/javadoc/org/apache/geode/StatisticsTypeFactory.html new file mode 100644 index 0000000..d19abe1 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/StatisticsTypeFactory.html @@ -0,0 +1,658 @@ +<!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>StatisticsTypeFactory (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="StatisticsTypeFactory (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}; +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/StatisticsType.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/SystemConnectException.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/StatisticsTypeFactory.html" target="_top">Frames</a></li> +<li><a href="StatisticsTypeFactory.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>Constr | </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>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 StatisticsTypeFactory" class="title">Interface StatisticsTypeFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../org/apache/geode/StatisticsFactory.html" title="interface in org.apache.geode">StatisticsFactory</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">StatisticsTypeFactory</span></pre> +<div class="block">Instances of this interface provide methods that create instances + of <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> and <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a>. + Every <a href="../../../org/apache/geode/StatisticsFactory.html" title="interface in org.apache.geode"><code>StatisticsFactory</code></a> is also a type factory. + + <P> + + A <code>StatisticsTypeFactory</code> can create a <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>statistic</code></a> of three numeric types: + <code>int</code>, <code>long</code>, and <code>double</code>. A + statistic (<code>StatisticDescriptor</code>) can either be a + <I>gauge</I> meaning that its value can increase and decrease or a + <I>counter</I> meaning that its value is strictly increasing. + Marking a statistic as a counter allows statistic display tools + to properly display a statistics whose value "wraps around" (that + is, exceeds its maximum value). + + <P>The following code is an example of how to create a type using XML. + In this example the type has two stats whose values always increase: + <pre> + StatisticsTypeFactory f = ...; + StatisticsType t = f.createType( + "StatSampler", + "Stats on the statistic sampler.", + new StatisticDescriptor[] { + f.createIntCounter("sampleCount", + "Total number of samples taken by this sampler.", + "samples"), + f.createLongCounter("sampleTime", + "Total amount of time spent taking samples.", + "milliseconds"), + } + ); + </pre> + <P>The following is an example of how to create the same type using XML. + The XML data: + <pre> + <?xml version="1.0" encoding="UTF-8"?> + <!DOCTYPE statistics PUBLIC + "-//GemStone Systems, Inc.//GemFire Statistics Type//EN" + "http://www.gemstone.com/dtd/statisticsType.dtd"> + <statistics> + <type name="StatSampler"> + <description>Stats on the statistic sampler.</description> + <stat name="sampleCount" storage="int" counter="true"> + <description>Total number of samples taken by this sampler.</description> + <unit>samples</unit> + </stat> + <stat name="sampleTime" storage="long" counter="true"> + <description>Total amount of time spent taking samples.</description> + <unit>milliseconds</unit> + </stat> + </type> + </statistics> + </pre> + The code to create the type: + <pre> + StatisticsTypeFactory f = ...; + Reader r = new InputStreamReader("fileContainingXmlData")); + StatisticsType type = f.createTypesFromXml(r)[0]; + </pre> + <P></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><A href="package-summary.html#statistics">Package introduction</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 int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#MAX_DESCRIPTORS_PER_TYPE">MAX_DESCRIPTORS_PER_TYPE</a></span></code> +<div class="block">The maximum number of descriptors a single statistics type can have.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleCounter-java.lang.String-java.lang.String-java.lang.String-">createDoubleCounter</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units)</code> +<div class="block">Creates and returns a double counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with larger values indicating better performance.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleCounter-java.lang.String-java.lang.String-java.lang.String-boolean-">createDoubleCounter</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</code> +<div class="block">Creates and returns a double counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleGauge-java.lang.String-java.lang.String-java.lang.String-">createDoubleGauge</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units)</code> +<div class="block">Creates and returns a double gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with smaller values indicating better performance.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createDoubleGauge-java.lang.String-java.lang.String-java.lang.String-boolean-">createDoubleGauge</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</code> +<div class="block">Creates and returns a double gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntCounter-java.lang.String-java.lang.String-java.lang.String-">createIntCounter</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units)</code> +<div class="block">Creates and returns an int counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with larger values indicating better performance.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntCounter-java.lang.String-java.lang.String-java.lang.String-boolean-">createIntCounter</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</code> +<div class="block">Creates and returns an int counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntGauge-java.lang.String-java.lang.String-java.lang.String-">createIntGauge</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units)</code> +<div class="block">Creates and returns an int gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with smaller values indicating better performance.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createIntGauge-java.lang.String-java.lang.String-java.lang.String-boolean-">createIntGauge</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</code> +<div class="block">Creates and returns an int gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongCounter-java.lang.String-java.lang.String-java.lang.String-">createLongCounter</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units)</code> +<div class="block">Creates and returns a long counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with larger values indicating better performance.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongCounter-java.lang.String-java.lang.String-java.lang.String-boolean-">createLongCounter</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</code> +<div class="block">Creates and returns a long counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongGauge-java.lang.String-java.lang.String-java.lang.String-">createLongGauge</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units)</code> +<div class="block">Creates and returns a long gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with smaller values indicating better performance.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createLongGauge-java.lang.String-java.lang.String-java.lang.String-boolean-">createLongGauge</a></span>(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</code> +<div class="block">Creates and returns a long gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createType-java.lang.String-java.lang.String-org.apache.geode.StatisticDescriptor:A-">createType</a></span>(java.lang.String name, + java.lang.String description, + <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a>[] stats)</code> +<div class="block">Creates or finds and returns a <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> with the given <code>name</code>, <code>description</code>, and <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>statistic descriptions</code></a>.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#createTypesFromXml-java.io.Reader-">createTypesFromXml</a></span>(java.io.Reader reader)</code> +<div class="block">Creates one or more <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> from the contents of the + given <code>reader</code>.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/StatisticsTypeFactory.html#findType-java.lang.String-">findType</a></span>(java.lang.String name)</code> +<div class="block">Finds and returns an already created <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> with the given <code>name</code>.</div> +</td> +</tr> +</table> +</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="MAX_DESCRIPTORS_PER_TYPE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MAX_DESCRIPTORS_PER_TYPE</h4> +<pre>static final int MAX_DESCRIPTORS_PER_TYPE</pre> +<div class="block">The maximum number of descriptors a single statistics type can have. + <P> Current value is: <code>254</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.geode.StatisticsTypeFactory.MAX_DESCRIPTORS_PER_TYPE">Constant Field Values</a></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="createIntCounter-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createIntCounter</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createIntCounter(java.lang.String name, + java.lang.String description, + java.lang.String units)</pre> +<div class="block">Creates and returns an int counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with larger values indicating better performance.</div> +</li> +</ul> +<a name="createLongCounter-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLongCounter</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createLongCounter(java.lang.String name, + java.lang.String description, + java.lang.String units)</pre> +<div class="block">Creates and returns a long counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with larger values indicating better performance.</div> +</li> +</ul> +<a name="createDoubleCounter-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDoubleCounter</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createDoubleCounter(java.lang.String name, + java.lang.String description, + java.lang.String units)</pre> +<div class="block">Creates and returns a double counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with larger values indicating better performance.</div> +</li> +</ul> +<a name="createIntGauge-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createIntGauge</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createIntGauge(java.lang.String name, + java.lang.String description, + java.lang.String units)</pre> +<div class="block">Creates and returns an int gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with smaller values indicating better performance.</div> +</li> +</ul> +<a name="createLongGauge-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLongGauge</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createLongGauge(java.lang.String name, + java.lang.String description, + java.lang.String units)</pre> +<div class="block">Creates and returns a long gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with smaller values indicating better performance.</div> +</li> +</ul> +<a name="createDoubleGauge-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDoubleGauge</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createDoubleGauge(java.lang.String name, + java.lang.String description, + java.lang.String units)</pre> +<div class="block">Creates and returns a double gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>units</code>, + and with smaller values indicating better performance.</div> +</li> +</ul> +<a name="createIntCounter-java.lang.String-java.lang.String-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createIntCounter</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createIntCounter(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</pre> +<div class="block">Creates and returns an int counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</li> +</ul> +<a name="createLongCounter-java.lang.String-java.lang.String-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLongCounter</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createLongCounter(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</pre> +<div class="block">Creates and returns a long counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</li> +</ul> +<a name="createDoubleCounter-java.lang.String-java.lang.String-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDoubleCounter</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createDoubleCounter(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</pre> +<div class="block">Creates and returns a double counter <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</li> +</ul> +<a name="createIntGauge-java.lang.String-java.lang.String-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createIntGauge</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createIntGauge(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</pre> +<div class="block">Creates and returns an int gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</li> +</ul> +<a name="createLongGauge-java.lang.String-java.lang.String-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLongGauge</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createLongGauge(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</pre> +<div class="block">Creates and returns a long gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</li> +</ul> +<a name="createDoubleGauge-java.lang.String-java.lang.String-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDoubleGauge</h4> +<pre><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a> createDoubleGauge(java.lang.String name, + java.lang.String description, + java.lang.String units, + boolean largerBetter)</pre> +<div class="block">Creates and returns a double gauge <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> with the given <code>name</code>, <code>description</code>, <code>largerBetter</code>, and <code>units</code>.</div> +</li> +</ul> +<a name="createType-java.lang.String-java.lang.String-org.apache.geode.StatisticDescriptor:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createType</h4> +<pre><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> createType(java.lang.String name, + java.lang.String description, + <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a>[] stats)</pre> +<div class="block">Creates or finds and returns a <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> with the given <code>name</code>, <code>description</code>, and <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>statistic descriptions</code></a>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if a type with the given <code>name</code> already exists and it differs from the given parameters.</dd> +</dl> +</li> +</ul> +<a name="findType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findType</h4> +<pre><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a> findType(java.lang.String name)</pre> +<div class="block">Finds and returns an already created <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> with the given <code>name</code>. Returns <code>null</code> if the type does not exist.</div> +</li> +</ul> +<a name="createTypesFromXml-java.io.Reader-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createTypesFromXml</h4> +<pre><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a>[] createTypesFromXml(java.io.Reader reader) + throws java.io.IOException</pre> +<div class="block">Creates one or more <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> from the contents of the + given <code>reader</code>. The created types can be found by calling + <a href="../../../org/apache/geode/StatisticsTypeFactory.html#findType-java.lang.String-"><code>findType(java.lang.String)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>reader</code> - The source of the XML data which must comply with the + <code>statisticsType.dtd</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if a type defined in the reader + already exists</dd> +<dd><code>java.io.IOException</code> - Something went wrong while reading from + <code>reader</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/StatisticsType.html" title="interface in org.apache.geode"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/geode/SystemConnectException.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/StatisticsTypeFactory.html" target="_top">Frames</a></li> +<li><a href="StatisticsTypeFactory.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>Constr | </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>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>
