Plan/all/com/djrapitops/plan/extension/package-summary.html

264 lines
9.3 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>com.djrapitops.plan.extension (Plan 5.4-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">
<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>
<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) {
parent.document.title="com.djrapitops.plan.extension (Plan 5.4-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
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>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<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>
<a id="navbar.top.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li class="navBarCell1Rev">Package</li>
<li>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&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-08-05 11:13:19 +02:00
</div>
<a id="skip.navbar.top">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
2019-08-05 11:13:19 +02:00
<div class="header">
<h1 title="Package" class="title">Package&nbsp;com.djrapitops.plan.extension</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">DataExtension API and related classes.
<a href="https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API">Documentation</a></div>
</section>
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Interface for manually calling update methods on a registered <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a>.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Interface to implement data extensions with.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Interface for registering <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a>s.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Group.html" title="interface in com.djrapitops.plan.extension">Group</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Method parameter for providing values about a group with provider annotations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExtensionServerDataUpdater.html" title="class in com.djrapitops.plan.extension">ExtensionServerDataUpdater</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Task for updating <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> server values periodically.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExtensionService.Holder.html" title="class in com.djrapitops.plan.extension">ExtensionService.Holder</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExtensionSvc.html" title="class in com.djrapitops.plan.extension">ExtensionSvc</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Implementation for <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension"><code>ExtensionService</code></a>.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Enum representing different events when Plan calls methods of <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> automatically.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ElementOrder.html" title="enum in com.djrapitops.plan.extension">ElementOrder</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Enum representing big elements of a plugin.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FormatType.html" title="enum in com.djrapitops.plan.extension">FormatType</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Enum for determining additional formatter for a value given by a <a href="annotation/NumberProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>NumberProvider</code></a>.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="NotReadyException.html" title="class in com.djrapitops.plan.extension">NotReadyException</a></th>
2019-08-05 11:13:19 +02:00
<td class="colLast">
<div class="block">Exception to throw inside DataExtension if a method is not ready to be called (Data is not available etc).</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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>
<a id="navbar.bottom.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li class="navBarCell1Rev">Package</li>
<li>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&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-08-05 11:13:19 +02:00
</div>
<a id="skip.navbar.bottom">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2019-08-05 11:13:19 +02:00
</body>
</html>