SteamWar/ProtocolLib
Archiviert
13
0
Fork 0
Code Issues Pull-Requests Releases Wiki Aktivität
Dieses Repository wurde am 2021-01-06 archiviert. Du kannst Dateien ansehen und es klonen, aber nicht pushen oder Issues/Pull-Requests öffnen.
fc44ff9fba
ProtocolLib/Javadoc/com/comphenix/protocol/metrics/Metrics.html

426 Zeilen
16 KiB
HTML
Originalformat Normale Ansicht Verlauf

Updated JavaDoc for 2.0.0
2013-01-10 00:58:34 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
Updating JavaDoc for 2.1.0
2013-01-22 13:29:54 +01:00
<!-- Generated by javadoc (version 1.7.0_07) on Tue Jan 22 13:27:27 CET 2013 -->
Updated JavaDoc for 2.0.0
2013-01-10 00:58:34 +01:00
<title>Metrics</title>
Updating JavaDoc for 2.1.0
2013-01-22 13:29:54 +01:00
<meta name="date" content="2013-01-22">
Updated JavaDoc for 2.0.0
2013-01-10 00:58:34 +01:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Metrics";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Metrics.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/metrics/Metrics.html" target="_top">Frames</a></li>
<li><a href="Metrics.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:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.comphenix.protocol.metrics</div>
<h2 title="Class Metrics" class="title">Class Metrics</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.metrics.Metrics</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Metrics</span>
extends java.lang.Object</pre>
<div class="block"><p> The metrics class obtains data about a plugin and submits statistics about it to the metrics backend. </p> <p>
Public methods provided by this class: </p>
<code>
Graph createGraph(String name); <br/>
void addCustomData(BukkitMetrics.Plotter plotter); <br/>
void start(); <br/>
</code></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics">Metrics.Graph</a></strong></code>
<div class="block">Represents a custom graph on the website</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html" title="class in com.comphenix.protocol.metrics">Metrics.Plotter</a></strong></code>
<div class="block">Interface used to collect custom data for a plugin</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#Metrics(org.bukkit.plugin.Plugin)">Metrics</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#addCustomData(com.comphenix.protocol.metrics.Metrics.Plotter)">addCustomData</a></strong>(<a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html" title="class in com.comphenix.protocol.metrics">Metrics.Plotter</a>&nbsp;plotter)</code>
<div class="block">Adds a custom data plotter to the default graph</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#addGraph(com.comphenix.protocol.metrics.Metrics.Graph)">addGraph</a></strong>(<a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics">Metrics.Graph</a>&nbsp;graph)</code>
<div class="block">Add a Graph object to BukkitMetrics that represents data for the plugin that should be sent to the backend</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics">Metrics.Graph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#createGraph(java.lang.String)">createGraph</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Construct and create a Graph that can be used to separate specific plotters to their own graphs on the metrics
website.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#disable()">disable</a></strong>()</code>
<div class="block">Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#enable()">enable</a></strong>()</code>
<div class="block">Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#getConfigFile()">getConfigFile</a></strong>()</code>
<div class="block">Gets the File object of the config file that should be used to store data such as the GUID and opt-out status</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#isOptOut()">isOptOut</a></strong>()</code>
<div class="block">Has the server owner denied plugin metrics?</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.html#start()">start</a></strong>()</code>
<div class="block">Start measuring statistics.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Metrics(org.bukkit.plugin.Plugin)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Metrics</h4>
<pre>public&nbsp;Metrics(org.bukkit.plugin.Plugin&nbsp;plugin)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createGraph(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGraph</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics">Metrics.Graph</a>&nbsp;createGraph(java.lang.String&nbsp;name)</pre>
<div class="block">Construct and create a Graph that can be used to separate specific plotters to their own graphs on the metrics
website. Plotters can be added to the graph object returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of the graph</dd>
<dt><span class="strong">Returns:</span></dt><dd>Graph object created. Will never return NULL under normal circumstances unless bad parameters are given</dd></dl>
</li>
</ul>
<a name="addGraph(com.comphenix.protocol.metrics.Metrics.Graph)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGraph</h4>
<pre>public&nbsp;void&nbsp;addGraph(<a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics">Metrics.Graph</a>&nbsp;graph)</pre>
<div class="block">Add a Graph object to BukkitMetrics that represents data for the plugin that should be sent to the backend</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>graph</code> - The name of the graph</dd></dl>
</li>
</ul>
<a name="addCustomData(com.comphenix.protocol.metrics.Metrics.Plotter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCustomData</h4>
<pre>public&nbsp;void&nbsp;addCustomData(<a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html" title="class in com.comphenix.protocol.metrics">Metrics.Plotter</a>&nbsp;plotter)</pre>
<div class="block">Adds a custom data plotter to the default graph</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plotter</code> - The plotter to use to plot custom data</dd></dl>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;boolean&nbsp;start()</pre>
<div class="block">Start measuring statistics. This will immediately create an async repeating task as the plugin and send the
initial data to the metrics backend, and then after that it will post in increments of PING_INTERVAL * 1200
ticks.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if statistics measuring is running, otherwise false.</dd></dl>
</li>
</ul>
<a name="isOptOut()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOptOut</h4>
<pre>public&nbsp;boolean&nbsp;isOptOut()</pre>
<div class="block">Has the server owner denied plugin metrics?</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if metrics should be opted out of it</dd></dl>
</li>
</ul>
<a name="enable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre>public&nbsp;void&nbsp;enable()
throws java.io.IOException</pre>
<div class="block">Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="disable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disable</h4>
<pre>public&nbsp;void&nbsp;disable()
throws java.io.IOException</pre>
<div class="block">Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getConfigFile()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConfigFile</h4>
<pre>public&nbsp;java.io.File&nbsp;getConfigFile()</pre>
<div class="block">Gets the File object of the config file that should be used to store data such as the GUID and opt-out status</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the File object for the config file</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Metrics.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html" title="class in com.comphenix.protocol.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/metrics/Metrics.html" target="_top">Frames</a></li>
<li><a href="Metrics.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:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
In neuem Issue referenzieren Permalink kopieren