<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <title>GroupProvider (api 5.4-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="GroupProvider (api 5.4-SNAPSHOT API)"; } } catch(err) { } //--> 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>Field | </li> <li>Required | </li> <li><a href="#annotation.type.optional.element.summary">Optional</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#annotation.type.element.detail">Element</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.annotation</a></div> <h2 title="Annotation Type GroupProvider" class="title">Annotation Type GroupProvider</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <pre>@Retention(RUNTIME) @Target(METHOD) public @interface <span class="memberNameLabel">GroupProvider</span></pre> <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> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="annotation.type.optional.element.summary"> <!-- --> </a> <h3>Optional Element Summary</h3> <table class="memberSummary"> <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Optional Element</th> <th class="colLast" scope="col">Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupColor()">groupColor</a></span></code></th> <td class="colLast"> <div class="block">Determine the color of the table header for this group.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../icon/Family.html" title="enum in com.djrapitops.plan.extension.icon">Family</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iconFamily()">iconFamily</a></span></code></th> <td class="colLast"> <div class="block">Family of Font Awesome icon.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iconName()">iconName</a></span></code></th> <td class="colLast"> <div class="block">Name of Font Awesome icon.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#text()">text</a></span></code></th> <td class="colLast"> <div class="block">Text displayed before the value, limited to 50 characters.</div> </td> </tr> </table> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="annotation.type.element.detail"> <!-- --> </a> <h3>Element Detail</h3> <a id="text()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>text</h4> <pre>java.lang.String text</pre> <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> <dt><span class="returnLabel">Returns:</span></dt> <dd>String of max 50 characters, remainder will be clipped.</dd> </dl> <dl> <dt>Default:</dt> <dd>"Group"</dd> </dl> </li> </ul> </li> </ul> </section> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="groupColor()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>groupColor</h4> <pre><a href="../icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> groupColor</pre> <div class="block">Determine the color of the table header for this group.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Preferred color. If none are specified defaults are used.</dd> </dl> <dl> <dt>Default:</dt> <dd>com.djrapitops.plan.extension.icon.Color.NONE</dd> </dl> </li> </ul> </li> </ul> </section> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="iconName()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>iconName</h4> <pre>java.lang.String iconName</pre> <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 in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Name of the icon, if name is not valid no icon is shown.</dd> </dl> <dl> <dt>Default:</dt> <dd>"circle"</dd> </dl> </li> </ul> </li> </ul> </section> <section role="region"> <ul class="blockList"> <li class="blockList"><a id="iconFamily()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>iconFamily</h4> <pre><a href="../icon/Family.html" title="enum in com.djrapitops.plan.extension.icon">Family</a> iconFamily</pre> <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 in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Family that matches an icon, if there is no icon for this family no icon is shown.</dd> </dl> <dl> <dt>Default:</dt> <dd>com.djrapitops.plan.extension.icon.Family.SOLID</dd> </dl> </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>Field | </li> <li>Required | </li> <li><a href="#annotation.type.optional.element.summary">Optional</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#annotation.type.element.detail">Element</a></li> </ul> </div> <a id="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </nav> </footer> </body> </html>