2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
2021-03-10 09:12:21 +01:00
< title > DataExtension (api 5.2-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../jquery/jquery-ui.css" title = "Style" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-03-10 09:12:21 +01:00
parent.document.title="DataExtension (api 5.2-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"i0":18};
2019-08-05 11:13:19 +02:00
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";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< 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" >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.extension< / a > < / div >
2019-08-05 11:13:19 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
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 > .
2019-08-05 11:13:19 +02:00
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:
2021-03-10 09:12:21 +01:00
< 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.
2019-08-05 11:13:19 +02:00
< 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
2021-03-10 09:12:21 +01:00
< 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)
2019-08-05 11:13:19 +02:00
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.
2021-03-10 09:12:21 +01:00
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 >
2019-08-05 11:13:19 +02:00
< p >
Some additional annotations are available for controlling appearance of the results:
2021-03-10 09:12:21 +01:00
< 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
2019-08-05 11:13:19 +02:00
< hr >
< p >
2021-03-10 09:12:21 +01:00
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 > .
2019-08-05 11:13:19 +02:00
< p >
2021-03-10 09:12:21 +01:00
You can check against implementation violations by using < a href = "extractor/ExtensionExtractor.html#validateAnnotations()" > < code > ExtensionExtractor.validateAnnotations()< / code > < / a > in your Unit Tests.
2019-08-05 11:13:19 +02:00
< p >
Implementation violations:
2021-03-10 09:12:21 +01:00
- No < a href = "annotation/PluginInfo.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < code > PluginInfo< / code > < / a > class annotation
2019-08-05 11:13:19 +02:00
- 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)
2021-03-10 09:12:21 +01:00
- < 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
2019-08-05 11:13:19 +02:00
- 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 >
2021-03-10 09:12:21 +01:00
< 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 >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========== METHOD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2019-08-05 11:13:19 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i0" class = "altColor" >
2021-03-10 09:12:21 +01:00
< 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" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Determines when DataExtension methods are called automatically by Plan.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-08-05 11:13:19 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "callExtensionMethodsOn()" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > callExtensionMethodsOn< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > default < a href = "CallEvents.html" title = "enum in com.djrapitops.plan.extension" > CallEvents< / a > [] callExtensionMethodsOn()< / pre >
2019-08-05 11:13:19 +02:00
< 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.
2021-03-10 09:12:21 +01:00
You can also use < a href = "Caller.html" title = "interface in com.djrapitops.plan.extension" > < code > Caller< / code > < / a > to update manually.
2019-08-05 11:13:19 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< dd > < a href = "CallEvents.html" title = "enum in com.djrapitops.plan.extension" > < code > for details when the methods are called.< / code > < / a > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< 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" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../allclasses.html" > All Classes< / a > < / li >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-08-05 11:13:19 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2019-08-05 11:13:19 +02:00
< / body >
< / html >
