Plan/all/com/djrapitops/plan/extension/implementation/ExtensionWrapper.html

472 lines
18 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>ExtensionWrapper (Plan 5.3-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="ExtensionWrapper (Plan 5.3-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
2019-08-05 11:13:19 +02:00
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>
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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.implementation</a></div>
2020-03-21 15:43:05 +01:00
<h2 title="Class ExtensionWrapper" class="title">Class ExtensionWrapper</h2>
2019-08-05 11:13:19 +02:00
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2020-03-21 15:43:05 +01:00
<li>com.djrapitops.plan.extension.implementation.ExtensionWrapper</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
2020-03-21 15:43:05 +01:00
<pre>public class <span class="typeNameLabel">ExtensionWrapper</span>
2019-08-05 11:13:19 +02:00
extends java.lang.Object</pre>
<div class="block">Represents information defined in a <a href="../DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> class.
2020-03-21 15:43:05 +01:00
<p>
Extracts objects that can be used to obtain data from a <a href="../DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a>.
2019-08-05 11:13:19 +02:00
<p>
Goal of this class is to abstract away DataExtension API annotations so that they will not be needed outside when calling methods.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.extension.DataExtension)">ExtensionWrapper</a></span>&#8203;(<a href="../DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</code></th>
<td class="colLast">
2020-03-21 15:43:05 +01:00
<div class="block">Create an ExtensionWrapper.</div>
2019-08-05 11:13:19 +02:00
</td>
</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">
2019-08-05 11:13:19 +02:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCallEvents()">getCallEvents</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-01-24 11:56:15 +01:00
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtension()">getExtension</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-01-24 11:56:15 +01:00
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../extractor/ExtensionExtractor.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionExtractor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtractor()">getExtractor</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>java.util.Collection&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInvalidatedMethods()">getInvalidatedMethods</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;<a href="../extractor/ExtensionMethod.ParameterType.html" title="enum in com.djrapitops.plan.extension.extractor">ExtensionMethod.ParameterType</a>,&#8203;<a href="../extractor/ExtensionMethods.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionMethods</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethods()">getMethods</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginIcon()">getPluginIcon</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation">PluginInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginInfo()">getPluginInfo</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginName()">getPluginName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="TabInformation.html" title="class in com.djrapitops.plan.extension.implementation">TabInformation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginTabs()">getPluginTabs</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../annotation/TabInfo.html" title="annotation in com.djrapitops.plan.extension.annotation">TabInfo</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTabInformation()">getTabInformation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i10" class="altColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>java.util.Optional&lt;java.lang.String[]&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTabOrder()">getTabOrder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-03-21 15:43:05 +01:00
</tr>
<tr id="i11" class="rowColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>java.util.Collection&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWarnings()">getWarnings</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(com.djrapitops.plan.extension.DataExtension)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-03-21 15:43:05 +01:00
<h4>ExtensionWrapper</h4>
<pre>public&nbsp;ExtensionWrapper&#8203;(<a href="../DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension)</pre>
2020-03-21 15:43:05 +01:00
<div class="block">Create an ExtensionWrapper.</div>
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extension</code> - DataExtension to extract information from.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If something is badly wrong with the specified extension class annotations.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ============ 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="getCallEvents()">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCallEvents</h4>
<pre class="methodSignature">public&nbsp;<a href="../CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[]&nbsp;getCallEvents()</pre>
2020-03-21 15:43:05 +01:00
</li>
</ul>
<a id="getExtension()">
2020-03-21 15:43:05 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtension</h4>
<pre class="methodSignature">public&nbsp;<a href="../DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;getExtension()</pre>
2020-03-21 15:43:05 +01:00
</li>
</ul>
<a id="getPluginName()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getPluginName()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getPluginIcon()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginIcon</h4>
<pre class="methodSignature">public&nbsp;<a href="../icon/Icon.html" title="class in com.djrapitops.plan.extension.icon">Icon</a>&nbsp;getPluginIcon()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getPluginTabs()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginTabs</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;<a href="TabInformation.html" title="class in com.djrapitops.plan.extension.implementation">TabInformation</a>&gt;&nbsp;getPluginTabs()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getTabOrder()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTabOrder</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;java.lang.String[]&gt;&nbsp;getTabOrder()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getInvalidatedMethods()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInvalidatedMethods</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;getInvalidatedMethods()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getWarnings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarnings</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;getWarnings()</pre>
</li>
</ul>
<a id="getExtractor()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtractor</h4>
<pre class="methodSignature">public&nbsp;<a href="../extractor/ExtensionExtractor.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionExtractor</a>&nbsp;getExtractor()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getPluginInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginInfo</h4>
<pre class="methodSignature">public&nbsp;<a href="../annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation">PluginInfo</a>&nbsp;getPluginInfo()</pre>
</li>
</ul>
<a id="getTabInformation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTabInformation</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="../annotation/TabInfo.html" title="annotation in com.djrapitops.plan.extension.annotation">TabInfo</a>&gt;&nbsp;getTabInformation()</pre>
</li>
</ul>
<a id="getMethods()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMethods</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;<a href="../extractor/ExtensionMethod.ParameterType.html" title="enum in com.djrapitops.plan.extension.extractor">ExtensionMethod.ParameterType</a>,&#8203;<a href="../extractor/ExtensionMethods.html" title="class in com.djrapitops.plan.extension.extractor">ExtensionMethods</a>&gt;&nbsp;getMethods()</pre>
2019-08-05 11:13:19 +02:00
</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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>