Package com.djrapitops.plan.extension.annotation

Annotation Type BooleanProvider

  • @Retention(RUNTIME)
@Target(METHOD)
public @interface BooleanProvider
    Method annotation to provide a boolean value.

    Usage: @BooleanProvider boolean method(UUID playerUUID)

    The provided boolean can be used as a condition for calls to other Provider methods by defining the name of the condition and using Conditional on the other method with a Provider annotation.

    For example: @BooleanProvider(condition="example") boolean condition(UUID playerUUID); @Conditional("example") @NumberProvider long someValue(UUID playerUUID);

    • Required Element Summary

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

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String conditionName
      Name of the Conditional condition limited to 50 characters.
      java.lang.String description
      Text displayed when hovering over the value, limited to 150 characters.
      boolean hidden
      Should the result of this method be hidden from the user.
      Color iconColor
      Color preference of the plugin.
      Family iconFamily
      Family of Font Awesome icon.
      java.lang.String iconName
      Name of Font Awesome icon.
      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 Detail

      • text

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

        Should inform the user what the value represents, for example "Banned", "Has Island"

        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

        java.lang.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: "Boat", description: "Whether or not the player is on a boat."

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

      • conditionName

        java.lang.String conditionName
        Name of the Conditional condition limited to 50 characters.
        Returns:
        Case sensitive string of max 50 characters.
        Default:
        ""

      • hidden

        boolean hidden
        Should the result of this method be hidden from the user.
        Returns:
        true if the value should not be displayed on the page.
        Default:
        false

      • iconName

        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:
        "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:
        com.djrapitops.plan.extension.icon.Family.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:
        com.djrapitops.plan.extension.icon.Color.NONE

      • showInPlayerTable

        boolean showInPlayerTable
        When the parameter is set to true the value from this Provider is shown on a table alongside players.

        If hidden() is true then this value will not be shown in the table regardless of the value of this parameter.

        Returns:
        false by default.
        Default:
        false