Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 16:29:31 +01:00
Code Issues Projects Releases Wiki Activity
635b6f4989
Plan/api/com/djrapitops/plan/extension/DataExtension.html
Rsl1122 635b6f4989 Updated javadocs
2020-01-24 12:56:15 +02:00

286 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc (1.8.0_201) on Fri Jan 24 12:54:01 EET 2020 -->
<title>DataExtension (api 5.0-SNAPSHOT API)</title>
<meta name="date" content="2020-01-24">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataExtension (api 5.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li><a href="../../../../com/djrapitops/plan/extension/CallEvents.html" title="enum in com.djrapitops.plan.extension"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/extension/ElementOrder.html" title="enum in com.djrapitops.plan.extension"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/extension/DataExtension.html" target="_top">Frames</a></li>
<li><a href="DataExtension.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.extension</div>
<h2 title="Interface DataExtension" class="title">Interface DataExtension</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<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="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a>.
<a href="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/DoubleProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>DoubleProvider</code></a> for <code>double</code> values.
<a href="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/StringProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>StringProvider</code></a> for <code>String</code> values.
<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="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a> A <code>boolean</code> returned by <a href="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/TabInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>TabInfo</code></a> Optional Structure information about a tab
<a href="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/DataExtension.html#callExtensionMethodsOn--"><code>callExtensionMethodsOn()</code></a> and <a href="../../../../com/djrapitops/plan/extension/Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a>.
<p>
You can check against implementation violations by using <a href="../../../../com/djrapitops/plan/extension/extractor/ExtensionExtractor.html#validateAnnotations--"><code>ExtensionExtractor.validateAnnotations()</code></a> in your Unit Tests.
<p>
Implementation violations:
- No <a href="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/BooleanProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>BooleanProvider</code></a> is annotated with a <a href="../../../../com/djrapitops/plan/extension/annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a> that requires same condition the provider provides.
- <a href="../../../../com/djrapitops/plan/extension/annotation/Conditional.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Conditional</code></a> without a <a href="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>Required Annotation</code></a>,
<a href="../../../../com/djrapitops/plan/extension/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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default <a href="../../../../com/djrapitops/plan/extension/CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/extension/DataExtension.html#callExtensionMethodsOn--">callExtensionMethodsOn</a></span>()</code>
<div class="block">Determines when DataExtension methods are called automatically by Plan.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="callExtensionMethodsOn--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>callExtensionMethodsOn</h4>
<pre>default&nbsp;<a href="../../../../com/djrapitops/plan/extension/CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[]&nbsp;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="../../../../com/djrapitops/plan/extension/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="../../../../com/djrapitops/plan/extension/CallEvents.html" title="enum in com.djrapitops.plan.extension"><code>for details when the methods are called.</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li><a href="../../../../com/djrapitops/plan/extension/CallEvents.html" title="enum in com.djrapitops.plan.extension"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/extension/ElementOrder.html" title="enum in com.djrapitops.plan.extension"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/extension/DataExtension.html" target="_top">Frames</a></li>
<li><a href="DataExtension.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink