<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (17) --> <title>ExtensionDataBuilder (Plan 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: ExtensionDataBuilder"> <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 ExtensionDataBuilder" class="title">Interface ExtensionDataBuilder</h1> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>All Known Implementing Classes:</dt> <dd><code><a href="../implementation/builder/ExtDataBuilder.html" title="class in com.djrapitops.plan.extension.implementation.builder">ExtDataBuilder</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ExtensionDataBuilder</span></div> <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 interface in com.djrapitops.plan.extension.annotation"><code>DataBuilderProvider</code></a>. See documentation on how to use the API.</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>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addAll(com.djrapitops.plan.extension.builder.ExtensionDataBuilder)" class="member-name-link">addAll</a><wbr>(<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a> builder)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Adds all values and tables in another builder to this builder.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)" class="member-name-link">addTable</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> name, <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> color)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> <div class="block">Add a 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="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color,java.lang.String)" class="member-name-link">addTable</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> name, <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> color, <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> tab)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> <div class="block">Add a table to a specific tab.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addValue(java.lang.Class,com.djrapitops.plan.extension.builder.DataValue)" class="member-name-link">addValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> ofType, <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><T> dataValue)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Add a value.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> <a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addValue(java.lang.Class,java.util.function.Supplier)" class="member-name-link">addValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> ofType, <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="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><T>> dataValue)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <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> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#invalidateValue(java.lang.String)" class="member-name-link">invalidateValue</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> text)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Invalidate a value similar to <a href="../annotation/InvalidateMethod.html" title="annotation interface 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> </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="#valueBuilder(java.lang.String)" class="member-name-link">valueBuilder</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> text)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <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> </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="valueBuilder(java.lang.String)"> <h3>valueBuilder</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">valueBuilder</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> text)</span></div> <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 interface 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 class="notes"> <dt>Parameters:</dt> <dd><code>text</code> - Text that should be displayed next to the value.</dd> <dt>Returns:</dt> <dd>a new value builder.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If text is null or empty String.</dd> </dl> </section> </li> <li> <section class="detail" id="addValue(java.lang.Class,com.djrapitops.plan.extension.builder.DataValue)"> <h3>addValue</h3> <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type"><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">addValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> ofType, <a href="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><T> dataValue)</span></div> <div class="block">Add a value.</div> <dl class="notes"> <dt>Type Parameters:</dt> <dd><code>T</code> - Type of the data.</dd> <dt>Parameters:</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>Returns:</dt> <dd>This builder.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If either parameter is null</dd> </dl> </section> </li> <li> <section class="detail" id="addValue(java.lang.Class,java.util.function.Supplier)"> <h3>addValue</h3> <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type"><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">addValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> ofType, <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="DataValue.html" title="interface in com.djrapitops.plan.extension.builder">DataValue</a><T>> dataValue)</span></div> <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 class="notes"> <dt>Type Parameters:</dt> <dd><code>T</code> - Type of the data.</dd> <dt>Parameters:</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>Returns:</dt> <dd>This builder.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If either parameter is null</dd> </dl> </section> </li> <li> <section class="detail" id="invalidateValue(java.lang.String)"> <h3>invalidateValue</h3> <div class="member-signature"><span class="return-type"><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">invalidateValue</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> text)</span></div> <div class="block">Invalidate a value similar to <a href="../annotation/InvalidateMethod.html" title="annotation interface 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 class="notes"> <dt>Parameters:</dt> <dd><code>text</code> - The same text that was given to the value builder.</dd> <dt>Returns:</dt> <dd>This builder.</dd> </dl> </section> </li> <li> <section class="detail" id="addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color)"> <h3>addTable</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">addTable</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> name, <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> color)</span></div> <div class="block">Add a table.</div> <dl class="notes"> <dt>Parameters:</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>Returns:</dt> <dd>This builder.</dd> </dl> </section> </li> <li> <section class="detail" id="addTable(java.lang.String,com.djrapitops.plan.extension.table.Table,com.djrapitops.plan.extension.icon.Color,java.lang.String)"> <h3>addTable</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">addTable</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> name, <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> color, <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> tab)</span></div> <div class="block">Add a table to a specific tab.</div> <dl class="notes"> <dt>Parameters:</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 interface in com.djrapitops.plan.extension.annotation"><code>TabInfo</code></a>.</dd> <dt>Returns:</dt> <dd>This builder.</dd> </dl> </section> </li> <li> <section class="detail" id="addAll(com.djrapitops.plan.extension.builder.ExtensionDataBuilder)"> <h3>addAll</h3> <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addAll</span><wbr><span class="parameters">(<a href="ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a> builder)</span></div> <div class="block">Adds all values and tables in another builder to this builder.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>builder</code> - Builder to combine with this one.</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>