Saber-Factions/javadoc/com/massivecraft/factions/MassiveStats.html
2019-09-11 06:56:50 -04:00

530 lines
19 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 (1.8.0_191) on Thu Dec 06 16:05:49 CST 2018 -->
<title>MassiveStats</title>
<meta content="2018-12-06" name="date">
<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="MassiveStats";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-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/massivecraft/factions/FPlayers.html" title="class in com.massivecraft.factions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/massivecraft/factions/SaberFactions.html"
title="class in com.massivecraft.factions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/massivecraft/factions/MassiveStats.html" target="_top">Frames</a></li>
<li><a href="MassiveStats.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.massivecraft.factions</div>
<h2 title="Class MassiveStats" class="title">Class MassiveStats</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.massivecraft.factions.MassiveStats</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.bukkit.event.Listener</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MassiveStats</span>
extends java.lang.Object
implements org.bukkit.event.Listener</pre>
<div class="block">MassiveStats collects plugin and server information for plugin authors.
You can learn more at our website: https://www.massivestats.com/</div>
</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">&nbsp;</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 java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#API_URL">API_URL</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#CLIENT_VERSION">CLIENT_VERSION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#MASSIVE_UPDATE_PERMISSION">MASSIVE_UPDATE_PERMISSION</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#MassiveStats-org.bukkit.plugin.java.JavaPlugin-">MassiveStats</a></span>(org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#MassiveStats-org.bukkit.plugin.java.JavaPlugin-int-">MassiveStats</a></span>(org.bukkit.plugin.java.JavaPlugin&nbsp;plugin,
int&nbsp;pingInterval)</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="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>com.massivecraft.factions.MassiveStatsDataResponse</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#getLastResponse--">getLastResponse</a></span>()</code>
<div class="block">Returns the contents of the last response from the MassiveStats server.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#getPingInterval--">getPingInterval</a></span>()</code>
<div class="block">Returns the duration, in seconds, that MassiveStats will wait before sending another request to the server.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.bukkit.plugin.java.JavaPlugin</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#getPlugin--">getPlugin</a></span>()</code>
<div class="block">Returns the plugin that this MassiveStats instance is collecting data for.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#isListenerDisabled--">isListenerDisabled</a></span>()</code>
<div class="block">Gets whether or not the built-in MassiveStats <code>PlayerJoinEvent</code> listener is enabled.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#onPlayerJoin-org.bukkit.event.player.PlayerJoinEvent-">onPlayerJoin</a></span>(org.bukkit.event.player.PlayerJoinEvent&nbsp;event)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#setListenerDisabled-boolean-">setListenerDisabled</a></span>(boolean&nbsp;listenerDisabled)</code>
<div class="block">Sets whether or not the built-in MassiveStats <code>PlayerJoinEvent</code> listener is enabled.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#setPingInterval-int-">setPingInterval</a></span>(int&nbsp;pingInterval)</code>
<div class="block">Sets the duration, in seconds, that MassiveStats should wait before sending another request to the server.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#start--">start</a></span>()</code>
<div class="block">Start the MassiveStats reporting timer.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/massivecraft/factions/MassiveStats.html#stop--">stop</a></span>()</code>
<div class="block">Stop the MassiveStats reporting timer.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CLIENT_VERSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLIENT_VERSION</h4>
<pre>public static final&nbsp;int CLIENT_VERSION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.massivecraft.factions.MassiveStats.CLIENT_VERSION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="API_URL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>API_URL</h4>
<pre>public static final&nbsp;java.lang.String API_URL</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.massivecraft.factions.MassiveStats.API_URL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MASSIVE_UPDATE_PERMISSION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MASSIVE_UPDATE_PERMISSION</h4>
<pre>public static final&nbsp;java.lang.String MASSIVE_UPDATE_PERMISSION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.massivecraft.factions.MassiveStats.MASSIVE_UPDATE_PERMISSION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MassiveStats-org.bukkit.plugin.java.JavaPlugin-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MassiveStats</h4>
<pre>public&nbsp;MassiveStats(org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - The plugin you wish to collect data for.</dd>
</dl>
</li>
</ul>
<a name="MassiveStats-org.bukkit.plugin.java.JavaPlugin-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MassiveStats</h4>
<pre>public&nbsp;MassiveStats(org.bukkit.plugin.java.JavaPlugin&nbsp;plugin,
int&nbsp;pingInterval)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - The plugin you wish to collect data for.</dd>
<dd><code>pingInterval</code> - Duration between requests.</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="isListenerDisabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isListenerDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isListenerDisabled()</pre>
<div class="block">Gets whether or not the built-in MassiveStats <code>PlayerJoinEvent</code> listener is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether or not the MassiveStats listener is enabled.</dd>
</dl>
</li>
</ul>
<a name="setListenerDisabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setListenerDisabled</h4>
<pre>public&nbsp;void&nbsp;setListenerDisabled(boolean&nbsp;listenerDisabled)</pre>
<div class="block">Sets whether or not the built-in MassiveStats <code>PlayerJoinEvent</code> listener is enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listenerDisabled</code> - Whether or not the MassiveStats listener is enabled.</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;void&nbsp;start()</pre>
<div class="block">Start the MassiveStats reporting timer.
If the timer is already running, this method will do nothing.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;stop()</pre>
<div class="block">Stop the MassiveStats reporting timer.
Requests will no longer be sent to the server - or until <a href="../../../com/massivecraft/factions/MassiveStats.html#start--"><code>start()</code></a> is invoked.</div>
</li>
</ul>
<a name="getPingInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPingInterval</h4>
<pre>public&nbsp;int&nbsp;getPingInterval()</pre>
<div class="block">Returns the duration, in seconds, that MassiveStats will wait before sending another request to the server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Duration between requests.</dd>
</dl>
</li>
</ul>
<a name="setPingInterval-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPingInterval</h4>
<pre>public&nbsp;void&nbsp;setPingInterval(int&nbsp;pingInterval)</pre>
<div class="block">Sets the duration, in seconds, that MassiveStats should wait before sending another request to the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pingInterval</code> - Duration between requests.</dd>
</dl>
</li>
</ul>
<a name="getPlugin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlugin</h4>
<pre>public&nbsp;org.bukkit.plugin.java.JavaPlugin&nbsp;getPlugin()</pre>
<div class="block">Returns the plugin that this MassiveStats instance is collecting data for.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MassiveStats instance plugin.</dd>
</dl>
</li>
</ul>
<a name="getLastResponse--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastResponse</h4>
<pre>public&nbsp;com.massivecraft.factions.MassiveStatsDataResponse&nbsp;getLastResponse()</pre>
<div class="block">Returns the contents of the last response from the MassiveStats server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MassiveStats server response.</dd>
</dl>
</li>
</ul>
<a name="onPlayerJoin-org.bukkit.event.player.PlayerJoinEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onPlayerJoin</h4>
<pre>public&nbsp;void&nbsp;onPlayerJoin(org.bukkit.event.player.PlayerJoinEvent&nbsp;event)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-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/massivecraft/factions/FPlayers.html" title="class in com.massivecraft.factions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/massivecraft/factions/SaberFactions.html"
title="class in com.massivecraft.factions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/massivecraft/factions/MassiveStats.html" target="_top">Frames</a></li>
<li><a href="MassiveStats.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>