mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
1023 lines
53 KiB
HTML
1023 lines
53 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>ValueBuilder (api 5.2-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
|
|
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="ValueBuilder (api 5.2-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18,"i9":18,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":18,"i22":18,"i23":18,"i24":6,"i25":6,"i26":18,"i27":6,"i28":6,"i29":6,"i30":18,"i31":6,"i32":18,"i33":18,"i34":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../index.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-all.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.extension.builder</a></div>
|
|
<h2 title="Interface ValueBuilder" class="title">Interface ValueBuilder</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public interface <span class="typeNameLabel">ValueBuilder</span></pre>
|
|
<div class="block">Used for building <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder"><code>DataValue</code></a>s for <a href="ExtensionDataBuilder.html#addValue(java.lang.Class,com.djrapitops.plan.extension.builder.DataValue)"><code>ExtensionDataBuilder.addValue(Class, DataValue)</code></a>.
|
|
<p>
|
|
Requires Capability DATA_EXTENSION_BUILDER_API
|
|
<p>
|
|
Obtain an instance with <a href="ExtensionDataBuilder.html#valueBuilder(java.lang.String)"><code>ExtensionDataBuilder.valueBuilder(String)</code></a>.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<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="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildBoolean(boolean)">buildBoolean</a></span>​(boolean value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Boolean.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildBoolean(java.util.function.Supplier)">buildBoolean</a></span>​(java.util.function.Supplier<java.lang.Boolean> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildBooleanProvidingCondition(boolean,java.lang.String)">buildBooleanProvidingCondition</a></span>​(boolean value,
|
|
java.lang.String providedCondition)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Boolean that provides a value for <a href="../annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildBooleanProvidingCondition(java.util.function.Supplier,java.lang.String)">buildBooleanProvidingCondition</a></span>​(java.util.function.Supplier<java.lang.Boolean> value,
|
|
java.lang.String providedCondition)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildDouble(java.lang.Double)">buildDouble</a></span>​(java.lang.Double value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Floating point number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildDouble(java.util.function.Supplier)">buildDouble</a></span>​(java.util.function.Supplier<java.lang.Double> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String[]></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildGroup(java.lang.String%5B%5D)">buildGroup</a></span>​(java.lang.String[] groups)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a list of groups.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String[]></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildGroup(java.util.function.Supplier)">buildGroup</a></span>​(java.util.function.Supplier<java.lang.String[]> groups)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>default <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildNumber(java.lang.Double)">buildNumber</a></span>​(java.lang.Double value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>default <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildNumber(java.lang.Integer)">buildNumber</a></span>​(java.lang.Integer value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildNumber(java.lang.Long)">buildNumber</a></span>​(java.lang.Long value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildNumber(java.util.function.Supplier)">buildNumber</a></span>​(java.util.function.Supplier<java.lang.Long> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildPercentage(java.lang.Double)">buildPercentage</a></span>​(java.lang.Double percentage)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a Percentage.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildPercentage(java.util.function.Supplier)">buildPercentage</a></span>​(java.util.function.Supplier<java.lang.Double> percentage)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildString(java.lang.String)">buildString</a></span>​(java.lang.String value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a String.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildString(java.util.function.Supplier)">buildString</a></span>​(java.util.function.Supplier<java.lang.String> value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildTable(com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)">buildTable</a></span>​(<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a> table,
|
|
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> tableColor)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Build a table.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildTable(java.util.function.Supplier,com.djrapitops.plan.extension.icon.Color)">buildTable</a></span>​(java.util.function.Supplier<<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>> table,
|
|
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> tableColor)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conditional(com.djrapitops.plan.extension.annotation.Conditional)">conditional</a></span>​(<a href="../annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation">Conditional</a> conditional)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#description(java.lang.String)">description</a></span>​(java.lang.String description)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Description about the value that is shown on hover.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(com.djrapitops.plan.extension.FormatType)">format</a></span>​(<a href="../FormatType.html" title="enum in com.djrapitops.plan.extension">FormatType</a> formatType)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value with <a href="../FormatType.html" title="enum in com.djrapitops.plan.extension"><code>FormatType</code></a></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatAsDateWithSeconds()">formatAsDateWithSeconds</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as a epoch ms timestamp.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatAsDateWithYear()">formatAsDateWithYear</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as a epoch ms timestamp.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatAsTimeAmount()">formatAsTimeAmount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as milliseconds of time.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hideFromUsers(com.djrapitops.plan.extension.annotation.BooleanProvider)">hideFromUsers</a></span>​(<a href="../annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation">BooleanProvider</a> annotation)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#icon(com.djrapitops.plan.extension.icon.Icon)">icon</a></span>​(<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a> icon)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Icon displayed next to the value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#icon(java.lang.String,com.djrapitops.plan.extension.icon.Family,com.djrapitops.plan.extension.icon.Color)">icon</a></span>​(java.lang.String iconName,
|
|
<a href="../icon/Family.html" title="enum in com.djrapitops.plan.extension.icon">Family</a> iconFamily,
|
|
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> iconColor)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Icon displayed next to the value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#methodName(com.djrapitops.plan.extension.extractor.ExtensionMethod)">methodName</a></span>​(<a href="../extractor/ExtensionMethod.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionMethod</a> method)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#priority(int)">priority</a></span>​(int priority)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Display-priority of the value, highest value is placed top most.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showAsPlayerPageLink()">showAsPlayerPageLink</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><a href="#buildString(java.lang.String)"><code>buildString(String)</code></a> specific method, link the value to a player page.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showAsPlayerPageLink(com.djrapitops.plan.extension.annotation.StringProvider)">showAsPlayerPageLink</a></span>​(<a href="../annotation/StringProvider.html" title="annotation in com.djrapitops.plan.extension.annotation">StringProvider</a> annotation)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showInPlayerTable()">showInPlayerTable</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Show this value in the players table.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showInPlayerTable(boolean)">showInPlayerTable</a></span>​(boolean show)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showOnTab(com.djrapitops.plan.extension.annotation.Tab)">showOnTab</a></span>​(<a href="../annotation/Tab.html" title="annotation in com.djrapitops.plan.extension.annotation">Tab</a> annotation)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showOnTab(java.lang.String)">showOnTab</a></span>​(java.lang.String tabName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Show the value on a specific tab.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="description(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>description</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> description​(java.lang.String description)</pre>
|
|
<div class="block">Description about the value that is shown on hover.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>description</code> - Describe what the value is about, maximum 150 characters.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="priority(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>priority</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> priority​(int priority)</pre>
|
|
<div class="block">Display-priority of the value, highest value is placed top most.
|
|
<p>
|
|
Two values with same priority may appear in a random order.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>priority</code> - Priority between 0 and <code>Integer.MAX_VALUE</code>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="showInPlayerTable()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showInPlayerTable</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> showInPlayerTable()</pre>
|
|
<div class="block">Show this value in the players table.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="icon(java.lang.String,com.djrapitops.plan.extension.icon.Family,com.djrapitops.plan.extension.icon.Color)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>icon</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> icon​(java.lang.String iconName,
|
|
<a href="../icon/Family.html" title="enum in com.djrapitops.plan.extension.icon">Family</a> iconFamily,
|
|
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> iconColor)</pre>
|
|
<div class="block">Icon displayed next to the value.
|
|
<p>
|
|
See https://fontawesome.com/icons (select 'free')) for icons</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>iconName</code> - Name of the icon</dd>
|
|
<dd><code>iconFamily</code> - Family of the icon</dd>
|
|
<dd><code>iconColor</code> - Color of the icon</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="icon(com.djrapitops.plan.extension.icon.Icon)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>icon</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> icon​(<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a> icon)</pre>
|
|
<div class="block">Icon displayed next to the value.
|
|
<p>
|
|
See https://fontawesome.com/icons (select 'free')) for icons</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>icon</code> - Icon built using the methods in <a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon"><code>Icon</code></a>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="showOnTab(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showOnTab</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> showOnTab​(java.lang.String tabName)</pre>
|
|
<div class="block">Show the value on a specific tab.
|
|
<p>
|
|
Remember to define <a href="../annotation/TabInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>TabInfo</code></a> annotation.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>tabName</code> - Name of the tab.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="formatAsDateWithYear()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>formatAsDateWithYear</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> formatAsDateWithYear()</pre>
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as a epoch ms timestamp.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="formatAsDateWithSeconds()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>formatAsDateWithSeconds</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> formatAsDateWithSeconds()</pre>
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as a epoch ms timestamp.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="formatAsTimeAmount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>formatAsTimeAmount</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> formatAsTimeAmount()</pre>
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as milliseconds of time.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="format(com.djrapitops.plan.extension.FormatType)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>format</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> format​(<a href="../FormatType.html" title="enum in com.djrapitops.plan.extension">FormatType</a> formatType)</pre>
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value with <a href="../FormatType.html" title="enum in com.djrapitops.plan.extension"><code>FormatType</code></a></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="showAsPlayerPageLink()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showAsPlayerPageLink</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> showAsPlayerPageLink()</pre>
|
|
<div class="block"><a href="#buildString(java.lang.String)"><code>buildString(String)</code></a> specific method, link the value to a player page.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildBoolean(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildBoolean</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean> buildBoolean​(boolean value)</pre>
|
|
<div class="block">Build a Boolean. Displayed as "Yes/No" on the page.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - true/false</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildBooleanProvidingCondition(boolean,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildBooleanProvidingCondition</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean> buildBooleanProvidingCondition​(boolean value,
|
|
java.lang.String providedCondition)</pre>
|
|
<div class="block">Build a Boolean that provides a value for <a href="../annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a>. Displayed as "Yes/No" on the page.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - true/false</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildString(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildString</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String> buildString​(java.lang.String value)</pre>
|
|
<div class="block">Build a String.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - any string. Limited to 50 characters.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildNumber(java.lang.Long)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildNumber</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long> buildNumber​(java.lang.Long value)</pre>
|
|
<div class="block">Build a Number.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - a non-floating point number.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildNumber(java.lang.Integer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildNumber</h4>
|
|
<pre class="methodSignature">default <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long> buildNumber​(java.lang.Integer value)</pre>
|
|
<div class="block">Build a Number.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - a non-floating point number.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildNumber(java.lang.Double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildNumber</h4>
|
|
<pre class="methodSignature">default <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long> buildNumber​(java.lang.Double value)</pre>
|
|
<div class="block">Build a Number.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - a non-floating point number.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildDouble(java.lang.Double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildDouble</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double> buildDouble​(java.lang.Double value)</pre>
|
|
<div class="block">Build a Floating point number.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - a floating point number.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildPercentage(java.lang.Double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildPercentage</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double> buildPercentage​(java.lang.Double percentage)</pre>
|
|
<div class="block">Build a Percentage.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>percentage</code> - value between 0.0 and 1.0</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildGroup(java.lang.String[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildGroup</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String[]> buildGroup​(java.lang.String[] groups)</pre>
|
|
<div class="block">Build a list of groups.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>groups</code> - names of groups a player is in.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildTable(com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildTable</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>> buildTable​(<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a> table,
|
|
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> tableColor)</pre>
|
|
<div class="block">Build a table.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>table</code> - Table built using <a href="../table/Table.html#builder()"><code>Table.builder()</code></a></dd>
|
|
<dd><code>tableColor</code> - Color of the table</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a data value to give to <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="buildBoolean(java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildBoolean</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean> buildBoolean​(java.util.function.Supplier<java.lang.Boolean> value)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildBoolean(boolean)"><code>buildBoolean(boolean)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildBooleanProvidingCondition(java.util.function.Supplier,java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildBooleanProvidingCondition</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Boolean> buildBooleanProvidingCondition​(java.util.function.Supplier<java.lang.Boolean> value,
|
|
java.lang.String providedCondition)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildBooleanProvidingCondition(boolean,java.lang.String)"><code>buildBooleanProvidingCondition(boolean, String)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildString(java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildString</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String> buildString​(java.util.function.Supplier<java.lang.String> value)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildString(java.lang.String)"><code>buildString(String)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildNumber(java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildNumber</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Long> buildNumber​(java.util.function.Supplier<java.lang.Long> value)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildDouble(java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildDouble</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double> buildDouble​(java.util.function.Supplier<java.lang.Double> value)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildDouble(java.lang.Double)"><code>buildDouble(Double)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildPercentage(java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildPercentage</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.Double> buildPercentage​(java.util.function.Supplier<java.lang.Double> percentage)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildPercentage(java.lang.Double)"><code>buildPercentage(Double)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildGroup(java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildGroup</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><java.lang.String[]> buildGroup​(java.util.function.Supplier<java.lang.String[]> groups)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildGroup(java.lang.String%5B%5D)"><code>buildGroup(String[])</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="buildTable(java.util.function.Supplier,com.djrapitops.plan.extension.icon.Color)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>buildTable</h4>
|
|
<pre class="methodSignature"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>> buildTable​(java.util.function.Supplier<<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>> table,
|
|
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> tableColor)</pre>
|
|
<div class="block">Lambda version for conditional return or throwing <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a>.
|
|
<p>
|
|
<a href="#buildTable(com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)"><code>buildTable(Table, Color)</code></a></div>
|
|
</li>
|
|
</ul>
|
|
<a id="hideFromUsers(com.djrapitops.plan.extension.annotation.BooleanProvider)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hideFromUsers</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> hideFromUsers​(<a href="../annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation">BooleanProvider</a> annotation)</pre>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>annotation</code> - BooleanProvider annotation.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="conditional(com.djrapitops.plan.extension.annotation.Conditional)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>conditional</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> conditional​(<a href="../annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation">Conditional</a> conditional)</pre>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>conditional</code> - Conditional annotation.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="showAsPlayerPageLink(com.djrapitops.plan.extension.annotation.StringProvider)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showAsPlayerPageLink</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> showAsPlayerPageLink​(<a href="../annotation/StringProvider.html" title="annotation in com.djrapitops.plan.extension.annotation">StringProvider</a> annotation)</pre>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>annotation</code> - StringProvider annotation.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="methodName(com.djrapitops.plan.extension.extractor.ExtensionMethod)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>methodName</h4>
|
|
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> methodName​(<a href="../extractor/ExtensionMethod.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionMethod</a> method)</pre>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>method</code> - Method this value is from.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="showInPlayerTable(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>showInPlayerTable</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> showInPlayerTable​(boolean show)</pre>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>show</code> - true/false</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="showOnTab(com.djrapitops.plan.extension.annotation.Tab)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>showOnTab</h4>
|
|
<pre class="methodSignature">default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> showOnTab​(<a href="../annotation/Tab.html" title="annotation in com.djrapitops.plan.extension.annotation">Tab</a> annotation)</pre>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>annotation</code> - Tab annotation.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../index.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-all.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses.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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|