Plan/all/com/djrapitops/plan/extension/implementation/providers/Parameters.html

222 lines
18 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2020-03-21 15:43:05 +01:00
<!-- NewPage -->
<html lang="en">
2020-03-21 15:43:05 +01:00
<head>
<!-- Generated by javadoc (16) -->
<title>Parameters (Plan 5.4-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.implementation.providers, interface: Parameters">
<meta name="generator" content="javadoc/ClassWriterImpl">
2020-03-21 15:43:05 +01:00
<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">
2020-03-21 15:43:05 +01:00
<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>
2020-03-21 15:43:05 +01:00
</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>
2020-03-21 15:43:05 +01:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
2020-03-21 15:43:05 +01:00
<!-- ========= 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>
2020-03-21 15:43:05 +01:00
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
2020-03-21 15:43:05 +01:00
<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="sub-nav">
2020-03-21 15:43:05 +01:00
<div>
<ul class="sub-nav-list">
2020-03-21 15:43:05 +01:00
<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="sub-nav-list">
2020-03-21 15:43:05 +01:00
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" 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 ======== -->
2020-03-21 15:43:05 +01:00
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.extension.implementation.providers</a></div>
<h1 title="Interface Parameters" class="title">Interface Parameters</h1>
2020-03-21 15:43:05 +01:00
</div>
<section class="description">
<dl class="notes">
2020-03-21 15:43:05 +01:00
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="Parameters.GroupParameters.html" title="class in com.djrapitops.plan.extension.implementation.providers">Parameters.GroupParameters</a></code>, <code><a href="Parameters.PlayerParameters.html" title="class in com.djrapitops.plan.extension.implementation.providers">Parameters.PlayerParameters</a></code>, <code><a href="Parameters.ServerParameters.html" title="class in com.djrapitops.plan.extension.implementation.providers">Parameters.ServerParameters</a></code></dd>
2020-03-21 15:43:05 +01:00
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Parameters</span></div>
</section>
<section class="summary">
<ul class="summary-list">
2020-03-21 15:43:05 +01:00
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested.class.summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="Parameters.GroupParameters.html" title="class in com.djrapitops.plan.extension.implementation.providers">Parameters.GroupParameters</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="Parameters.PlayerParameters.html" title="class in com.djrapitops.plan.extension.implementation.providers">Parameters.PlayerParameters</a></span></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="Parameters.ServerParameters.html" title="class in com.djrapitops.plan.extension.implementation.providers">Parameters.ServerParameters</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
2020-03-21 15:43:05 +01:00
</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab2 method-summary-table method-summary-table-tab3"><code><a href="../MethodType.html" title="enum class in com.djrapitops.plan.extension.implementation">MethodType</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getMethodType()">getMethodType</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getPlayerUUID()">getPlayerUUID</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getServerUUID()">getServerUUID</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table"><code>static <a href="Parameters.html" title="interface in com.djrapitops.plan.extension.implementation.providers">Parameters</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table"><code><span class="member-name-link"><a href="#group(com.djrapitops.plan.identification.ServerUUID,java.lang.String)">group</a></span>&#8203;(<a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;serverUUID,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupName)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table"><code>static <a href="Parameters.html" title="interface in com.djrapitops.plan.extension.implementation.providers">Parameters</a></code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table"><code><span class="member-name-link"><a href="#player(com.djrapitops.plan.identification.ServerUUID,java.util.UUID,java.lang.String)">player</a></span>&#8203;(<a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;serverUUID,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;playerUUID,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;playerName)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table"><code>static <a href="Parameters.html" title="interface in com.djrapitops.plan.extension.implementation.providers">Parameters</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table"><code><span class="member-name-link"><a href="#server(com.djrapitops.plan.identification.ServerUUID)">server</a></span>&#8203;(<a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;serverUUID)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#usingOn(com.djrapitops.plan.extension.DataExtension,java.lang.reflect.Method)">usingOn</a></span>&#8203;(<a href="../../DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a>&nbsp;method)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
</div>
</div>
</div>
</section>
2020-03-21 15:43:05 +01:00
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
2020-03-21 15:43:05 +01:00
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="player(com.djrapitops.plan.identification.ServerUUID,java.util.UUID,java.lang.String)">
<h3>player</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="Parameters.html" title="interface in com.djrapitops.plan.extension.implementation.providers">Parameters</a></span>&nbsp;<span class="element-name">player</span>&#8203;<span class="parameters">(<a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;serverUUID,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;playerUUID,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;playerName)</span></div>
</section>
2020-03-21 15:43:05 +01:00
</li>
<li>
<section class="detail" id="server(com.djrapitops.plan.identification.ServerUUID)">
<h3>server</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="Parameters.html" title="interface in com.djrapitops.plan.extension.implementation.providers">Parameters</a></span>&nbsp;<span class="element-name">server</span>&#8203;<span class="parameters">(<a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;serverUUID)</span></div>
</section>
2020-03-21 15:43:05 +01:00
</li>
<li>
<section class="detail" id="group(com.djrapitops.plan.identification.ServerUUID,java.lang.String)">
<h3>group</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="Parameters.html" title="interface in com.djrapitops.plan.extension.implementation.providers">Parameters</a></span>&nbsp;<span class="element-name">group</span>&#8203;<span class="parameters">(<a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&nbsp;serverUUID,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupName)</span></div>
</section>
2020-03-21 15:43:05 +01:00
</li>
<li>
<section class="detail" id="usingOn(com.djrapitops.plan.extension.DataExtension,java.lang.reflect.Method)">
<h3>usingOn</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">usingOn</span>&#8203;<span class="parameters">(<a href="../../DataExtension.html" title="interface in com.djrapitops.plan.extension">DataExtension</a>&nbsp;extension,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a>&nbsp;method)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/reflect/InvocationTargetException.html" title="class or interface in java.lang.reflect" class="external-link">InvocationTargetException</a>,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalAccessException.html" title="class or interface in java.lang" class="external-link">IllegalAccessException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/reflect/InvocationTargetException.html" title="class or interface in java.lang.reflect" class="external-link">InvocationTargetException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalAccessException.html" title="class or interface in java.lang" class="external-link">IllegalAccessException</a></code></dd>
2020-03-21 15:43:05 +01:00
</dl>
</section>
2020-03-21 15:43:05 +01:00
</li>
<li>
<section class="detail" id="getMethodType()">
<h3>getMethodType</h3>
<div class="member-signature"><span class="return-type"><a href="../MethodType.html" title="enum class in com.djrapitops.plan.extension.implementation">MethodType</a></span>&nbsp;<span class="element-name">getMethodType</span>()</div>
</section>
2020-03-21 15:43:05 +01:00
</li>
<li>
<section class="detail" id="getServerUUID()">
<h3>getServerUUID</h3>
<div class="member-signature"><span class="return-type"><a href="../../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a></span>&nbsp;<span class="element-name">getServerUUID</span>()</div>
</section>
2020-03-21 15:43:05 +01:00
</li>
<li>
<section class="detail" id="getPlayerUUID()">
<h3>getPlayerUUID</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></span>&nbsp;<span class="element-name">getPlayerUUID</span>()</div>
</section>
2020-03-21 15:43:05 +01:00
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
</li>
</ul>
</section>
2020-03-21 15:43:05 +01:00
<!-- ========= END OF CLASS DATA ========= -->
</main>
2020-03-21 15:43:05 +01:00
</div>
</div>
</body>
</html>