Plan/api/com/djrapitops/plan/extension/builder/ExtensionDataBuilder.html

437 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ExtensionDataBuilder (api 5.4-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="ExtensionDataBuilder (api 5.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":18,"i2":18,"i3":6,"i4":6,"i5":6,"i6":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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">com.djrapitops.plan.extension.builder</a></div>
<h2 title="Interface ExtensionDataBuilder" class="title">Interface ExtensionDataBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">ExtensionDataBuilder</span></pre>
<div class="block">Builder API for Extension data.
<p>
Requires Capability DATA_EXTENSION_BUILDER_API
<p>
Obtain an instance with <a href="../DataExtension.html#newExtensionDataBuilder()"><code>DataExtension.newExtensionDataBuilder()</code></a>
<p>
Used with <a href="../annotation/DataBuilderProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>DataBuilderProvider</code></a>.
See documentation on how to use the API.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAll(com.djrapitops.plan.extension.builder.ExtensionDataBuilder)">addAll</a></span>&#8203;(<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;builder)</code></th>
<td class="colLast">
<div class="block">Adds all values and tables in another builder to this builder.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)">addTable</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>&nbsp;table,
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a>&nbsp;color)</code></th>
<td class="colLast">
<div class="block">Add a table.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color,java.lang.String)">addTable</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>&nbsp;table,
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a>&nbsp;color,
java.lang.String&nbsp;tab)</code></th>
<td class="colLast">
<div class="block">Add a table to a specific tab.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addValue(java.lang.Class,com.djrapitops.plan.extension.builder.DataValue)">addValue</a></span>&#8203;(java.lang.Class&lt;T&gt;&nbsp;ofType,
<a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a>&lt;T&gt;&nbsp;dataValue)</code></th>
<td class="colLast">
<div class="block">Add a value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addValue(java.lang.Class,java.util.function.Supplier)">addValue</a></span>&#8203;(java.lang.Class&lt;T&gt;&nbsp;ofType,
java.util.function.Supplier&lt;<a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a>&lt;T&gt;&gt;&nbsp;dataValue)</code></th>
<td class="colLast">
<div class="block">Compared to the other addValue method, this method allows you to use <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a> when building your data.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invalidateValue(java.lang.String)">invalidateValue</a></span>&#8203;(java.lang.String&nbsp;text)</code></th>
<td class="colLast">
<div class="block">Invalidate a value similar to <a href="../annotation/InvalidateMethod.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>InvalidateMethod</code></a> annotation, but with the text given to <a href="#valueBuilder(java.lang.String)"><code>valueBuilder(String)</code></a>.</div>
</td>
</tr>
<tr id="i6" 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="#valueBuilder(java.lang.String)">valueBuilder</a></span>&#8203;(java.lang.String&nbsp;text)</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ValueBuilder</code></a> in order to use addValue methods.</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="valueBuilder(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueBuilder</h4>
<pre class="methodSignature"><a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a>&nbsp;valueBuilder&#8203;(java.lang.String&nbsp;text)</pre>
<div class="block">Creates a new <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ValueBuilder</code></a> in order to use addValue methods.
<p>
Using same text for two values can be problematic as the text is used for id in the database.
<p>
If you need to use <a href="../annotation/InvalidateMethod.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>InvalidateMethod</code></a> with built values,
lowercase 'text' and remove all whitespace. Example <code>valueBuilder("Times Jumped"); @InvalidateMethod("timesjumped")</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - Text that should be displayed next to the value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new value builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If text is null or empty String.</dd>
</dl>
</li>
</ul>
<a id="addValue(java.lang.Class,com.djrapitops.plan.extension.builder.DataValue)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValue</h4>
<pre class="methodSignature">&lt;T&gt;&nbsp;<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;addValue&#8203;(java.lang.Class&lt;T&gt;&nbsp;ofType,
<a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a>&lt;T&gt;&nbsp;dataValue)</pre>
<div class="block">Add a value.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the data.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ofType</code> - Class for type of the data, matches what Provider annotations want.</dd>
<dd><code>dataValue</code> - Use <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ValueBuilder</code></a> to create one.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If either parameter is null</dd>
</dl>
</li>
</ul>
<a id="addValue(java.lang.Class,java.util.function.Supplier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValue</h4>
<pre class="methodSignature">&lt;T&gt;&nbsp;<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;addValue&#8203;(java.lang.Class&lt;T&gt;&nbsp;ofType,
java.util.function.Supplier&lt;<a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a>&lt;T&gt;&gt;&nbsp;dataValue)</pre>
<div class="block">Compared to the other addValue method, this method allows you to use <a href="../NotReadyException.html" title="class in com.djrapitops.plan.extension"><code>NotReadyException</code></a> when building your data.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the data.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ofType</code> - Class for type of the data, matches what Provider annotations want.</dd>
<dd><code>dataValue</code> - Use <a href="ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ValueBuilder</code></a> to create one.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If either parameter is null</dd>
</dl>
</li>
</ul>
<a id="invalidateValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidateValue</h4>
<pre class="methodSignature"><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;invalidateValue&#8203;(java.lang.String&nbsp;text)</pre>
<div class="block">Invalidate a value similar to <a href="../annotation/InvalidateMethod.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>InvalidateMethod</code></a> annotation, but with the text given to <a href="#valueBuilder(java.lang.String)"><code>valueBuilder(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - The same text that was given to the value builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This builder.</dd>
</dl>
</li>
</ul>
<a id="addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre class="methodSignature">default&nbsp;<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;addTable&#8203;(java.lang.String&nbsp;name,
<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>&nbsp;table,
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a>&nbsp;color)</pre>
<div class="block">Add a table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the table, used in the database.</dd>
<dd><code>table</code> - Table built using <a href="../table/Table.html#builder()"><code>Table.builder()</code></a></dd>
<dd><code>color</code> - Color of the table</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This builder.</dd>
</dl>
</li>
</ul>
<a id="addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre class="methodSignature">default&nbsp;<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;addTable&#8203;(java.lang.String&nbsp;name,
<a href="../table/Table.html" title="class in com.djrapitops.plan.extension.table">Table</a>&nbsp;table,
<a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a>&nbsp;color,
java.lang.String&nbsp;tab)</pre>
<div class="block">Add a table to a specific tab.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the table, used in the database.</dd>
<dd><code>table</code> - Table built using <a href="../table/Table.html#builder()"><code>Table.builder()</code></a></dd>
<dd><code>color</code> - Color of the table</dd>
<dd><code>tab</code> - Name of the tab, remember to define <a href="../annotation/TabInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>TabInfo</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This builder.</dd>
</dl>
</li>
</ul>
<a id="addAll(com.djrapitops.plan.extension.builder.ExtensionDataBuilder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addAll</h4>
<pre class="methodSignature">void&nbsp;addAll&#8203;(<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;builder)</pre>
<div class="block">Adds all values and tables in another builder to this builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - Builder to combine with this one.</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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>