mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
324 lines
30 KiB
HTML
324 lines
30 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>ExtensionSvc (Plan 5.5-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.djrapitops.plan.extension, class: ExtensionSvc">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<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="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.extension</a></div>
|
|
<h1 title="Class ExtensionSvc" class="title">Class ExtensionSvc</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">com.djrapitops.plan.extension.ExtensionSvc</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="annotations">@Singleton
|
|
</span><span class="modifiers">public class </span><span class="element-name type-name-label">ExtensionSvc</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
|
implements <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></span></div>
|
|
<div class="block">Implementation for <a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension"><code>ExtensionService</code></a>.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested-class-summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="inherited-list">
|
|
<h2 id="nested-classes-inherited-from-class-com.djrapitops.plan.extension.ExtensionService">Nested classes/interfaces inherited from interface com.djrapitops.plan.extension.<a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></h2>
|
|
<code><a href="ExtensionService.Holder.html" title="class in com.djrapitops.plan.extension">ExtensionService.Holder</a></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><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,com.djrapitops.plan.identification.UUIDUtility,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)" class="member-name-link">ExtensionSvc</a><wbr>(<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,
|
|
<a href="../identification/UUIDUtility.html" title="class in com.djrapitops.plan.identification">UUIDUtility</a> uuidUtility,
|
|
net.playeranalytics.plugin.server.PluginLogger logger,
|
|
<a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disableUpdates()" class="member-name-link">disableUpdates</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newExtensionDataBuilder(com.djrapitops.plan.extension.DataExtension)" class="member-name-link">newExtensionDataBuilder</a><wbr>(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register()" class="member-name-link">register</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register(com.djrapitops.plan.extension.DataExtension)" class="member-name-link">register</a><wbr>(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> dataExtension)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Register your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerExtensions()" class="member-name-link">registerExtensions</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unregister(com.djrapitops.plan.extension.DataExtension)" class="member-name-link">unregister</a><wbr>(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Unregister your <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> implementation.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updatePlayerValues(com.djrapitops.plan.extension.implementation.providers.gathering.DataValueGatherer,java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)" class="member-name-link">updatePlayerValues</a><wbr>(<a href="implementation/providers/gathering/DataValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">DataValueGatherer</a> gatherer,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> playerName,
|
|
<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updatePlayerValues(java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)" class="member-name-link">updatePlayerValues</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> playerName,
|
|
<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateServerValues(com.djrapitops.plan.extension.CallEvents)" class="member-name-link">updateServerValues</a><wbr>(<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateServerValues(com.djrapitops.plan.extension.implementation.providers.gathering.DataValueGatherer,com.djrapitops.plan.extension.CallEvents)" class="member-name-link">updateServerValues</a><wbr>(<a href="implementation/providers/gathering/DataValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">DataValueGatherer</a> gatherer,
|
|
<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" 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,com.djrapitops.plan.identification.UUIDUtility,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">
|
|
<h3>ExtensionSvc</h3>
|
|
<div class="member-signature"><span class="annotations">@Inject
|
|
</span><span class="modifiers">public</span> <span class="element-name">ExtensionSvc</span><wbr><span class="parameters">(<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,
|
|
<a href="../identification/UUIDUtility.html" title="class in com.djrapitops.plan.identification">UUIDUtility</a> uuidUtility,
|
|
net.playeranalytics.plugin.server.PluginLogger logger,
|
|
<a href="../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="register()">
|
|
<h3>register</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">register</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerExtensions()">
|
|
<h3>registerExtensions</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerExtensions</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="register(com.djrapitops.plan.extension.DataExtension)">
|
|
<h3>register</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="Caller.html" title="interface in com.djrapitops.plan.extension">Caller</a>></span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> dataExtension)</span></div>
|
|
<div class="block"><span class="descfrm-type-label">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 class="notes">
|
|
<dt>Specified by:</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>Parameters:</dt>
|
|
<dd><code>dataExtension</code> - Your DataExtension implementation, see <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> for requirements.</dd>
|
|
<dt>Returns:</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>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="unregister(com.djrapitops.plan.extension.DataExtension)">
|
|
<h3>unregister</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unregister</span><wbr><span class="parameters">(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</span></div>
|
|
<div class="block"><span class="descfrm-type-label">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 class="notes">
|
|
<dt>Specified by:</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>Parameters:</dt>
|
|
<dd><code>extension</code> - Your DataExtension implementation that was registered before.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="newExtensionDataBuilder(com.djrapitops.plan.extension.DataExtension)">
|
|
<h3>newExtensionDataBuilder</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="builder/ExtensionDataBuilder.html" title="interface in com.djrapitops.plan.extension.builder">ExtensionDataBuilder</a></span> <span class="element-name">newExtensionDataBuilder</span><wbr><span class="parameters">(<a href="DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a> extension)</span></div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ExtensionService.html#newExtensionDataBuilder(com.djrapitops.plan.extension.DataExtension)">ExtensionService</a></code></span></div>
|
|
<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 class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="ExtensionService.html#newExtensionDataBuilder(com.djrapitops.plan.extension.DataExtension)">newExtensionDataBuilder</a></code> in interface <code><a href="ExtensionService.html" title="interface in com.djrapitops.plan.extension">ExtensionService</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>extension</code> - Extension for which this builder is.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a new builder.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="updatePlayerValues(java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)">
|
|
<h3>updatePlayerValues</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updatePlayerValues</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> playerName,
|
|
<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="updatePlayerValues(com.djrapitops.plan.extension.implementation.providers.gathering.DataValueGatherer,java.util.UUID,java.lang.String,com.djrapitops.plan.extension.CallEvents)">
|
|
<h3>updatePlayerValues</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updatePlayerValues</span><wbr><span class="parameters">(<a href="implementation/providers/gathering/DataValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">DataValueGatherer</a> gatherer,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> playerUUID,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> playerName,
|
|
<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="updateServerValues(com.djrapitops.plan.extension.CallEvents)">
|
|
<h3>updateServerValues</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateServerValues</span><wbr><span class="parameters">(<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="updateServerValues(com.djrapitops.plan.extension.implementation.providers.gathering.DataValueGatherer,com.djrapitops.plan.extension.CallEvents)">
|
|
<h3>updateServerValues</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateServerValues</span><wbr><span class="parameters">(<a href="implementation/providers/gathering/DataValueGatherer.html" title="class in com.djrapitops.plan.extension.implementation.providers.gathering">DataValueGatherer</a> gatherer,
|
|
<a href="CallEvents.html" title="enum class in com.djrapitops.plan.extension">CallEvents</a> event)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="disableUpdates()">
|
|
<h3>disableUpdates</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">disableUpdates</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|