Added javadocs for clarity

Optimized methods in TikTokGiftEventHandler and TikTokGenericEventMapper

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java

@@ -29,8 +29,6 @@ import io.github.jwdeveloper.tiktok.data.models.users.User;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastGiftMessage;
 import lombok.Getter;
 
-
-
 @EventMeta(eventType = EventType.Message)
 @Getter
 public class TikTokGiftComboEvent extends TikTokGiftEvent {
@@ -45,10 +43,7 @@ public class TikTokGiftComboEvent extends TikTokGiftEvent {
         return new TikTokGiftComboEvent(
             gift,
             new User(0L, "Test", new Picture("")),
-                WebcastGiftMessage
-                        .newBuilder()
-                        .setComboCount(combo)
-                        .build(),
+            WebcastGiftMessage.newBuilder().setComboCount(combo).build(),
             comboState);
     }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java

@@ -22,7 +22,6 @@
  */
 package io.github.jwdeveloper.tiktok.data.events.gift;
 
-
 import io.github.jwdeveloper.tiktok.annotations.*;
 import io.github.jwdeveloper.tiktok.data.events.common.TikTokHeaderEvent;
 import io.github.jwdeveloper.tiktok.data.models.Picture;
@@ -31,8 +30,6 @@ import io.github.jwdeveloper.tiktok.data.models.users.User;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastGiftMessage;
 import lombok.Getter;
 
-
-
 @EventMeta(eventType = EventType.Message)
 @Getter
 public class TikTokGiftEvent extends TikTokHeaderEvent {

API/src/main/java/io/github/jwdeveloper/tiktok/data/models/gifts/GiftComboStateType.java

@@ -23,9 +23,9 @@
 package io.github.jwdeveloper.tiktok.data.models.gifts;
 
 public enum GiftComboStateType {
-    Finished,
     Begin,
-    Active;
+    Active,
+    Finished;
 
     public static GiftComboStateType fromNumber(long number) {
         return switch ((int) number) {

API/src/main/java/io/github/jwdeveloper/tiktok/live/builder/EventsBuilder.java

@@ -123,8 +123,11 @@ public interface EventsBuilder<T> {
     }
 
     /**
-     * Invoked for gifts that has no combo, or when combo finishes
-     *
+     * Triggers for these different reasons:
+     * <ol>
+     *     <li>User sends gifts that have no combo (most of expensive gifts)</li>
+     *     <li>{@link TikTokGiftComboEvent} has combaState = {@link GiftComboStateType#Finished}</li>
+     * </ol>
      * @param action consumable action
      * @return self instance
      */
@@ -133,19 +136,19 @@ public interface EventsBuilder<T> {
     }
 
     /**
-     * Triggered every time gift is sent
+     * Triggered every time a gift is sent
+     * <p>Example when user sends gift with combo</p>
+     * <ul>
+     *     <li>Combo: 1  -> comboState = {@link GiftComboStateType#Begin}</li>
+     *     <li>Combo: 4 -> comboState = {@link GiftComboStateType#Active}</li>
+     *     <li>Combo: 8 -> comboState = {@link GiftComboStateType#Active}</li>
+     *     <li>Combo: 12 -> comboState = {@link GiftComboStateType#Finished}</li>
+     * </ul>
+     * Both {@link TikTokGiftComboEvent} and {@link TikTokGiftEvent} events are triggered when comboState is Finished
      *
+     * @apiNote {@link GiftComboStateType} has 3 states: {@link GiftComboStateType#Begin Begin}, {@link GiftComboStateType#Active Active}, & {@link GiftComboStateType#Finished Finished}
      * @param action consumable action
      * @return self instance
-     * @see GiftComboStateType it has 3 states
-     *
-     * <p>Example when user sends gift with combo</p>
-     * <p>>Combo: 1  -> comboState = GiftSendType.Begin</p>
-     * <p>Combo: 4 -> comboState = GiftSendType.Active</p>
-     * <p>Combo: 8 -> comboState = GiftSendType.Active</p>
-     * <p>Combo: 12 -> comboState = GiftSendType.Finished</p>
-     * <p>
-     * Remember if comboState is Finished both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered
      */
     default T onGiftCombo(EventConsumer<TikTokGiftComboEvent> action) {
         return onEvent(TikTokGiftComboEvent.class, action);

Client/src/main/java/io/github/jwdeveloper/tiktok/mappers/TikTokGenericEventMapper.java

@@ -27,25 +27,23 @@ import io.github.jwdeveloper.tiktok.exceptions.TikTokMessageMappingException;
 
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Method;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.Map;
+import java.util.*;
 
 /**
  *  Goal of this class is to map ProtocolBuffer objects to TikTok Event in generic way
- *
- *  First parameter is ProtocolBuffer class type
- *  Second parameters is TikTokEvent class type
- *  Third parameters is bytes payload
- *
- *    mapToEvent(WebcastGiftMessage.class, TikTokGiftEvent.class, payload)
- *
- *    How does it work?
- *    1. Finds method `parseFrom(byte[] bytes)` inside ProtocolBuffer class
- *    2. put payload to the method methods and create new instance of ProtcolBuffer object
- *    3. Finds in TikTokEvent constructor that takes ProtocolBuffer type as parameter
- *    4. create new Instance in TikTokEvents using object from step 2 and constructor from step 3
- *
+ *  <ul>
+ *      <li>First parameter is ProtocolBuffer class type</li>
+ *      <li>Second parameters is TikTokEvent class type</li>
+ *      <li>Third parameters is bytes payload</li>
+ *  </ul>
+ *  <p>mapToEvent(WebcastGiftMessage.class, TikTokGiftEvent.class, payload)</p>
+ *  <p>How does it work?</p>
+ *  <ol>
+ *      <li>Finds method `parseFrom(byte[] bytes)` inside ProtocolBuffer class</li>
+ *      <li>Put payload to the method methods and create new instance of ProtcolBuffer object</li>
+ *      <li>Finds in TikTokEvent constructor that takes ProtocolBuffer type as parameter</li>
+ *      <li>Create new Instance in TikTokEvents using object from step 2 and constructor from step 3</li>
+ *  </ol>
  *   methodCache and constructorCache are used to boost performance
  */
 public class TikTokGenericEventMapper {
@@ -74,34 +72,27 @@ public class TikTokGenericEventMapper {
         }
     }
 
-    public Method getParsingMethod(Class<?> input) throws NoSuchMethodException {
-        if (methodCache.containsKey(input)) {
-            return methodCache.get(input);
+    public Method getParsingMethod(Class<?> input) throws RuntimeException {
+        return methodCache.computeIfAbsent(input, aClass -> {
+			try {
+				return aClass.getDeclaredMethod("parseFrom", byte[].class);
+			} catch (NoSuchMethodException e) {
+				throw new RuntimeException(e);
 			}
-        var method = input.getDeclaredMethod("parseFrom", byte[].class);
-        methodCache.put(input, method);
-        return method;
+		});
     }
 
     private Constructor<?> getParsingConstructor(Class<?> input, Class<?> output) {
-        var pair = new TypePair(input, output);
-        if (constructorCache.containsKey(pair)) {
-            return constructorCache.get(pair);
-        }
-
+        return constructorCache.computeIfAbsent(new TypePair(input, output), pair -> {
             var optional = Arrays.stream(output.getConstructors())
                 .filter(ea -> Arrays.stream(ea.getParameterTypes())
                     .toList()
                     .contains(input))
                 .findFirst();
 
-        if (optional.isEmpty()) {
+            if (optional.isEmpty())
 				throw new TikTokMessageMappingException(input, output, "Unable to find constructor with input class type");
-        }
-
-        constructorCache.put(pair, optional.get());
             return optional.get();
+        });
     }
-
-
 }

Client/src/main/java/io/github/jwdeveloper/tiktok/mappers/handlers/TikTokGiftEventHandler.java

@@ -55,11 +55,6 @@ public class TikTokGiftEventHandler {
     }
 
     public List<TikTokEvent> handleGift(WebcastGiftMessage currentMessage) {
-        var userId = currentMessage.getUser().getId();
-        var currentType = GiftComboStateType.fromNumber(currentMessage.getSendType());
-        var containsPreviousMessage = giftsMessages.containsKey(userId);
-
-
         //If gift is not streakable just return onGift event
         if (currentMessage.getGift().getType() != 1) {
             var comboEvent = getGiftComboEvent(currentMessage, GiftComboStateType.Finished);
@@ -67,7 +62,11 @@ public class TikTokGiftEventHandler {
             return List.of(comboEvent, giftEvent);
         }
 
-        if (!containsPreviousMessage) {
+        var userId = currentMessage.getUser().getId();
+        var currentType = GiftComboStateType.fromNumber(currentMessage.getSendType());
+        var previousMessage = giftsMessages.get(userId);
+
+        if (previousMessage == null) {
             if (currentType == GiftComboStateType.Finished) {
                 return List.of(getGiftEvent(currentMessage));
             } else {
@@ -76,7 +75,6 @@ public class TikTokGiftEventHandler {
             }
         }
 
-        var previousMessage = giftsMessages.get(userId);
         var previousType = GiftComboStateType.fromNumber(previousMessage.getSendType());
         if (currentType == GiftComboStateType.Active &&
                 previousType == GiftComboStateType.Active) {