mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-02 08:51:21 +01:00
762 lines
76 KiB
HTML
762 lines
76 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>ValueBuilder (api 5.5-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.djrapitops.plan.extension.builder, interface: ValueBuilder">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.extension.builder</a></div>
|
|
<h1 title="Interface ValueBuilder" class="title">Interface ValueBuilder</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ValueBuilder</span></div>
|
|
<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>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildBoolean(boolean)" class="member-name-link">buildBoolean</a><wbr>(boolean value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a Boolean.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildBoolean(java.util.function.Supplier)" class="member-name-link">buildBoolean</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildBooleanProvidingCondition(boolean,java.lang.String)" class="member-name-link">buildBooleanProvidingCondition</a><wbr>(boolean value,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> providedCondition)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a Boolean that provides a value for <a href="../annotation/Conditional.html" title="annotation interface in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildBooleanProvidingCondition(java.util.function.Supplier,java.lang.String)" class="member-name-link">buildBooleanProvidingCondition</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> value,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> providedCondition)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildComponent(com.djrapitops.plan.component.Component)" class="member-name-link">buildComponent</a><wbr>(<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a <a href="../../component/Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildComponent(java.util.function.Supplier)" class="member-name-link">buildComponent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a>> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildDouble(java.lang.Double)" class="member-name-link">buildDouble</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a Floating point number.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildDouble(java.util.function.Supplier)" class="member-name-link">buildDouble</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildGroup(java.lang.String%5B%5D)" class="member-name-link">buildGroup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] groups)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a list of groups.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildGroup(java.util.function.Supplier)" class="member-name-link">buildGroup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]> groups)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#buildNumber(java.lang.Double)" class="member-name-link">buildNumber</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Build a Number.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#buildNumber(java.lang.Integer)" class="member-name-link">buildNumber</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Build a Number.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildNumber(java.lang.Long)" class="member-name-link">buildNumber</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a Number.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildNumber(java.util.function.Supplier)" class="member-name-link">buildNumber</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildPercentage(java.lang.Double)" class="member-name-link">buildPercentage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> percentage)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a Percentage.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildPercentage(java.util.function.Supplier)" class="member-name-link">buildPercentage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> percentage)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildString(java.lang.String)" class="member-name-link">buildString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a String.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildString(java.util.function.Supplier)" class="member-name-link">buildString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildTable(com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)" class="member-name-link">buildTable</a><wbr>(<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a> table,
|
|
<a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a> tableColor)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Build a table.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#buildTable(java.util.function.Supplier,com.djrapitops.plan.extension.icon.Color)" class="member-name-link">buildTable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>> table,
|
|
<a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a> tableColor)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#conditional(com.djrapitops.plan.extension.annotation.Conditional)" class="member-name-link">conditional</a><wbr>(<a href="../annotation/Conditional.html" title="annotation interface in com.djrapitops.plan.extension.annotation">Conditional</a> conditional)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#description(java.lang.String)" class="member-name-link">description</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> description)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Description about the value that is shown on hover.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#format(com.djrapitops.plan.extension.FormatType)" class="member-name-link">format</a><wbr>(<a href="../FormatType.html" title="enum class in com.djrapitops.plan.extension">FormatType</a> formatType)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<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 class in com.djrapitops.plan.extension"><code>FormatType</code></a></div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#formatAsDateWithSeconds()" class="member-name-link">formatAsDateWithSeconds</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#formatAsDateWithYear()" class="member-name-link">formatAsDateWithYear</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<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>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#formatAsTimeAmount()" class="member-name-link">formatAsTimeAmount</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block"><a href="#buildNumber(java.lang.Long)"><code>buildNumber(Long)</code></a> specific method, format the value as milliseconds of time.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hideFromUsers(com.djrapitops.plan.extension.annotation.BooleanProvider)" class="member-name-link">hideFromUsers</a><wbr>(<a href="../annotation/BooleanProvider.html" title="annotation interface in com.djrapitops.plan.extension.annotation">BooleanProvider</a> annotation)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#icon(com.djrapitops.plan.extension.icon.Icon)" class="member-name-link">icon</a><wbr>(<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a> icon)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Icon displayed next to the value.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#icon(java.lang.String,com.djrapitops.plan.extension.icon.Family,com.djrapitops.plan.extension.icon.Color)" class="member-name-link">icon</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> iconName,
|
|
<a href="../icon/Family.html" title="enum class in com.djrapitops.plan.extension.icon">Family</a> iconFamily,
|
|
<a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a> iconColor)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Icon displayed next to the value.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#methodName(com.djrapitops.plan.extension.extractor.ExtensionMethod)" class="member-name-link">methodName</a><wbr>(<a href="../extractor/ExtensionMethod.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionMethod</a> method)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#priority(int)" class="member-name-link">priority</a><wbr>(int priority)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Display-priority of the value, highest value is placed top most.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#showAsPlayerPageLink()" class="member-name-link">showAsPlayerPageLink</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block"><a href="#buildString(java.lang.String)"><code>buildString(String)</code></a> specific method, link the value to a player page.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#showAsPlayerPageLink(com.djrapitops.plan.extension.annotation.StringProvider)" class="member-name-link">showAsPlayerPageLink</a><wbr>(<a href="../annotation/StringProvider.html" title="annotation interface in com.djrapitops.plan.extension.annotation">StringProvider</a> annotation)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#showInPlayerTable()" class="member-name-link">showInPlayerTable</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Show this value in the players table.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#showInPlayerTable(boolean)" class="member-name-link">showInPlayerTable</a><wbr>(boolean show)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#showOnTab(com.djrapitops.plan.extension.annotation.Tab)" class="member-name-link">showOnTab</a><wbr>(<a href="../annotation/Tab.html" title="annotation interface in com.djrapitops.plan.extension.annotation">Tab</a> annotation)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#showOnTab(java.lang.String)" class="member-name-link">showOnTab</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tabName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Show the value on a specific tab.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="description(java.lang.String)">
|
|
<h3>description</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">description</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> description)</span></div>
|
|
<div class="block">Description about the value that is shown on hover.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>description</code> - Describe what the value is about, maximum 150 characters.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="priority(int)">
|
|
<h3>priority</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">priority</span><wbr><span class="parameters">(int priority)</span></div>
|
|
<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 class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>priority</code> - Priority between 0 and <code>Integer.MAX_VALUE</code>.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="showInPlayerTable()">
|
|
<h3>showInPlayerTable</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">showInPlayerTable</span>()</div>
|
|
<div class="block">Show this value in the players table.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="icon(java.lang.String,com.djrapitops.plan.extension.icon.Family,com.djrapitops.plan.extension.icon.Color)">
|
|
<h3>icon</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">icon</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> iconName,
|
|
<a href="../icon/Family.html" title="enum class in com.djrapitops.plan.extension.icon">Family</a> iconFamily,
|
|
<a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a> iconColor)</span></div>
|
|
<div class="block">Icon displayed next to the value.
|
|
<p>
|
|
See https://fontawesome.com/icons (select 'free')) for icons</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</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>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="icon(com.djrapitops.plan.extension.icon.Icon)">
|
|
<h3>icon</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">icon</span><wbr><span class="parameters">(<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a> icon)</span></div>
|
|
<div class="block">Icon displayed next to the value.
|
|
<p>
|
|
See https://fontawesome.com/icons (select 'free')) for icons</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</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>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="showOnTab(java.lang.String)">
|
|
<h3>showOnTab</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">showOnTab</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tabName)</span></div>
|
|
<div class="block">Show the value on a specific tab.
|
|
<p>
|
|
Remember to define <a href="../annotation/TabInfo.html" title="annotation interface in com.djrapitops.plan.extension.annotation"><code>TabInfo</code></a> annotation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>tabName</code> - Name of the tab.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="formatAsDateWithYear()">
|
|
<h3>formatAsDateWithYear</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">formatAsDateWithYear</span>()</div>
|
|
<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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="formatAsDateWithSeconds()">
|
|
<h3>formatAsDateWithSeconds</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">formatAsDateWithSeconds</span>()</div>
|
|
<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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="formatAsTimeAmount()">
|
|
<h3>formatAsTimeAmount</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">formatAsTimeAmount</span>()</div>
|
|
<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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="format(com.djrapitops.plan.extension.FormatType)">
|
|
<h3>format</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="../FormatType.html" title="enum class in com.djrapitops.plan.extension">FormatType</a> formatType)</span></div>
|
|
<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 class in com.djrapitops.plan.extension"><code>FormatType</code></a></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="showAsPlayerPageLink()">
|
|
<h3>showAsPlayerPageLink</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">showAsPlayerPageLink</span>()</div>
|
|
<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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildBoolean(boolean)">
|
|
<h3>buildBoolean</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">buildBoolean</span><wbr><span class="parameters">(boolean value)</span></div>
|
|
<div class="block">Build a Boolean. Displayed as "Yes/No" on the page.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - true/false</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildBooleanProvidingCondition(boolean,java.lang.String)">
|
|
<h3>buildBooleanProvidingCondition</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">buildBooleanProvidingCondition</span><wbr><span class="parameters">(boolean value,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> providedCondition)</span></div>
|
|
<div class="block">Build a Boolean that provides a value for <a href="../annotation/Conditional.html" title="annotation interface in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a>. Displayed as "Yes/No" on the page.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - true/false</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildString(java.lang.String)">
|
|
<h3>buildString</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">buildString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div>
|
|
<div class="block">Build a String.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - any string. Limited to 50 characters.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildComponent(com.djrapitops.plan.component.Component)">
|
|
<h3>buildComponent</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a>></span> <span class="element-name">buildComponent</span><wbr><span class="parameters">(<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a> value)</span></div>
|
|
<div class="block">Build a <a href="../../component/Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - a <a href="../../component/Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a> made by <a href="../../component/ComponentService.html" title="interface in com.djrapitops.plan.component"><code>ComponentService</code></a></dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildNumber(java.lang.Long)">
|
|
<h3>buildNumber</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">buildNumber</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> value)</span></div>
|
|
<div class="block">Build a Number.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - a non-floating point number.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildNumber(java.lang.Integer)">
|
|
<h3>buildNumber</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">buildNumber</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> value)</span></div>
|
|
<div class="block">Build a Number.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - a non-floating point number.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildNumber(java.lang.Double)">
|
|
<h3>buildNumber</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">buildNumber</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</span></div>
|
|
<div class="block">Build a Number.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - a non-floating point number.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildDouble(java.lang.Double)">
|
|
<h3>buildDouble</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">buildDouble</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> value)</span></div>
|
|
<div class="block">Build a Floating point number.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - a floating point number.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildPercentage(java.lang.Double)">
|
|
<h3>buildPercentage</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">buildPercentage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> percentage)</span></div>
|
|
<div class="block">Build a Percentage.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>percentage</code> - value between 0.0 and 1.0</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildGroup(java.lang.String[])">
|
|
<h3>buildGroup</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></span> <span class="element-name">buildGroup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] groups)</span></div>
|
|
<div class="block">Build a list of groups.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>groups</code> - names of groups a player is in.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildTable(com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)">
|
|
<h3>buildTable</h3>
|
|
<div class="member-signature"><span class="return-type"><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>></span> <span class="element-name">buildTable</span><wbr><span class="parameters">(<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a> table,
|
|
<a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a> tableColor)</span></div>
|
|
<div class="block">Build a table.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</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>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildBoolean(java.util.function.Supplier)">
|
|
<h3>buildBoolean</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">buildBoolean</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> value)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildBooleanProvidingCondition(java.util.function.Supplier,java.lang.String)">
|
|
<h3>buildBooleanProvidingCondition</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">buildBooleanProvidingCondition</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>> value,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> providedCondition)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildString(java.util.function.Supplier)">
|
|
<h3>buildString</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">buildString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> value)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildComponent(java.util.function.Supplier)">
|
|
<h3>buildComponent</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a>></span> <span class="element-name">buildComponent</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../../component/Component.html" title="interface in com.djrapitops.plan.component">Component</a>> value)</span></div>
|
|
<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="#buildComponent(com.djrapitops.plan.component.Component)"><code>buildComponent(Component)</code></a></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildNumber(java.util.function.Supplier)">
|
|
<h3>buildNumber</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">buildNumber</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> value)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildDouble(java.util.function.Supplier)">
|
|
<h3>buildDouble</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">buildDouble</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> value)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildPercentage(java.util.function.Supplier)">
|
|
<h3>buildPercentage</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">buildPercentage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> percentage)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildGroup(java.util.function.Supplier)">
|
|
<h3>buildGroup</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]></span> <span class="element-name">buildGroup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]> groups)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildTable(java.util.function.Supplier,com.djrapitops.plan.extension.icon.Color)">
|
|
<h3>buildTable</h3>
|
|
<div class="member-signature"><span class="return-type"><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>></span> <span class="element-name">buildTable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>> table,
|
|
<a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a> tableColor)</span></div>
|
|
<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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hideFromUsers(com.djrapitops.plan.extension.annotation.BooleanProvider)">
|
|
<h3>hideFromUsers</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">hideFromUsers</span><wbr><span class="parameters">(<a href="../annotation/BooleanProvider.html" title="annotation interface in com.djrapitops.plan.extension.annotation">BooleanProvider</a> annotation)</span></div>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>annotation</code> - BooleanProvider annotation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="conditional(com.djrapitops.plan.extension.annotation.Conditional)">
|
|
<h3>conditional</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">conditional</span><wbr><span class="parameters">(<a href="../annotation/Conditional.html" title="annotation interface in com.djrapitops.plan.extension.annotation">Conditional</a> conditional)</span></div>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>conditional</code> - Conditional annotation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="showAsPlayerPageLink(com.djrapitops.plan.extension.annotation.StringProvider)">
|
|
<h3>showAsPlayerPageLink</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">showAsPlayerPageLink</span><wbr><span class="parameters">(<a href="../annotation/StringProvider.html" title="annotation interface in com.djrapitops.plan.extension.annotation">StringProvider</a> annotation)</span></div>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>annotation</code> - StringProvider annotation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="methodName(com.djrapitops.plan.extension.extractor.ExtensionMethod)">
|
|
<h3>methodName</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">methodName</span><wbr><span class="parameters">(<a href="../extractor/ExtensionMethod.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionMethod</a> method)</span></div>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>method</code> - Method this value is from.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="showInPlayerTable(boolean)">
|
|
<h3>showInPlayerTable</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">showInPlayerTable</span><wbr><span class="parameters">(boolean show)</span></div>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>show</code> - true/false</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="showOnTab(com.djrapitops.plan.extension.annotation.Tab)">
|
|
<h3>showOnTab</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">showOnTab</span><wbr><span class="parameters">(<a href="../annotation/Tab.html" title="annotation interface in com.djrapitops.plan.extension.annotation">Tab</a> annotation)</span></div>
|
|
<div class="block">Implementation detail - for abstracting annotations with the builder API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>annotation</code> - Tab annotation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|