com.djrapitops.plan.extension.annotation

Annotation Type GroupProvider

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface GroupProvider

Method annotation to provide String[] array of Group names about a Player.

This method annotation only works when used with UUID or String as a method parameter (for Players).

For example: @GroupProvider public String[] getJobs(UUID playerUUID) {}

Group data is parsed as Table for /server and /network page and similar to StringProvider for /player page.

Requires Capability DATA_EXTENSION_GROUPS

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Color	groupColor Determine the color of the table header for this group.
Family	iconFamily Family of Font Awesome icon.
java.lang.String	iconName Name of Font Awesome icon.
java.lang.String	text Text displayed before the value, limited to 50 characters.

Element Detail

text

public abstract java.lang.String text

Text displayed before the value, limited to 50 characters.

Should inform the user what the group names represent, for example "Town" or "Job"

Returns:

String of max 50 characters, remainder will be clipped.

Default:

"Group"

groupColor

public abstract Color groupColor

Determine the color of the table header for this group.

Returns:

Preferred color. If none are specified defaults are used.

Default:

com.djrapitops.plan.extension.icon.Color.NONE

iconName

public abstract java.lang.String iconName

Name of Font Awesome icon.

See https://fontawesome.com/icons (select 'free')) for icons and their Family.

Returns:

Name of the icon, if name is not valid no icon is shown.

Default:

"circle"

iconFamily

public abstract Family iconFamily

Family of Font Awesome icon.

See https://fontawesome.com/icons (select 'free')) for icons and their Family.

Returns:

Family that matches an icon, if there is no icon for this family no icon is shown.

Default:

com.djrapitops.plan.extension.icon.Family.SOLID