[DOC] Документация к основным классам LauncherCore

LaunchServer/src/main/java/pro/gravit/launchserver/Reconfigurable.java

@@ -4,6 +4,14 @@
 
 import java.util.Map;
 
+/**
+ * Allows calling commands using the config command
+ */
 public interface Reconfigurable {
+    /**
+     * Gets a list of commands available for this object.
+     * @return Key - Command Name
+     * Value is a command object
+     */
     Map<String, Command> getCommands();
 }

LauncherCore/src/main/java/pro/gravit/launcher/LauncherAPI.java

@@ -5,8 +5,10 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * This annotation implies that method/field/class should not be renamed or obfuscated
+ */
 @Retention(RetentionPolicy.CLASS)
 @Target({ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.METHOD})
 public @interface LauncherAPI {
-    /* This annotation implies that method/field/class should not be renamed or obfuscated */
 }

LauncherCore/src/main/java/pro/gravit/launcher/LauncherNetworkAPI.java

@@ -5,6 +5,10 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * This annotation implies that method/field/class should not be renamed or obfuscated
+ * It is used for classes and fields serializable with the help of GSON to save the field name during transmission over the network.
+ */
 @Retention(RetentionPolicy.CLASS)
 @Target({ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.METHOD})
 public @interface LauncherNetworkAPI {

LauncherCore/src/main/java/pro/gravit/launcher/NeedGarbageCollection.java

@@ -1,5 +1,9 @@
 package pro.gravit.launcher;
 
+/**
+ * Determines whether this object requires periodic garbage collection by the gc command
+ * This interface has nothing to do with java garbage collection.
+ */
 @FunctionalInterface
 public interface NeedGarbageCollection {
     void garbageCollection();

LauncherCore/src/main/java/pro/gravit/utils/BiHookSet.java

@@ -8,6 +8,15 @@ public class BiHookSet<V, R> {
 
     @FunctionalInterface
     public interface Hook<V, R> {
+        /**
+         * @param context custom param
+         * @param object custom param
+         * @return
+         * True if you need to interrupt hook processing
+         * False to continue processing hook
+         * @throws HookException
+         * The hook may return the error text throwing this exception
+         */
         boolean hook(V object, R context) throws HookException;
     }
 
@@ -19,6 +28,15 @@ public boolean unregisterHook(Hook<V, R> hook) {
         return list.remove(hook);
     }
 
+    /**
+     * @param context custom param
+     * @param object custom param
+     * @return
+     * True if hook to interrupt processing
+     * False to continue
+     * @throws HookException
+     * The hook may return the error text throwing this exception
+     */
     public boolean hook(V context, R object) throws HookException {
         for (Hook<V, R> hook : list) {
             if (hook.hook(context, object)) return true;

LauncherCore/src/main/java/pro/gravit/utils/HookSet.java

@@ -8,6 +8,14 @@ public class HookSet<R> {
 
     @FunctionalInterface
     public interface Hook<R> {
+        /**
+         * @param context custom param
+         * @return
+         * True if you need to interrupt hook processing
+         * False to continue processing hook
+         * @throws HookException
+         * The hook may return the error text throwing this exception
+         */
         boolean hook(R context) throws HookException;
     }
 
@@ -19,6 +27,14 @@ public boolean unregisterHook(Hook<R> hook) {
         return list.remove(hook);
     }
 
+    /**
+     * @param context custom param
+     * @return
+     * True if hook to interrupt processing
+     * False to continue
+     * @throws HookException
+     * The hook may return the error text throwing this exception
+     */
     public boolean hook(R context) throws HookException {
         for (Hook<R> hook : list) {
             if (hook.hook(context)) return true;

LauncherCore/src/main/java/pro/gravit/utils/ProviderMap.java

@@ -6,6 +6,10 @@
 
 import pro.gravit.utils.helper.VerifyHelper;
 
+/**
+ * The relationship between classes of an interface or abstract class and names when they are serialized
+ * @param <R> Class or interface type
+ */
 public class ProviderMap<R> {
     protected final Map<String, Class<? extends R>> PROVIDERS = new ConcurrentHashMap<>(4);
     protected final String name;

LauncherCore/src/main/java/pro/gravit/utils/UniversalJsonAdapter.java

@@ -13,6 +13,11 @@
 
 import pro.gravit.utils.helper.LogHelper;
 
+/**
+ * An adapter that uses {@link ProviderMap} to serialize and deserialize a group of similar objects
+ * @param <R> Class or interface type
+ * @see ProviderMap
+ */
 public class UniversalJsonAdapter<R> implements JsonSerializer<R>, JsonDeserializer<R> {
     public final ProviderMap<R> providerMap;
     public final String name;