Plan/api/com/djrapitops/plan/extension/ExtensionService.html

367 lines
15 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>ExtensionService (api 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="ExtensionService (api 5.4-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
2019-08-05 11:13:19 +02:00
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><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&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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 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>
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.extension</a></div>
2019-08-05 11:13:19 +02:00
<h2 title="Interface ExtensionService" class="title">Interface ExtensionService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">ExtensionService</span></pre>
<div class="block">Interface for registering <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a>s.
2019-08-05 11:13:19 +02:00
<p>
Obtaining instance:
- Obtain instance with <a href="#getInstance()"><code>getInstance()</code></a>.
2019-08-05 11:13:19 +02:00
- Make sure to catch a possible NoClassDefFoundError in case Plan is not installed
- Catch IllegalStateException in case ExtensionService is not enabled
<p>
Registering <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a>:
- Register your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> with <a href="#register(com.djrapitops.plan.extension.DataExtension)"><code>register(DataExtension)</code></a>
2019-08-05 11:13:19 +02:00
- Catch a possible IllegalArgumentException in case the DataExtension implementation is invalid.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ExtensionService.Holder.html" title="class in com.djrapitops.plan.extension">ExtensionService.Holder</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
2019-08-05 11:13:19 +02:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<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">
<td class="colFirst"><code>static <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
<td class="colLast">
2019-08-05 11:13:19 +02:00
<div class="block">Obtain instance of ExtensionService.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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(com.djrapitops.plan.extension.DataExtension)">newExtensionDataBuilder</a></span>&#8203;(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</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>, it is recommended to use <a href="DataExtension.html#newExtensionDataBuilder()"><code>DataExtension.newExtensionDataBuilder()</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;<a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(com.djrapitops.plan.extension.DataExtension)">register</a></span>&#8203;(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</code></th>
<td class="colLast">
<div class="block">Register your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
<tr id="i3" class="rowColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unregister(com.djrapitops.plan.extension.DataExtension)">unregister</a></span>&#8203;(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</code></th>
<td class="colLast">
<div class="block">Unregister your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation.</div>
2019-08-05 11:13:19 +02:00
</td>
</tr>
</table>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getInstance()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">static&nbsp;<a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a>&nbsp;getInstance()</pre>
2019-08-05 11:13:19 +02:00
<div class="block">Obtain instance of ExtensionService.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ExtensionService implementation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NoClassDefFoundError</code> - If Plan is not installed and this class can not be found or if older Plan version is installed.</dd>
<dd><code>java.lang.IllegalStateException</code> - If Plan is installed, but not enabled.</dd>
</dl>
</li>
</ul>
<a id="register(com.djrapitops.plan.extension.DataExtension)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">java.util.Optional&lt;<a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a>&gt;&nbsp;register&#8203;(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</pre>
<div class="block">Register your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation.
2019-08-05 11:13:19 +02:00
<p>
You can use <a href="extractor/ExtensionExtractor.html#validateAnnotations()"><code>ExtensionExtractor.validateAnnotations()</code></a> in your Unit Tests to prevent IllegalArgumentExceptions here at runtime.</div>
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extension</code> - Your DataExtension implementation, see <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> for requirements.</dd>
2019-08-05 11:13:19 +02:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional <a href="Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a> that can be used to call for data update in Plan database manually - If the Optional is not present the user has disabled the extension in Plan config.</dd>
2019-08-05 11:13:19 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If an implementation violation is found.</dd>
</dl>
</li>
</ul>
<a id="newExtensionDataBuilder(com.djrapitops.plan.extension.DataExtension)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newExtensionDataBuilder</h4>
<pre class="methodSignature"><a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a>&nbsp;newExtensionDataBuilder&#8203;(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</pre>
<div class="block">Obtain a new <a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder"><code>ExtensionDataBuilder</code></a>, it is recommended to use <a href="DataExtension.html#newExtensionDataBuilder()"><code>DataExtension.newExtensionDataBuilder()</code></a>.
<p>
Requires Capability DATA_EXTENSION_BUILDER_API</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extension</code> - Extension for which this builder is.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new builder.</dd>
</dl>
</li>
</ul>
<a id="unregister(com.djrapitops.plan.extension.DataExtension)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unregister</h4>
<pre class="methodSignature">void&nbsp;unregister&#8203;(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</pre>
<div class="block">Unregister your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation.
2019-08-05 11:13:19 +02:00
<p>
This method should be used if calling methods on the DataExtension suddenly becomes unavailable, due to
plugin disable for example.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extension</code> - Your DataExtension implementation that was registered before.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
</div>
</main>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<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><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&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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 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>