Add more javadocs

Author: P3ridot

core/src/main/java/org/mythicprojects/yetanothermessageslibrary/message/MessageDispatcher.java

@@ -16,11 +16,19 @@
 import org.mythicprojects.yetanothermessageslibrary.replace.replacement.Replacement;
 import org.mythicprojects.yetanothermessageslibrary.util.TriFunction;
 
+/**
+ * MessageDispatcher is a class that allows you to send messages to receivers with placeholders and actions.
+ * It highly simplifies the process of sending messages to multiple receivers in multiple languages etc.
+ *
+ * @param <RECEIVER>   the type of the receiver
+ * @param <DISPATCHER> the type of the dispatcher itself
+ */
 @SuppressWarnings("unchecked")
 public interface MessageDispatcher<RECEIVER, DISPATCHER extends MessageDispatcher<RECEIVER, ? extends DISPATCHER>> {
 
     /**
      * Add a receiver to the dispatcher
+     *
      * @param receiver the receiver
      * @return this dispatcher
      */
@@ -29,6 +37,7 @@ public interface MessageDispatcher<RECEIVER, DISPATCHER extends MessageDispatche
 
     /**
      * Add multiple receivers to the dispatcher
+     *
      * @param receivers the receivers
      * @return this dispatcher
      */
@@ -40,6 +49,7 @@ default DISPATCHER receivers(@NotNull Collection<? extends @Nullable RECEIVER> r
 
     /**
      * Add multiple receivers to the dispatcher
+     *
      * @param receivers the receivers
      * @return this dispatcher
      */
@@ -53,6 +63,7 @@ default DISPATCHER receivers(@NotNull RECEIVER... receivers) {
 
     /**
      * Add all players to the dispatcher
+     *
      * @return this dispatcher
      * @throws UnsupportedOperationException if the operation is not implemented in the current MessageDispatcher
      */
@@ -65,6 +76,7 @@ default DISPATCHER all() throws UnsupportedOperationException {
 
     /**
      * Add all players to the dispatcher
+     *
      * @return this dispatcher
      * @throws UnsupportedOperationException if the operation is not implemented in the current MessageDispatcher
      */
@@ -75,6 +87,7 @@ default DISPATCHER allPlayers() throws UnsupportedOperationException {
 
     /**
      * Add all viewers to the dispatcher
+     *
      * @return this dispatcher
      * @throws UnsupportedOperationException if the operation is not implemented in the current MessageDispatcher
      */
@@ -85,6 +98,7 @@ default DISPATCHER console() throws UnsupportedOperationException {
 
     /**
      * Add a predicate to the dispatcher
+     *
      * @param predicate the predicate
      * @return this dispatcher
      */
@@ -93,9 +107,10 @@ default DISPATCHER console() throws UnsupportedOperationException {
 
     /**
      * Add a predicate to the dispatcher for a specific receiver class
+     *
      * @param receiverClass the class of the receiver
-     * @param predicate the predicate
-     * @param <T> the type of the receiver
+     * @param predicate     the predicate
+     * @param <T>           the type of the receiver
      * @return this dispatcher
      */
     @Contract("_, _ -> this")
@@ -110,7 +125,8 @@ default <T extends RECEIVER> DISPATCHER predicate(@NotNull Class<T> receiverClas
 
     /**
      * Add a field to the dispatcher to use by the replacements
-     * @param key the key of the field
+     *
+     * @param key   the key of the field
      * @param value the value of the field
      * @return this dispatcher
      */
@@ -119,6 +135,7 @@ default <T extends RECEIVER> DISPATCHER predicate(@NotNull Class<T> receiverClas
 
     /**
      * Add multiple fields to the dispatcher to use by the replacements
+     *
      * @param fields the fields
      * @return this dispatcher
      */
@@ -237,6 +254,7 @@ default <T extends RECEIVER> DISPATCHER with(
 
     /**
      * Add an action to the dispatcher that will be executed after the message is sent
+     *
      * @param action the action
      * @return this dispatcher
      */
@@ -245,6 +263,7 @@ default <T extends RECEIVER> DISPATCHER with(
 
     /**
      * Send the message to all receivers
+     *
      * @return this dispatcher
      */
     @Contract(" -> this")

tools/src/main/java/org/mythicprojects/yetanothermessageslibrary/replace/Replaceable.java

@@ -7,6 +7,9 @@
 
 public interface Replaceable {
 
+    /**
+     * @return whether this replaceable supports string replacement
+     */
     default boolean supportsStringReplacement() {
         return false;
     }

tools/src/main/java/org/mythicprojects/yetanothermessageslibrary/replace/StringReplacer.java

@@ -22,7 +22,6 @@ public static String replace(@Nullable Locale locale, @Nullable String text, @No
         for (Replaceable replacement : replacements) {
             text = replacement.replace(locale, text);
         }
-
         return text;
     }
 

tools/src/main/java/org/mythicprojects/yetanothermessageslibrary/replace/replacement/Replacement.java

@@ -10,7 +10,6 @@
 import java.util.regex.Pattern;
 import net.kyori.adventure.text.ComponentLike;
 import net.kyori.adventure.text.TextReplacementConfig;
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.mythicprojects.yetanothermessageslibrary.replace.Replaceable;
@@ -23,22 +22,30 @@ public abstract class Replacement implements Replaceable {
     private final Object placeholder;
 
     protected Replacement(@NotNull Object placeholder) {
-        PlaceholderType placeholderType = PlaceholderType.match(placeholder.getClass());
+        PlaceholderType placeholderType = PlaceholderType.findType(placeholder.getClass());
         Validate.isTrue(placeholderType != null, "placeholder must be a String or Pattern");
         this.placeholderType = placeholderType;
         this.placeholder = placeholder;
     }
 
+    /**
+     * @return the type of placeholder (String or Pattern)
+     */
     protected final @NotNull Replacement.PlaceholderType getPlaceholderType() {
         return this.placeholderType;
     }
 
+    /**
+     * @return a new TextReplacementConfig.Builder that matches the placeholder
+     */
     protected final @NotNull TextReplacementConfig.Builder newReplacementBuilder() {
         return this.placeholderType.newReplacementBuilder(this.placeholder);
     }
 
-    @ApiStatus.Internal
-    public final @NotNull Object getPlaceholder() {
+    /**
+     * @return the placeholder object to match (String or Pattern)
+     */
+    protected final @NotNull Object getPlaceholder() {
         return this.placeholder;
     }
 
@@ -79,14 +86,10 @@ protected enum PlaceholderType {
             this.replacementBuilderFactory = replacementBuilderFactory;
         }
 
-        public Class<?> getClazz() {
+        private @NotNull Class<?> getClazz() {
             return this.clazz;
         }
 
-        public boolean isInstance(Object obj) {
-            return this.clazz.isInstance(obj);
-        }
-
         public @NotNull String replace(@NotNull String text, @NotNull Object placeholder, @NotNull String replacement) {
             return this.replacer.apply(text, placeholder, replacement);
         }
@@ -95,7 +98,7 @@ public boolean isInstance(Object obj) {
             return this.replacementBuilderFactory.apply(placeholder);
         }
 
-        public static @Nullable Replacement.PlaceholderType match(@NotNull Class<?> clazz) {
+        public static @Nullable Replacement.PlaceholderType findType(@NotNull Class<?> clazz) {
             return PLACEHOLDERS_MAP.get(clazz);
         }