<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>ExtensionService (Plan 5.2-SNAPSHOT API)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> <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> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="ExtensionService (Plan 5.2-SNAPSHOT API)"; } } 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"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var pathtoroot = "../../../../"; var useModuleDirectories = true; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role="banner"> <nav role="navigation"> <div class="fixedNav"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a id="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.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" id="allclasses_navbar_top"> <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> </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> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </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> <a id="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> </div> <div class="navPadding"> </div> <script type="text/javascript"><!-- $('.navPadding').css('padding-top', $('.fixedNav').css("height")); //--> </script> </nav> </header> <!-- ======== START OF CLASS DATA ======== --> <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.extension</a></div> <h2 title="Interface ExtensionService" class="title">Interface ExtensionService</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><code><a href="ExtensionSvc.html" title="class in com.djrapitops.plan.extension">ExtensionSvc</a></code></dd> </dl> <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. <p> Obtaining instance: - Obtain instance with <a href="#getInstance()"><code>getInstance()</code></a>. - 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> - 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"> <ul class="blockList"> <li class="blockList"><a id="nested.class.summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="memberSummary"> <caption><span>Nested Classes</span><span class="tabEnd"> </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> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </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"> </td> </tr> </table> </li> </ul> </section> <!-- ========== METHOD SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </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"> <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>​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> 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<<a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a>></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(com.djrapitops.plan.extension.DataExtension)">register</a></span>​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> 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> </td> </tr> <tr id="i3" class="rowColor"> <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>​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> 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> </td> </tr> </table> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="getInstance()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInstance</h4> <pre class="methodSignature">static <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a> getInstance()</pre> <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)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre class="methodSignature">java.util.Optional<<a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a>> register​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</pre> <div class="block">Register your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation. <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> <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> <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> <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> newExtensionDataBuilder​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> 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)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>unregister</h4> <pre class="methodSignature">void unregister​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</pre> <div class="block">Unregister your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation. <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> </li> </ul> </div> </div> </main> <!-- ========= END OF CLASS DATA ========= --> <footer role="contentinfo"> <nav role="navigation"> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a id="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.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" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses.html">All 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> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </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> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>