<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>ExtensionSvc (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="ExtensionSvc (Plan 5.2-SNAPSHOT API)"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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="Class ExtensionSvc" class="title">Class ExtensionSvc</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.djrapitops.plan.extension.ExtensionSvc</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><code><a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></code></dd> </dl> <hr> <pre>@Singleton public class <span class="typeNameLabel">ExtensionSvc</span> extends java.lang.Object implements <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></pre> <div class="block">Implementation for <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension"><code>ExtensionService</code></a>.</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> <ul class="blockList"> <li class="blockList"><a id="nested.classes.inherited.from.class.com.djrapitops.plan.extension.ExtensionService"> <!-- --> </a> <h3>Nested classes/interfaces inherited from interface com.djrapitops.plan.extension.<a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></h3> <code><a href="ExtensionService.Holder.html" title="class in com.djrapitops.plan.extension">ExtensionService.Holder</a></code></li> </ul> </li> </ul> </section> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Constructor</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.processing.Processing,com.djrapitops.plan.extension.implementation.ExtensionRegister,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">ExtensionSvc</a></span>​(<a href="../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config, <a href="../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a> dbSystem, <a href="../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a> serverInfo, <a href="../processing/Processing.html" title="class in com.djrapitops.plan.processing">Processing</a> processing, <a href="implementation/ExtensionRegister.html" title="class in com.djrapitops.plan.extension.implementation">ExtensionRegister</a> extensionRegister, net.playeranalytics.plugin.server.PluginLogger logger, <a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register()">register</a></span>()</code></th> <td class="colLast"> </td> </tr> <tr id="i1" class="rowColor"> <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="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerExtensions()">registerExtensions</a></span>()</code></th> <td class="colLast"> </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> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updatePlayerValues(com.djrapitops.plan.extension.implementation.providers.gathering.ProviderValueGatherer,java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)">updatePlayerValues</a></span>​(<a href="implementation/providers/gathering/ProviderValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">ProviderValueGatherer</a> gatherer, java.util.UUID playerUUID, java.lang.String playerName, <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</code></th> <td class="colLast"> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updatePlayerValues(java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)">updatePlayerValues</a></span>​(java.util.UUID playerUUID, java.lang.String playerName, <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</code></th> <td class="colLast"> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateServerValues(com.djrapitops.plan.extension.CallEvents)">updateServerValues</a></span>​(<a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</code></th> <td class="colLast"> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateServerValues(com.djrapitops.plan.extension.implementation.providers.gathering.ProviderValueGatherer,com.djrapitops.plan.extension.CallEvents)">updateServerValues</a></span>​(<a href="implementation/providers/gathering/ProviderValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">ProviderValueGatherer</a> gatherer, <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</code></th> <td class="colLast"> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a id="<init>(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.processing.Processing,com.djrapitops.plan.extension.implementation.ExtensionRegister,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ExtensionSvc</h4> <pre>@Inject public ExtensionSvc​(<a href="../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config, <a href="../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a> dbSystem, <a href="../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a> serverInfo, <a href="../processing/Processing.html" title="class in com.djrapitops.plan.processing">Processing</a> processing, <a href="implementation/ExtensionRegister.html" title="class in com.djrapitops.plan.extension.implementation">ExtensionRegister</a> extensionRegister, net.playeranalytics.plugin.server.PluginLogger logger, <a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</pre> </li> </ul> </li> </ul> </section> <!-- ============ METHOD DETAIL ========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a id="register()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre class="methodSignature">public void register()</pre> </li> </ul> <a id="registerExtensions()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>registerExtensions</h4> <pre class="methodSignature">public void registerExtensions()</pre> </li> </ul> <a id="register(com.djrapitops.plan.extension.DataExtension)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre class="methodSignature">public 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ExtensionService.html#register(com.djrapitops.plan.extension.DataExtension)">ExtensionService</a></code></span></div> <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="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="ExtensionService.html#register(com.djrapitops.plan.extension.DataExtension)">register</a></code> in interface <code><a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></code></dd> <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> </dl> </li> </ul> <a id="unregister(com.djrapitops.plan.extension.DataExtension)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>unregister</h4> <pre class="methodSignature">public void unregister​(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ExtensionService.html#unregister(com.djrapitops.plan.extension.DataExtension)">ExtensionService</a></code></span></div> <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="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="ExtensionService.html#unregister(com.djrapitops.plan.extension.DataExtension)">unregister</a></code> in interface <code><a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>extension</code> - Your DataExtension implementation that was registered before.</dd> </dl> </li> </ul> <a id="updatePlayerValues(java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>updatePlayerValues</h4> <pre class="methodSignature">public void updatePlayerValues​(java.util.UUID playerUUID, java.lang.String playerName, <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</pre> </li> </ul> <a id="updatePlayerValues(com.djrapitops.plan.extension.implementation.providers.gathering.ProviderValueGatherer,java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>updatePlayerValues</h4> <pre class="methodSignature">public void updatePlayerValues​(<a href="implementation/providers/gathering/ProviderValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">ProviderValueGatherer</a> gatherer, java.util.UUID playerUUID, java.lang.String playerName, <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</pre> </li> </ul> <a id="updateServerValues(com.djrapitops.plan.extension.CallEvents)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>updateServerValues</h4> <pre class="methodSignature">public void updateServerValues​(<a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</pre> </li> </ul> <a id="updateServerValues(com.djrapitops.plan.extension.implementation.providers.gathering.ProviderValueGatherer,com.djrapitops.plan.extension.CallEvents)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>updateServerValues</h4> <pre class="methodSignature">public void updateServerValues​(<a href="implementation/providers/gathering/ProviderValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">ProviderValueGatherer</a> gatherer, <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> event)</pre> </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><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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>