mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-09-19 18:21:00 +02:00
605 lines
29 KiB
HTML
605 lines
29 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="fi">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 02 21:49:46 EEST 2017 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>AnalysisType (Plan 4.0.0 API)</title>
|
|
<meta name="date" content="2017-10-02">
|
|
<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="AnalysisType (Plan 4.0.0 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":9,"i3":9};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/AnalysisType.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-all.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="../../../../../../../main/java/com/djrapitops/plan/data/additional/HookHandler.html" title="class in main.java.com.djrapitops.plan.data.additional"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/data/additional/AnalysisType.html" target="_top">Frames</a></li>
|
|
<li><a href="AnalysisType.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="#enum.constant.summary">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
|
|
<li>Field | </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">main.java.com.djrapitops.plan.data.additional</div>
|
|
<h2 title="Enum AnalysisType" class="title">Enum AnalysisType</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>main.java.com.djrapitops.plan.data.additional.AnalysisType</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public enum <span class="typeNameLabel">AnalysisType</span>
|
|
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>></pre>
|
|
<div class="block">This class contains Enum values for different types of Analysis that can be
|
|
performed on values of PluginData.
|
|
<p>
|
|
The enum determines what should be done to the return value of
|
|
PluginData.getValue() method when the analysis is run.
|
|
<p>
|
|
Refer to the documentation on GitHub for additional information.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>3.1.0</dd>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Rsl1122</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="enum.constant.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Enum Constant Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
|
|
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Enum Constant and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#BOOLEAN_PERCENTAGE">BOOLEAN_PERCENTAGE</a></span></code>
|
|
<div class="block">Used to calculate %-true for the returned boolean values of getValue().</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#BOOLEAN_TOTAL">BOOLEAN_TOTAL</a></span></code>
|
|
<div class="block">Used to calculate number of true values for the returned boolean values
|
|
of getValue().</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#DOUBLE_AVG">DOUBLE_AVG</a></span></code>
|
|
<div class="block">Used when the getValue() method returns double and average should be
|
|
calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#DOUBLE_TOTAL">DOUBLE_TOTAL</a></span></code>
|
|
<div class="block">Used when the getValue() method returns a double and total should be
|
|
calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#HTML">HTML</a></span></code>
|
|
<div class="block">Used to add html tags to the plugins tab.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#INT_AVG">INT_AVG</a></span></code>
|
|
<div class="block">Used when the getValue() method returns an integer and average should be
|
|
calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#INT_TOTAL">INT_TOTAL</a></span></code>
|
|
<div class="block">Used when the getValue() method returns an integer and total should be
|
|
calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#LONG_AVG">LONG_AVG</a></span></code>
|
|
<div class="block">Used when the getValue() method returns a long and average should be
|
|
calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#LONG_EPOCH_MS_MINUS_NOW_AVG">LONG_EPOCH_MS_MINUS_NOW_AVG</a></span></code>
|
|
<div class="block">Used when the getValue() method returns an Epoch Millisecond as long and
|
|
average of differences between the millisecond and current millisecond
|
|
should be calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#LONG_TIME_MS_AVG">LONG_TIME_MS_AVG</a></span></code>
|
|
<div class="block">Used when the getValue() method returns an amount of milliseconds as long
|
|
and average should be calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#LONG_TIME_MS_TOTAL">LONG_TIME_MS_TOTAL</a></span></code>
|
|
<div class="block">Used when the getValue() method returns an amount of milliseconds as long
|
|
and total should be calculated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#LONG_TOTAL">LONG_TOTAL</a></span></code>
|
|
<div class="block">Used when the getValue() method returns a long and total should be
|
|
calculated.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#getModifier--">getModifier</a></span>()</code>
|
|
<div class="block">Used to get the modifier for the Prefix of the value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#getPlaceholderModifier--">getPlaceholderModifier</a></span>()</code>
|
|
<div class="block">Used to get the Placeholder modifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>static <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>[]</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html#values--">values</a></span>()</code>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="enum.constant.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Enum Constant Detail</h3>
|
|
<a name="INT_AVG">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>INT_AVG</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> INT_AVG</pre>
|
|
<div class="block">Used when the getValue() method returns an integer and average should be
|
|
calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="LONG_AVG">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LONG_AVG</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> LONG_AVG</pre>
|
|
<div class="block">Used when the getValue() method returns a long and average should be
|
|
calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="DOUBLE_AVG">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>DOUBLE_AVG</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> DOUBLE_AVG</pre>
|
|
<div class="block">Used when the getValue() method returns double and average should be
|
|
calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="INT_TOTAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>INT_TOTAL</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> INT_TOTAL</pre>
|
|
<div class="block">Used when the getValue() method returns an integer and total should be
|
|
calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="LONG_TOTAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LONG_TOTAL</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> LONG_TOTAL</pre>
|
|
<div class="block">Used when the getValue() method returns a long and total should be
|
|
calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="DOUBLE_TOTAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>DOUBLE_TOTAL</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> DOUBLE_TOTAL</pre>
|
|
<div class="block">Used when the getValue() method returns a double and total should be
|
|
calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="LONG_TIME_MS_AVG">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LONG_TIME_MS_AVG</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> LONG_TIME_MS_AVG</pre>
|
|
<div class="block">Used when the getValue() method returns an amount of milliseconds as long
|
|
and average should be calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="LONG_TIME_MS_TOTAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LONG_TIME_MS_TOTAL</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> LONG_TIME_MS_TOTAL</pre>
|
|
<div class="block">Used when the getValue() method returns an amount of milliseconds as long
|
|
and total should be calculated.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="LONG_EPOCH_MS_MINUS_NOW_AVG">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LONG_EPOCH_MS_MINUS_NOW_AVG</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> LONG_EPOCH_MS_MINUS_NOW_AVG</pre>
|
|
<div class="block">Used when the getValue() method returns an Epoch Millisecond as long and
|
|
average of differences between the millisecond and current millisecond
|
|
should be calculated.
|
|
<p>
|
|
For example if a player has dropped a Foo on epoch ms 1494486504000 and
|
|
that was 5s (5000ms) ago. Now you want to calculate the average
|
|
time-since for all players. Then you use this one.
|
|
<p>
|
|
-1 values will be disregarded from the calculation (size will not grow).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="BOOLEAN_PERCENTAGE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>BOOLEAN_PERCENTAGE</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> BOOLEAN_PERCENTAGE</pre>
|
|
<div class="block">Used to calculate %-true for the returned boolean values of getValue().</div>
|
|
</li>
|
|
</ul>
|
|
<a name="BOOLEAN_TOTAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>BOOLEAN_TOTAL</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> BOOLEAN_TOTAL</pre>
|
|
<div class="block">Used to calculate number of true values for the returned boolean values
|
|
of getValue().
|
|
<p>
|
|
Will be presented as "n / total".</div>
|
|
</li>
|
|
</ul>
|
|
<a name="HTML">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>HTML</h4>
|
|
<pre>public static final <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> HTML</pre>
|
|
<div class="block">Used to add html tags to the plugins tab.
|
|
<p>
|
|
Can be used to add Tables, Images (for example maps) and other html
|
|
elements.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="values--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>values</h4>
|
|
<pre>public static <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>[] values()</pre>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared. This method may be used to iterate
|
|
over the constants as follows:
|
|
<pre>
|
|
for (AnalysisType c : AnalysisType.values())
|
|
System.out.println(c);
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="valueOf-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>valueOf</h4>
|
|
<pre>public static <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a> valueOf(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
|
|
<div class="block">Returns the enum constant of this type with the specified name.
|
|
The string must match <i>exactly</i> an identifier used to declare an
|
|
enum constant in this type. (Extraneous whitespace characters are
|
|
not permitted.)</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the enum constant with the specified name</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getModifier--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getModifier</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getModifier()</pre>
|
|
<div class="block">Used to get the modifier for the Prefix of the value.
|
|
<p>
|
|
For example: "Average Votes" when INT_AVG is used and Prefix is set as
|
|
"Votes".</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Modifier, can be empty.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPlaceholderModifier--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getPlaceholderModifier</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPlaceholderModifier()</pre>
|
|
<div class="block">Used to get the Placeholder modifier.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>for example "_total"</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="class-use/AnalysisType.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-all.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="../../../../../../../main/java/com/djrapitops/plan/data/additional/HookHandler.html" title="class in main.java.com.djrapitops.plan.data.additional"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/data/additional/AnalysisType.html" target="_top">Frames</a></li>
|
|
<li><a href="AnalysisType.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="#enum.constant.summary">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright © 2017. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|