Package com.djrapitops.plan.extension.annotation

Annotation Interface StringProvider

@Retention(RUNTIME) @Target(METHOD) public @interface StringProvider
Method annotation to provide a String value.

Usage: @StringProvider String method(UUID playerUUID)

The returned value is limited to 100 characters, remainder will be clipped.

If the value is a player name, provide value for playerName=true. This will allow linking between pages.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    text
    Text displayed before the value, limited to 50 characters.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Text displayed when hovering over the value, limited to 150 characters.
    Color
    iconColor
    Color preference of the plugin.
    Family
    iconFamily
    Family of Font Awesome icon.
    String
    iconName
    Name of Font Awesome icon.
    boolean
    playerName
    Determine if this value represents a Player name, for example a mayor of a town.
    int
    priority
    Display-priority of the value, highest value is placed top most.
    boolean
    showInPlayerTable
    When the parameter is set to true the value from this Provider is shown on a table alongside players.

  • Element Details

    • text

      String text
      Text displayed before the value, limited to 50 characters.

      Should inform the user what the value represents, for example "Town Name", "Pet Name"

      Returns:
      String of max 50 characters, remainder will be clipped.

    • priority

      int priority
      Display-priority of the value, highest value is placed top most.

      Two values with same priority may appear in a random order.

      Returns:
      Priority between 0 and Integer.MAX_VALUE.
      Default:
      0

    • description

      String description
      Text displayed when hovering over the value, limited to 150 characters.

      Should be used to clarify what the value is if not self evident, for example text: "Power", description: "Faction power, affects ability of faction to perform actions. Regenerates"

      Returns:
      String of max 150 characters, remainder will be clipped.
      Default:
      ""

    • playerName

      boolean playerName
      Determine if this value represents a Player name, for example a mayor of a town.
      Returns:
      true if the name can be used as a link to another player's page.
      Default:
      false

    • iconName

      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:
      "question"

    • iconFamily

      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:
      SOLID

    • iconColor

      Color iconColor
      Color preference of the plugin.

      This color will be set as the default color to use for plugin's elements.

      Returns:
      Preferred color. If none are specified defaults are used.
      Default:
      NONE

    • showInPlayerTable

      boolean showInPlayerTable
      When the parameter is set to true the value from this Provider is shown on a table alongside players.
      Returns:
      false by default.
      Default:
      false