mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 08:20:39 +01:00
251 lines
18 KiB
HTML
251 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (16) -->
|
|
<title>DataExtension (Plan 5.4-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, interface: DataExtension">
|
|
<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">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">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" 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</a></div>
|
|
<h1 title="Interface DataExtension" class="title">Interface DataExtension</h1>
|
|
</div>
|
|
<section class="description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DataExtension</span></div>
|
|
<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 <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> 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 class="notes">
|
|
<dt>See Also:</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 class in com.djrapitops.plan.extension"><code>for method call event types.</code></a></dd>
|
|
</dl>
|
|
</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-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-tab2 method-summary-table-tab5 method-summary-table"><code>default <a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a>[]</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#callExtensionMethodsOn()">callExtensionMethodsOn</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table">
|
|
<div class="block">Determines when DataExtension methods are called automatically by Plan.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default <a href="https://docs.oracle.com/en/java/javase/16/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-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getPluginName()">getPluginName</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table">
|
|
<div class="block">Get the name of the plugin from PluginInfo annotation.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#newExtensionDataBuilder()">newExtensionDataBuilder</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table">
|
|
<div class="block">Obtain a new <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default <a href="builder/ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#valueBuilder(java.lang.String)">valueBuilder</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/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-tab2 method-summary-table-tab5 method-summary-table">
|
|
<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>
|
|
</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="callExtensionMethodsOn()">
|
|
<h3>callExtensionMethodsOn</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a>[]</span> <span class="element-name">callExtensionMethodsOn</span>()</div>
|
|
<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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Event types that will trigger method calls to the DataExtension.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd><a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension"><code>for details when the methods are called.</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="newExtensionDataBuilder()">
|
|
<h3>newExtensionDataBuilder</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">newExtensionDataBuilder</span>()</div>
|
|
<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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>new builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="valueBuilder(java.lang.String)">
|
|
<h3>valueBuilder</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="builder/ValueBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ValueBuilder</a></span> <span class="element-name">valueBuilder</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/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">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 class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>new builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getPluginName()">
|
|
<h3>getPluginName</h3>
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/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">getPluginName</span>()</div>
|
|
<div class="block">Get the name of the plugin from PluginInfo annotation.
|
|
<p>
|
|
Requires Capability DATA_EXTENSION_BUILDER_API</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>new builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|