2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2019-10-05 10:27:37 +02:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2019-10-05 10:27:37 +02:00
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
2021-03-10 09:12:21 +01:00
< title > GroupProvider (Plan 5.2-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2019-10-05 10:27:37 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../jquery/jquery-ui.css" title = "Style" >
2019-10-05 10:27:37 +02:00
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< 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-10-05 10:27:37 +02:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-03-10 09:12:21 +01:00
parent.document.title="GroupProvider (Plan 5.2-SNAPSHOT API)";
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2019-10-05 10:27:37 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2019-10-05 10:27:37 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2019-10-05 10:27:37 +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" >
2021-03-10 09:12:21 +01:00
< 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 >
2019-10-05 10:27:37 +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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-10-05 10:27:37 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2019-10-05 10:27:37 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2019-10-05 10:27:37 +02:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.extension.annotation< / a > < / div >
2019-10-05 10:27:37 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< pre > @Retention(RUNTIME)
@Target(METHOD)
2019-10-05 10:27:37 +02:00
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 >
2021-03-10 09:12:21 +01:00
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.
2019-10-05 10:27:37 +02:00
< 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 =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-10-05 10:27:37 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "annotation.type.optional.element.summary" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< h3 > Optional Element Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2019-10-05 10:27:37 +02:00
< caption > < span > Optional Elements< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Optional Element< / th >
< th class = "colLast" scope = "col" > Description< / th >
2019-10-05 10:27:37 +02:00
< / tr >
< tr class = "altColor" >
2021-03-10 09:12:21 +01:00
< 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" >
2019-10-05 10:27:37 +02:00
< div class = "block" > Determine the color of the table header for this group.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
2021-03-10 09:12:21 +01:00
< 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" >
2019-10-05 10:27:37 +02:00
< div class = "block" > Family of Font Awesome icon.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#iconName()" > iconName< / a > < / span > < / code > < / th >
< td class = "colLast" >
2019-10-05 10:27:37 +02:00
< div class = "block" > Name of Font Awesome icon.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#text()" > text< / a > < / span > < / code > < / th >
< td class = "colLast" >
2019-10-05 10:27:37 +02:00
< div class = "block" > Text displayed before the value, limited to 50 characters.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-10-05 10:27:37 +02:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2019-10-05 10:27:37 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "annotation.type.element.detail" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< h3 > Element Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "text()" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > text< / h4 >
2021-03-10 09:12:21 +01:00
< pre > java.lang.String text< / pre >
2019-10-05 10:27:37 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< / section >
< section role = "region" >
2019-10-05 10:27:37 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "groupColor()" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > groupColor< / h4 >
2021-03-10 09:12:21 +01:00
< pre > < a href = "../icon/Color.html" title = "enum in com.djrapitops.plan.extension.icon" > Color< / a > groupColor< / pre >
2019-10-05 10:27:37 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< / section >
< section role = "region" >
2019-10-05 10:27:37 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "iconName()" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > iconName< / h4 >
2021-03-10 09:12:21 +01:00
< pre > java.lang.String iconName< / pre >
2019-10-05 10:27:37 +02:00
< div class = "block" > Name of Font Awesome icon.
< p >
2021-03-10 09:12:21 +01:00
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 >
2019-10-05 10:27:37 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< / section >
< section role = "region" >
2019-10-05 10:27:37 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "iconFamily()" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > iconFamily< / h4 >
2021-03-10 09:12:21 +01:00
< pre > < a href = "../icon/Family.html" title = "enum in com.djrapitops.plan.extension.icon" > Family< / a > iconFamily< / pre >
2019-10-05 10:27:37 +02:00
< div class = "block" > Family of Font Awesome icon.
< p >
2021-03-10 09:12:21 +01:00
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 >
2019-10-05 10:27:37 +02:00
< 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 >
2021-03-10 09:12:21 +01:00
< / section >
2019-10-05 10:27:37 +02:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2019-10-05 10:27:37 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2019-10-05 10:27:37 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2019-10-05 10:27:37 +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" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../allclasses.html" > All Classes< / a > < / li >
2019-10-05 10:27:37 +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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2019-10-05 10:27:37 +02:00
< / 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 >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2019-10-05 10:27:37 +02:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2019-10-05 10:27:37 +02:00
< / body >
< / html >
