Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 08:20:39 +01:00
Code Issues Projects Releases Wiki Activity
fe89b52a4e
Plan/all/com/djrapitops/plan/extension/annotation/GroupProvider.html

208 lines
9.9 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>GroupProvider (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.annotation, annotation type: GroupProvider">
<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 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">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.interface.optional.element.summary">Optional</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.interface.element.detail">Element</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 ======== -->
<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.annotation</a></div>
<h1 title="Annotation Interface GroupProvider" class="title">Annotation Interface GroupProvider</h1>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">GroupProvider</span></div>
<div class="block">Method annotation to provide <code>String[]</code> array of Group names about a Player.
<p>
This method annotation only works when used with <code>UUID</code> or <code>String</code> as a method parameter (for Players).
<p>
For example:
<code>@GroupProvider public String[] getJobs(UUID playerUUID) {}</code>
<p>
Group data is parsed as Table for /server and /network page and similar to <a href="StringProvider.html" title="annotation in com.djrapitops.plan.extension.annotation"><code>StringProvider</code></a> for /player page.
<p>
Requires Capability <code>DATA_EXTENSION_GROUPS</code></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== -->
<li>
<section class="member-summary" id="annotation.interface.optional.element.summary">
<h2>Optional Element Summary</h2>
<div class="caption"><span>Optional Elements</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">Optional Element</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a></code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#groupColor()">groupColor</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Determine the color of the table header for this group.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../icon/Family.html" title="enum class in com.djrapitops.plan.extension.icon">Family</a></code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#iconFamily()">iconFamily</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Family of Font Awesome icon.</div>
</div>
<div class="col-first even-row-color"><code><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></code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#iconName()">iconName</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Name of Font Awesome icon.</div>
</div>
<div class="col-first odd-row-color"><code><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></code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#text()">text</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Text displayed before the value, limited to 50 characters.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details" id="annotation.interface.element.detail">
<ul class="details-list">
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
<li>
<section class="member-details">
<h2>Element Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="text()">
<h3>text</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">text</span></div>
<div class="block">Text displayed before the value, limited to 50 characters.
<p>
Should inform the user what the group names represent, for example
"Town" or "Job"</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>String of max 50 characters, remainder will be clipped.</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd>"Group"</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="groupColor()">
<h3>groupColor</h3>
<div class="member-signature"><span class="return-type"><a href="../icon/Color.html" title="enum class in com.djrapitops.plan.extension.icon">Color</a></span>&nbsp;<span class="element-name">groupColor</span></div>
<div class="block">Determine the color of the table header for this group.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Preferred color. If none are specified defaults are used.</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd>NONE</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="iconName()">
<h3>iconName</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">iconName</span></div>
<div class="block">Name of Font Awesome icon.
<p>
See https://fontawesome.com/icons (select 'free')) for icons and their <a href="../icon/Family.html" title="enum class in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Name of the icon, if name is not valid no icon is shown.</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd>"circle"</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="iconFamily()">
<h3>iconFamily</h3>
<div class="member-signature"><span class="return-type"><a href="../icon/Family.html" title="enum class in com.djrapitops.plan.extension.icon">Family</a></span>&nbsp;<span class="element-name">iconFamily</span></div>
<div class="block">Family of Font Awesome icon.
<p>
See https://fontawesome.com/icons (select 'free')) for icons and their <a href="../icon/Family.html" title="enum class in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Family that matches an icon, if there is no icon for this family no icon is shown.</dd>
</dl>
<dl class="notes">
<dt>Default:</dt>
<dd>SOLID</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink