ProtocolLib/Javadoc/com/comphenix/protocol/metrics/Metrics.Graph.html
2013-01-10 00:58:34 +01:00

333 lines
12 KiB
HTML

<!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 (version 1.7.0_07) on Thu Jan 10 00:56:15 CET 2013 -->
<title>Metrics.Graph</title>
<meta name="date" content="2013-01-10">
<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.Graph";
}
//-->
</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.Graph.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><a href="../../../../com/comphenix/protocol/metrics/Metrics.html" title="class in com.comphenix.protocol.metrics"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.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.Graph.html" target="_top">Frames</a></li>
<li><a href="Metrics.Graph.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.Graph" class="title">Class Metrics.Graph</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.metrics.Metrics.Graph</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../com/comphenix/protocol/metrics/Metrics.html" title="class in com.comphenix.protocol.metrics">Metrics</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="strong">Metrics.Graph</span>
extends java.lang.Object</pre>
<div class="block">Represents a custom graph on the website</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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.Graph.html#addPlotter(com.comphenix.protocol.metrics.Metrics.Plotter)">addPlotter</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">Add a plotter to the graph, which will be used to plot entries</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.Graph.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;object)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html#getName()">getName</a></strong>()</code>
<div class="block">Gets the graph's name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html" title="class in com.comphenix.protocol.metrics">Metrics.Plotter</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html#getPlotters()">getPlotters</a></strong>()</code>
<div class="block">Gets an <b>unmodifiable</b> set of the plotter objects in the graph</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Metrics.Graph.html#onOptOut()">onOptOut</a></strong>()</code>
<div class="block">Called when the server owner decides to opt-out of BukkitMetrics while the server is running.</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.Graph.html#removePlotter(com.comphenix.protocol.metrics.Metrics.Plotter)">removePlotter</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">Remove a plotter from the graph</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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block">Gets the graph's name</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Graph's name</dd></dl>
</li>
</ul>
<a name="addPlotter(com.comphenix.protocol.metrics.Metrics.Plotter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPlotter</h4>
<pre>public&nbsp;void&nbsp;addPlotter(<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">Add a plotter to the graph, which will be used to plot entries</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plotter</code> - the plotter to add to the graph</dd></dl>
</li>
</ul>
<a name="removePlotter(com.comphenix.protocol.metrics.Metrics.Plotter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePlotter</h4>
<pre>public&nbsp;void&nbsp;removePlotter(<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">Remove a plotter from the graph</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plotter</code> - the plotter to remove from the graph</dd></dl>
</li>
</ul>
<a name="getPlotters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotters</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.html" title="class in com.comphenix.protocol.metrics">Metrics.Plotter</a>&gt;&nbsp;getPlotters()</pre>
<div class="block">Gets an <b>unmodifiable</b> set of the plotter objects in the graph</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an unmodifiable <code>Set</code> of the plotter objects</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;object)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="onOptOut()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onOptOut</h4>
<pre>protected&nbsp;void&nbsp;onOptOut()</pre>
<div class="block">Called when the server owner decides to opt-out of BukkitMetrics while the server is running.</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><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.Graph.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><a href="../../../../com/comphenix/protocol/metrics/Metrics.html" title="class in com.comphenix.protocol.metrics"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/metrics/Metrics.Plotter.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.Graph.html" target="_top">Frames</a></li>
<li><a href="Metrics.Graph.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>