mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-29 04:27:53 +01:00
857 lines
47 KiB
HTML
857 lines
47 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 Sun May 14 15:04:21 EEST 2017 -->
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>PluginData (Plan 3.1.1 API)</title>
|
||
|
|
<meta name="date" content="2017-05-14">
|
||
|
|
<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="PluginData (Plan 3.1.1 API)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch(err) {
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
|
||
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PluginData.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><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/HookHandler.html" title="class in main.java.com.djrapitops.plan.data.additional"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li>Next Class</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/data/additional/PluginData.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="PluginData.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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="Class PluginData" class="title">Class PluginData</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>main.java.com.djrapitops.plan.data.additional.PluginData</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<dl>
|
||
|
|
<dt>Direct Known Subclasses:</dt>
|
||
|
|
<dd><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/advancedachievements/AdvancedAchievementsAchievements.html" title="class in main.java.com.djrapitops.plan.data.additional.advancedachievements">AdvancedAchievementsAchievements</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/advancedachievements/AdvancedAchievementsTable.html" title="class in main.java.com.djrapitops.plan.data.additional.advancedachievements">AdvancedAchievementsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/vault/EconomyBalance.html" title="class in main.java.com.djrapitops.plan.data.additional.vault">EconomyBalance</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/essentials/EssentialsJailed.html" title="class in main.java.com.djrapitops.plan.data.additional.essentials">EssentialsJailed</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/essentials/EssentialsMuted.html" title="class in main.java.com.djrapitops.plan.data.additional.essentials">EssentialsMuted</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/essentials/EssentialsWarps.html" title="class in main.java.com.djrapitops.plan.data.additional.essentials">EssentialsWarps</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/factions/FactionsFaction.html" title="class in main.java.com.djrapitops.plan.data.additional.factions">FactionsFaction</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/factions/FactionsMaxPower.html" title="class in main.java.com.djrapitops.plan.data.additional.factions">FactionsMaxPower</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/factions/FactionsPower.html" title="class in main.java.com.djrapitops.plan.data.additional.factions">FactionsPower</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/factions/FactionsTable.html" title="class in main.java.com.djrapitops.plan.data.additional.factions">FactionsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/ontime/OntimeRefer.html" title="class in main.java.com.djrapitops.plan.data.additional.ontime">OntimeRefer</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/ontime/OntimeReferMonth.html" title="class in main.java.com.djrapitops.plan.data.additional.ontime">OntimeReferMonth</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/ontime/OntimeReferWeek.html" title="class in main.java.com.djrapitops.plan.data.additional.ontime">OntimeReferWeek</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/ontime/OntimeVotes.html" title="class in main.java.com.djrapitops.plan.data.additional.ontime">OntimeVotes</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/ontime/OntimeVotesMonth.html" title="class in main.java.com.djrapitops.plan.data.additional.ontime">OntimeVotesMonth</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/ontime/OntimeVotesWeek.html" title="class in main.java.com.djrapitops.plan.data.additional.ontime">OntimeVotesWeek</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/towny/TownyTable.html" title="class in main.java.com.djrapitops.plan.data.additional.towny">TownyTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/towny/TownyTown.html" title="class in main.java.com.djrapitops.plan.data.additional.towny">TownyTown</a></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public abstract class <span class="typeNameLabel">PluginData</span>
|
||
|
|
extends <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></pre>
|
||
|
|
<div class="block">This is an abstract class that can be used to add data from a plugin to the
|
||
|
|
"Plugins"-tab of Analysis and Inspect pages.
|
||
|
|
|
||
|
|
API-section of documentation has examples on the usage of this class and how
|
||
|
|
to register objects extending this class.</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">
|
||
|
|
<!-- =========== 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>protected boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#analysisOnly">analysisOnly</a></span></code>
|
||
|
|
<div class="block">Determines if the datapoint should only be used for the analysis page.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/PluginData.html#analysisTypes">analysisTypes</a></span></code>
|
||
|
|
<div class="block">A list containing the AnalysisType enums that determine what should be
|
||
|
|
done with the data on the analysis page.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>protected <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/PluginData.html#icon">icon</a></span></code>
|
||
|
|
<div class="block">Font Awesome icon name.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code>protected <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/PluginData.html#placeholder">placeholder</a></span></code>
|
||
|
|
<div class="block">Placeholder string, for example "stepsTaken".</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>protected <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/PluginData.html#prefix">prefix</a></span></code>
|
||
|
|
<div class="block">Prefix shown before the data, for example "Steps taken: ".</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colFirst"><code>protected <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/PluginData.html#sourcePlugin">sourcePlugin</a></span></code>
|
||
|
|
<div class="block">Name of the plugin the data is coming from.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>protected <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/PluginData.html#suffix">suffix</a></span></code>
|
||
|
|
<div class="block">Suffix shown after the data, for example " steps".</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||
|
|
<caption><span>Constructors</span><span class="tabEnd"> </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="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#PluginData-java.lang.String-java.lang.String-">PluginData</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> sourcePlugin,
|
||
|
|
<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> placeholder)</code>
|
||
|
|
<div class="block">Constructor for Inspect-page only data point.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#PluginData-java.lang.String-java.lang.String-main.java.com.djrapitops.plan.data.additional.AnalysisType...-">PluginData</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> sourcePlugin,
|
||
|
|
<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> placeholder,
|
||
|
|
<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>... analysisTypes)</code>
|
||
|
|
<div class="block">Constructor for accepting single, multiple and arrays of AnalysisType.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#PluginData-java.lang.String-java.lang.String-java.util.List-">PluginData</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> sourcePlugin,
|
||
|
|
<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> placeholder,
|
||
|
|
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>> analysisTypes)</code>
|
||
|
|
<div class="block">Main constructor.</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><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>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#analysisOnly--">analysisOnly</a></span>()</code>
|
||
|
|
<div class="block">Used to get the analysisOnly parameter.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i1" class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#equals-java.lang.Object-">equals</a></span>(<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> obj)</code>
|
||
|
|
<div class="block">If a PluginData object has same placeholder, sourcePlugin and
|
||
|
|
analysisTypes, it is considired equal.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i2" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/PluginData.html#getAnalysisTypes--">getAnalysisTypes</a></span>()</code>
|
||
|
|
<div class="block">Returns the list of AnalysisTypes.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i3" class="rowColor">
|
||
|
|
<td class="colFirst"><code>abstract <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/PluginData.html#getHtmlReplaceValue-java.lang.String-java.util.UUID-">getHtmlReplaceValue</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> modifierPrefix,
|
||
|
|
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> uuid)</code>
|
||
|
|
<div class="block">Used to get the string for the html page.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i4" 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/PluginData.html#getPlaceholder-java.lang.String-">getPlaceholder</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> modifier)</code>
|
||
|
|
<div class="block">Used to get the full placeholder.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i5" 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/PluginData.html#getPrefix--">getPrefix</a></span>()</code>
|
||
|
|
<div class="block">Used to get the prefix.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i6" 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/PluginData.html#getSourcePlugin--">getSourcePlugin</a></span>()</code>
|
||
|
|
<div class="block">Used to get the source plugin's name.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i7" 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/PluginData.html#getSuffix--">getSuffix</a></span>()</code>
|
||
|
|
<div class="block">Used to get the suffix.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i8" class="altColor">
|
||
|
|
<td class="colFirst"><code>abstract <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></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#getValue-java.util.UUID-">getValue</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> uuid)</code>
|
||
|
|
<div class="block">Used to get the value for analysis.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i9" class="rowColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#hashCode--">hashCode</a></span>()</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i10" 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/PluginData.html#parseContainer-java.lang.String-java.lang.String-">parseContainer</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> modifier,
|
||
|
|
<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> contents)</code>
|
||
|
|
<div class="block">This method should be used with the return values of
|
||
|
|
getHtmlReplaceValue(String, UUID).</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i11" class="rowColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#setAnalysisOnly-boolean-">setAnalysisOnly</a></span>(boolean analysisOnly)</code>
|
||
|
|
<div class="block">Used to set the analysisOnly parameter.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i12" class="altColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#setIcon-java.lang.String-">setIcon</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> iconName)</code>
|
||
|
|
<div class="block">Used to set the Font Awesome icon.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i13" class="rowColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#setPrefix-java.lang.String-">setPrefix</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> prefix)</code>
|
||
|
|
<div class="block">Used to set the prefix.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i14" class="altColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/PluginData.html#setSuffix-java.lang.String-">setSuffix</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> suffix)</code>
|
||
|
|
<div class="block">Used to set the suffix.</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 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#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.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/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#toString--" title="class or interface in java.lang">toString</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">
|
||
|
|
<!-- ============ FIELD DETAIL =========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="field.detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Field Detail</h3>
|
||
|
|
<a name="placeholder">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>placeholder</h4>
|
||
|
|
<pre>protected <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> placeholder</pre>
|
||
|
|
<div class="block">Placeholder string, for example "stepsTaken". This will be used when
|
||
|
|
building the structure of the Plugins tab.
|
||
|
|
|
||
|
|
The complete placeholder also includes the plugin name and if analysis is
|
||
|
|
run, a modifier.
|
||
|
|
|
||
|
|
Second parameter of any super constructor.</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="sourcePlugin">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>sourcePlugin</h4>
|
||
|
|
<pre>protected <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> sourcePlugin</pre>
|
||
|
|
<div class="block">Name of the plugin the data is coming from.
|
||
|
|
|
||
|
|
All datasources with the same sourcePlugin will be placed in the same
|
||
|
|
"box" in the "Plugins" tab.
|
||
|
|
|
||
|
|
A box has a max height of 600px, and higher than that will add a
|
||
|
|
scrollbar.
|
||
|
|
|
||
|
|
First parameter of any super constructor.</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="analysisOnly">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>analysisOnly</h4>
|
||
|
|
<pre>protected boolean analysisOnly</pre>
|
||
|
|
<div class="block">Determines if the datapoint should only be used for the analysis page.
|
||
|
|
|
||
|
|
If set to false, the datapoint will be added to the inspect page as well.</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="icon">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>icon</h4>
|
||
|
|
<pre>protected <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> icon</pre>
|
||
|
|
<div class="block">Font Awesome icon name.
|
||
|
|
|
||
|
|
http://fontawesome.io/icons/</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prefix">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prefix</h4>
|
||
|
|
<pre>protected <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> prefix</pre>
|
||
|
|
<div class="block">Prefix shown before the data, for example "Steps taken: ".</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="suffix">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>suffix</h4>
|
||
|
|
<pre>protected <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> suffix</pre>
|
||
|
|
<div class="block">Suffix shown after the data, for example " steps".</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="analysisTypes">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>analysisTypes</h4>
|
||
|
|
<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>> analysisTypes</pre>
|
||
|
|
<div class="block">A list containing the AnalysisType enums that determine what should be
|
||
|
|
done with the data on the analysis page.</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="constructor.detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Constructor Detail</h3>
|
||
|
|
<a name="PluginData-java.lang.String-java.lang.String-java.util.List-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>PluginData</h4>
|
||
|
|
<pre>public PluginData(<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> sourcePlugin,
|
||
|
|
<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> placeholder,
|
||
|
|
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>> analysisTypes)</pre>
|
||
|
|
<div class="block">Main constructor.
|
||
|
|
|
||
|
|
Defaults analysisOnly to true.
|
||
|
|
|
||
|
|
Defaults icon, prefix and suffix to "".</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>sourcePlugin</code> - Name of the plugin the data is coming from</dd>
|
||
|
|
<dd><code>placeholder</code> - Placeholder string, for example "stepsTaken"</dd>
|
||
|
|
<dd><code>analysisTypes</code> - A list containing the AnalysisType enums that
|
||
|
|
determine what should be done with the data on the analysis page</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="PluginData-java.lang.String-java.lang.String-main.java.com.djrapitops.plan.data.additional.AnalysisType...-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>PluginData</h4>
|
||
|
|
<pre>public PluginData(<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> sourcePlugin,
|
||
|
|
<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> placeholder,
|
||
|
|
<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>... analysisTypes)</pre>
|
||
|
|
<div class="block">Constructor for accepting single, multiple and arrays of AnalysisType.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>sourcePlugin</code> - Name of the plugin the data is coming from</dd>
|
||
|
|
<dd><code>placeholder</code> - Placeholder string, for example "stepsTaken"</dd>
|
||
|
|
<dd><code>analysisTypes</code> - AnalysisType enums that determine what should be
|
||
|
|
done with the data on the analysis page</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="PluginData-java.lang.String-java.lang.String-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>PluginData</h4>
|
||
|
|
<pre>public PluginData(<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> sourcePlugin,
|
||
|
|
<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> placeholder)</pre>
|
||
|
|
<div class="block">Constructor for Inspect-page only data point.
|
||
|
|
|
||
|
|
analysisOnly will be set to false.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>sourcePlugin</code> - Name of the plugin the data is coming from</dd>
|
||
|
|
<dd><code>placeholder</code> - Placeholder string, for example "stepsTaken"</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="getAnalysisTypes--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getAnalysisTypes</h4>
|
||
|
|
<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional">AnalysisType</a>> getAnalysisTypes()</pre>
|
||
|
|
<div class="block">Returns the list of AnalysisTypes.
|
||
|
|
|
||
|
|
Used by Analysis</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>a list.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="parseContainer-java.lang.String-java.lang.String-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>parseContainer</h4>
|
||
|
|
<pre>public final <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> parseContainer(<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> modifier,
|
||
|
|
<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> contents)</pre>
|
||
|
|
<div class="block">This method should be used with the return values of
|
||
|
|
getHtmlReplaceValue(String, UUID).
|
||
|
|
|
||
|
|
It will add the div, icon, modifier, prefix and suffix to the value.
|
||
|
|
Modifier is for example, if calculating AnalysisType.INT_AVG "Average ",
|
||
|
|
it is a text that helps user understand that a calculation has been made.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>modifier</code> - For example "Average " - Determined by value of
|
||
|
|
AnalysisType's modifier-variable.</dd>
|
||
|
|
<dd><code>contents</code> - The data, number/string/html that should be placed on the
|
||
|
|
page.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>a proper format for the html.</dd>
|
||
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
|
<dd><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional"><code>AnalysisType</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getPlaceholder-java.lang.String-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getPlaceholder</h4>
|
||
|
|
<pre>public final <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> getPlaceholder(<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> modifier)</pre>
|
||
|
|
<div class="block">Used to get the full placeholder.
|
||
|
|
|
||
|
|
Used to avoid conflicts with existing placeholders and placeholders of
|
||
|
|
other plugins.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>modifier</code> - Modifier determined by AnalysisType's
|
||
|
|
placeholderModifier-variable.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>for example "%StepCounter_stepsTaken_total%"</dd>
|
||
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
|
<dd><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/AnalysisType.html" title="enum in main.java.com.djrapitops.plan.data.additional"><code>AnalysisType</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getSourcePlugin--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getSourcePlugin</h4>
|
||
|
|
<pre>public final <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> getSourcePlugin()</pre>
|
||
|
|
<div class="block">Used to get the source plugin's name.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>for example "StepCounter"</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getHtmlReplaceValue-java.lang.String-java.util.UUID-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getHtmlReplaceValue</h4>
|
||
|
|
<pre>public abstract <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> getHtmlReplaceValue(<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> modifierPrefix,
|
||
|
|
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> uuid)</pre>
|
||
|
|
<div class="block">Used to get the string for the html page.
|
||
|
|
|
||
|
|
parseContainer(modifierPrefix, value); should be used for all return
|
||
|
|
values so that div, icon, prefix and suffix are added.
|
||
|
|
|
||
|
|
This method is used when AnalysisType.HTML is set, or while getting the
|
||
|
|
value for the inspect page.
|
||
|
|
|
||
|
|
When using AnalysisType.HTML a random UUID is given, so it should be
|
||
|
|
disregarded. modifierPrefix is empty in that case.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>modifierPrefix</code> - Modifier determined by AnalysisType's
|
||
|
|
modifier-variable.</dd>
|
||
|
|
<dd><code>uuid</code> - UUID of the player or random UUID if AnalysisType.HTML is
|
||
|
|
used.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>html for the page.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getValue-java.util.UUID-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getValue</h4>
|
||
|
|
<pre>public abstract <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> getValue(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> uuid)</pre>
|
||
|
|
<div class="block">Used to get the value for analysis. The return value is determined by
|
||
|
|
AnalysisType you have specified. If the AnalysisType's name has a BOOLEAN
|
||
|
|
in it, Analysis will expect boolean values etc.
|
||
|
|
|
||
|
|
If the Type and return value mismatch, exception is thrown and the result
|
||
|
|
on the analysis page will say that error occurred as the value.
|
||
|
|
|
||
|
|
If a player has no value a -1 should be returned in the case of a Number.
|
||
|
|
-1 is excluded from the Average calculation's size and total.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>uuid</code> - UUID of the player the value belongs to.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>Long, Integer, Double, Boolean or String, return -1 if the player
|
||
|
|
has no value.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setPrefix-java.lang.String-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setPrefix</h4>
|
||
|
|
<pre>public final void setPrefix(<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> prefix)</pre>
|
||
|
|
<div class="block">Used to set the prefix.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>prefix</code> - for example "Steps Taken: " or a Html start tag.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setSuffix-java.lang.String-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setSuffix</h4>
|
||
|
|
<pre>public final void setSuffix(<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> suffix)</pre>
|
||
|
|
<div class="block">Used to set the suffix.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>suffix</code> - for example " steps" or a html end tag.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setIcon-java.lang.String-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setIcon</h4>
|
||
|
|
<pre>public final void setIcon(<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> iconName)</pre>
|
||
|
|
<div class="block">Used to set the Font Awesome icon.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>iconName</code> - Icon's name http://fontawesome.io/icons/</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setAnalysisOnly-boolean-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setAnalysisOnly</h4>
|
||
|
|
<pre>public final void setAnalysisOnly(boolean analysisOnly)</pre>
|
||
|
|
<div class="block">Used to set the analysisOnly parameter.
|
||
|
|
|
||
|
|
true: only used for Analysis page false: used for both if AnalysisTypes
|
||
|
|
specified, if no AnalysisTypes are specified only used for Inspect page.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>analysisOnly</code> - true/false</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="analysisOnly--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>analysisOnly</h4>
|
||
|
|
<pre>public final boolean analysisOnly()</pre>
|
||
|
|
<div class="block">Used to get the analysisOnly parameter.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>true/false</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getPrefix--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getPrefix</h4>
|
||
|
|
<pre>public final <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> getPrefix()</pre>
|
||
|
|
<div class="block">Used to get the prefix.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>example: "Steps Taken "</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getSuffix--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getSuffix</h4>
|
||
|
|
<pre>public final <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> getSuffix()</pre>
|
||
|
|
<div class="block">Used to get the suffix.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>example: " steps"</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="equals-java.lang.Object-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>equals</h4>
|
||
|
|
<pre>public final boolean equals(<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> obj)</pre>
|
||
|
|
<div class="block">If a PluginData object has same placeholder, sourcePlugin and
|
||
|
|
analysisTypes, it is considired equal.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
|
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><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></code></dd>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>obj</code> - Another Object.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>Is current object equal to given object.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="hashCode--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>hashCode</h4>
|
||
|
|
<pre>public final int hashCode()</pre>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
|
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><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></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="class-use/PluginData.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><a href="../../../../../../../main/java/com/djrapitops/plan/data/additional/HookHandler.html" title="class in main.java.com.djrapitops.plan.data.additional"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li>Next Class</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/data/additional/PluginData.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="PluginData.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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>
|