<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DataExtension (Plan 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="DataExtension (Plan 5.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":18,"i1":18,"i2":18,"i3":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.extension</a></div>
<h2 title="Interface DataExtension" class="title">Interface DataExtension</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">DataExtension</span></pre>
<div class="block">Interface to implement data extensions with.
<p>
The class implementing this interface should be annotated with <a href="annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>PluginInfo</code></a>.
If the extension is given to Plan API without the annotation it will be rejected.
<hr>
<p>
Public methods in the class should be annotated with appropriate Provider annotations.
Provider annotations:
<a href="annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>BooleanProvider</code></a> for <code>boolean</code> values and conditions for <a href="annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a>.
<a href="annotation/NumberProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>NumberProvider</code></a> for <code>long</code> values. (Use this for integers by casting to long) Has option for formatting.
<a href="annotation/DoubleProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>DoubleProvider</code></a> for <code>double</code> values.
<a href="annotation/PercentageProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>PercentageProvider</code></a> for <code>double</code> values that represent a percentage.
<a href="annotation/StringProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>StringProvider</code></a> for <code>String</code> values.
<a href="annotation/TableProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>TableProvider</code></a> for <a href="table/Table.html" title="class in com.djrapitops.plan.extension.table"><code>Table</code></a>s.
<a href="annotation/GroupProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>GroupProvider</code></a> for Player specific group names, such as permission groups.
<a href="annotation/DataBuilderProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>DataBuilderProvider</code></a> for <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>s.
<hr>
<p>
Methods can have one of the following as method parameters:
<code>UUID playerUUID</code> - UUID of the player the data is about
<code>String playerName</code> - Name of the player the data is about
<a href="Group.html" title="interface in com.djrapitops.plan.extension"><code>group</code></a> - Provided group the data is about (In case a group needs additional information)
nothing - The data is interpreted to be about the server.
<hr>
<p>
The name of the method will be used as an identifier in the database, so that a single provider does not duplicate entries.
Only first 50 characters of the method name are stored.
If you need to change a method name add a class annotation with the old method name: <a href="annotation/InvalidateMethod.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>InvalidateMethod</code></a>
<p>
Some additional annotations are available for controlling appearance of the results:
<a href="annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a> A <code>boolean</code> returned by <a href="annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>BooleanProvider</code></a> has to be <code>true</code> for this method to be called.
<a href="annotation/Tab.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Tab</code></a> The value of this provider should be placed on a tab with a specific name
<a href="annotation/TabInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>TabInfo</code></a> Optional Structure information about a tab
<a href="annotation/TabOrder.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>TabOrder</code></a> Optional information about preferred tab
<hr>
<p>
Method calls are asynchronous. You can control when the calls are made via <a href="#callExtensionMethodsOn()"><code>callExtensionMethodsOn()</code></a> and <a href="Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a>.
<p>
You can check against implementation violations by using <a href="extractor/ExtensionExtractor.html#validateAnnotations()"><code>ExtensionExtractor.validateAnnotations()</code></a> in your Unit Tests.
<p>
Implementation violations:
- No <a href="annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>PluginInfo</code></a> class annotation
- Class contains no public methods with Provider annotations
- Class contains private method with Provider annotation
- Non-primitive return type when primitive is required (eg. Boolean instead of boolean)
- Method doesn't have correct parameters (see above)
- <a href="annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>BooleanProvider</code></a> is annotated with a <a href="annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a> that requires same condition the provider provides.
- <a href="annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a> without a <a href="annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>BooleanProvider</code></a> that provides value for the condition
- Annotation variable is over 50 characters (Or 150 if description)
- Method name is over 50 characters (Used as an identifier for storage)</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Required Annotation</code></a>,
<a href="CallEvents.html" title="enum in com.djrapitops.plan.extension"><code>for method call event types.</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callExtensionMethodsOn()">callExtensionMethodsOn</a></span>()</code></th>
<td class="colLast">
<div class="block">Determines when DataExtension methods are called automatically by Plan.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginName()">getPluginName</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the name of the plugin from PluginInfo annotation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="builder/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="#newExtensionDataBuilder()">newExtensionDataBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Obtain a new <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default <a href="builder/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>​(java.lang.String text)</code></th>
<td class="colLast">
<div class="block">Obtain a new <a href="builder/ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ValueBuilder</code></a> to use with <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</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="callExtensionMethodsOn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callExtensionMethodsOn</h4>
<pre class="methodSignature">default <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[] callExtensionMethodsOn()</pre>
<div class="block">Determines when DataExtension methods are called automatically by Plan.
<p>
Override this method to determine more suitable call times for your plugin.
You can also use <a href="Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a> to update manually.
<p>
If an empty array is supplied the DataExtension methods are not called by Plan automatically.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Event types that will trigger method calls to the DataExtension.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="CallEvents.html" title="enum in com.djrapitops.plan.extension"><code>for details when the methods are called.</code></a></dd>
</dl>
</li>
</ul>
<a id="newExtensionDataBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newExtensionDataBuilder</h4>
<pre class="methodSignature">default <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a> newExtensionDataBuilder()</pre>
<div class="block">Obtain a new <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.
<p>
Requires Capability DATA_EXTENSION_BUILDER_API</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new builder.</dd>
</dl>
</li>
</ul>
<a id="valueBuilder(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueBuilder</h4>
<pre class="methodSignature">default <a href="builder/ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a> valueBuilder​(java.lang.String text)</pre>
<div class="block">Obtain a new <a href="builder/ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ValueBuilder</code></a> to use with <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.
<p>
Requires Capability DATA_EXTENSION_BUILDER_API</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new builder.</dd>
</dl>
</li>
</ul>
<a id="getPluginName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPluginName</h4>
<pre class="methodSignature">default java.lang.String getPluginName()</pre>
<div class="block">Get the name of the plugin from PluginInfo annotation.
<p>
Requires Capability DATA_EXTENSION_BUILDER_API</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new builder.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>