Add missing Javadocs

Author: srnyx

src/main/java/xyz/srnyx/javautilities/manipulation/Mapper.java

@@ -112,18 +112,45 @@ public static <T extends Enum<T>> Optional<T> toEnum(@Nullable String name, @Not
         return name == null || name.isEmpty() ? Optional.empty() : MiscUtility.handleException(() -> Enum.valueOf(enumClass, name.toUpperCase()), IllegalArgumentException.class);
     }
 
+    /**
+     * Converts an {@link Object} to a {@link JsonElement}
+     *
+     * @param   object  the {@link Object} to convert
+     *
+     * @return          the converted {@link JsonElement} or {@link Optional#empty()} if parsing failed
+     */
     @NotNull
     public static Optional<JsonElement> toJson(@Nullable Object object) {
         if (object == null) return Optional.of(JsonNull.INSTANCE);
         if (object instanceof JsonElement) return Optional.of((JsonElement) object);
         return MiscUtility.handleException(() -> MiscUtility.JSON_PARSER.parse(object.toString()), IllegalStateException.class);
     }
 
+    /**
+     * Converts a {@link JsonElement} to the specified subclass
+     *
+     * @param   element     the {@link JsonElement} to convert
+     * @param   jsonClass   the subclass of {@link JsonElement} to convert to
+     *
+     * @return              an {@link Optional} containing the converted {@link JsonElement} if it is of the specified subclass, otherwise {@link Optional#empty()}
+     *
+     * @param   <T>         the type of the {@link JsonElement} subclass
+     */
     @NotNull
     public static <T extends JsonElement> Optional<T> convertJsonElement(@Nullable JsonElement element, @NotNull Class<T> jsonClass) {
         return !jsonClass.isInstance(element) ? Optional.empty() : Optional.of(jsonClass.cast(element));
     }
 
+    /**
+     * Converts a {@link JsonPrimitive} to the specified primitive wrapper class
+     *
+     * @param   primitive       the {@link JsonPrimitive} to convert
+     * @param   primitiveClass  the primitive wrapper {@link Class} to convert to
+     *
+     * @return                  an {@link Optional} containing the converted value if successful, otherwise {@link Optional#empty()}
+     *
+     * @param   <T>             the type of the primitive wrapper class
+     */
     @NotNull
     public static <T> Optional<T> convertJsonPrimitive(@Nullable JsonPrimitive primitive, @NotNull Class<T> primitiveClass) {
         // Check if primitive is null or class not supported
@@ -160,6 +187,9 @@ public static <T> Optional<T> convertJsonPrimitive(@Nullable JsonPrimitive primi
         }, IllegalStateException.class).map(primitiveClass::cast);
     }
 
+    /**
+     * Private constructor to prevent instantiation
+     */
     private Mapper() {
         throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
     }

src/main/java/xyz/srnyx/javautilities/objects/encryptor/Encryptor.java

@@ -67,12 +67,13 @@ public class Encryptor {
     /**
      * Creates a new {@link Encryptor}
      *
-     * @param   secret                      {@link #secret}
-     * @param   maxAge                      {@link #maxAge}
+     * @param   secret                              {@link #secret}
+     * @param   maxAge                              {@link #maxAge}
      *
-     * @throws  NoSuchAlgorithmException    if the specified algorithm is not available
-     * @throws  InvalidKeyException         if the provided secret is invalid
-     * @throws  NoSuchPaddingException      if the specified padding scheme is not available
+     * @throws  NoSuchAlgorithmException            if the specified algorithm is not available
+     * @throws  InvalidKeyException                 if the provided secret is invalid
+     * @throws  NoSuchPaddingException              if the specified padding scheme is not available
+     * @throws  InvalidAlgorithmParameterException  if the provided algorithm parameters are invalid
      */
     public Encryptor(@NotNull byte[] secret, @Nullable Duration maxAge) throws NoSuchAlgorithmException, InvalidKeyException, NoSuchPaddingException, InvalidAlgorithmParameterException {
         this.secret = new SecretKeySpec(secret, ALGORITHM);
@@ -142,9 +143,12 @@ public String encrypt(@NotNull JsonElement value) {
     /**
      * Decrypts a Base64 URL-safe string token and returns the original {@link JsonElement} value
      *
-     * @param   token   the Base64 URL-safe string token to decrypt
+     * @param   token                   the Base64 URL-safe string token to decrypt
      *
-     * @return          the decrypted {@link JsonElement} value, or null if decryption fails or token is invalid
+     * @return                          the decrypted {@link JsonElement} value, or null if decryption fails or token is invalid
+     *
+     * @throws  TokenExpiredException   if the token has expired based on {@link #maxAge}
+     * @throws  TokenInvalidException   if the token is invalid or tampered with
      */
     @Nullable
     public JsonElement decrypt(@NotNull String token) throws TokenExpiredException, TokenInvalidException {

src/main/java/xyz/srnyx/javautilities/objects/encryptor/exceptions/DecryptionException.java

@@ -3,7 +3,15 @@
 import org.jetbrains.annotations.NotNull;
 
 
+/**
+ * Exception thrown when {@link xyz.srnyx.javautilities.objects.encryptor.Encryptor#decrypt(String) decryption} fails
+ */
 public class DecryptionException extends Exception {
+    /**
+     * Constructs a new {@link DecryptionException} with the specified detail message
+     *
+     * @param   message the detail message
+     */
     public DecryptionException(@NotNull String message) {
         super(message);
     }

src/main/java/xyz/srnyx/javautilities/objects/encryptor/exceptions/TokenExpiredException.java

@@ -1,7 +1,13 @@
 package xyz.srnyx.javautilities.objects.encryptor.exceptions;
 
 
+/**
+ * Exception thrown when a token has expired during {@link xyz.srnyx.javautilities.objects.encryptor.Encryptor#decrypt(String) decryption}
+ */
 public class TokenExpiredException extends DecryptionException {
+    /**
+     * Constructs a new {@link TokenExpiredException} with the default message
+     */
     public TokenExpiredException() {
         super("Token has expired");
     }

src/main/java/xyz/srnyx/javautilities/objects/encryptor/exceptions/TokenInvalidException.java

@@ -3,7 +3,15 @@
 import org.jetbrains.annotations.NotNull;
 
 
+/**
+ * Exception thrown when a token is invalid during {@link xyz.srnyx.javautilities.objects.encryptor.Encryptor#decrypt(String) decryption}
+ */
 public class TokenInvalidException extends DecryptionException {
+    /**
+     * Constructs a new {@link TokenInvalidException} with the specified detail message
+     *
+     * @param   message the detail message
+     */
     public TokenInvalidException(@NotNull String message) {
         super(message);
     }