diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java new file mode 100644 index 000000000..dce9bd73a --- /dev/null +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/BooleanProvider.java @@ -0,0 +1,86 @@ +/* + * This file is part of Player Analytics (Plan). + * + * Plan is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License v3 as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Plan is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Plan. If not, see . + */ +package com.djrapitops.plan.extension.annotation; + +import com.djrapitops.plan.extension.icon.Color; +import com.djrapitops.plan.extension.icon.Family; + +/** + * Method annotation to provide a boolean value about a Player. + *

+ * Usage: {@code @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 {@link Conditional} + * on the other method with a Provider annotation. + *

+ * For example: + * {@code @BooleanProvider(condition="example") boolean condition(UUID playerUUID);} + * {@code @Conditional("example") @NumberProvider long someValue(UUID playerUUID);} + * + * @author Rsl1122 + */ +public @interface BooleanProvider { + + /** + * Text displayed before the value, limited to 50 characters. + *

+ * Should inform the user what the value represents, for example + * "Banned", "Has Island" + * + * @return String of max 50 characters, remainder will be clipped. + */ + String text(); + + /** + * 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." + * + * @return String of max 150 characters, remainder will be clipped. + */ + String description() default ""; + + /** + * Name of Font Awesome icon. + *

+ * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * + * @return Name of the icon, if name is not valid no icon is shown. + */ + String iconName() default "question"; + + /** + * Family of Font Awesome icon. + *

+ * See https://fontawesome.com/icons?d=gallery&m=free for icons and their {@link Family}. + * + * @return Family that matches an icon, if there is no icon for this family no icon is shown. + */ + Family iconFamily() default Family.SOLID; + + /** + * Color preference of the plugin. + *

+ * This color will be set as the default color to use for plugin's elements. + * + * @return Preferred color. If none are specified defaults are used. + */ + Color iconColor() default Color.NONE; + +} diff --git a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java index e9b4c5214..813c412f2 100644 --- a/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java +++ b/Plan/api/src/main/java/com/djrapitops/plan/extension/annotation/Conditional.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; * Method Annotation to determine that a method can not be called unless a condition is fulfilled. *

* Condition information is provided with {@link com.djrapitops.plan.extension.annotation.data.BooleanProvider}. - * If {@link com.djrapitops.plan.extension.annotation.data.BooleanProvider} for the condition is not specified the + * If {@link com.djrapitops.plan.extension.annotation.BooleanProvider} for the condition is not specified the * method tagged with this annotation will not be called, (Condition is assumed false). * * @author Rsl1122