Add host events to the api and to tipeeestream

Author: hlxid

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/Host.java

@@ -0,0 +1,58 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+
+/**
+ * Another streamer has started hosting your stream on their channel.
+ */
+public class Host<T extends User> {
+    private final T streamer;
+    private final String message;
+    private final int viewerCount;
+    private final OffsetDateTime time;
+
+    public Host(T streamer, String message, int viewerCount, OffsetDateTime time) {
+        this.streamer = streamer;
+        this.message = message;
+        this.viewerCount = viewerCount;
+        this.time = time;
+    }
+
+    /**
+     * Get the streamer which started hosting you.
+     *
+     * @return streamer that hosts you
+     */
+    public T getStreamer() {
+        return streamer;
+    }
+
+    /**
+     * Get the message from the streamer that has started hosting you.
+     *
+     * @return the host message
+     */
+    public String getMessage() {
+        return message;
+    }
+
+    /**
+     * Get the viewer count with which the streamer is hosting you.
+     *
+     * @return the viewer count of the host
+     */
+    public int getViewerCount() {
+        return viewerCount;
+    }
+
+    /**
+     * Get the time when the streamer has started hosting you.
+     *
+     * @return host time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/Raid.java

@@ -21,7 +21,7 @@ public Raid(T streamer, String message, int viewerCount, OffsetDateTime time) {
     }
 
     /**
-     * Get the stream which started the raid.
+     * Get the streamer which started the raid.
      *
      * @return initiating streamer
      */

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/tipeeestream/TipeeestreamHost.java

@@ -0,0 +1,12 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Host;
+
+import java.time.OffsetDateTime;
+
+public class TipeeestreamHost extends Host<User> {
+    public TipeeestreamHost(User streamer, String message, int viewerCount, OffsetDateTime time) {
+        super(streamer, message, viewerCount, time);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/event/stream/HostEvent.java

@@ -0,0 +1,24 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Host;
+
+/**
+ * Generic event for hosts
+ */
+public abstract class HostEvent<T extends Host> {
+
+    private final T info;
+
+    protected HostEvent(T cheerInfo) {
+        this.info = cheerInfo;
+    }
+
+    /**
+     * Get the Host object that contains all information about that host
+     *
+     * @return all info about that host
+     */
+    public T getInfo() {
+        return info;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/event/stream/RaidEvent.java

@@ -5,7 +5,7 @@
 /**
  * Generic event for raids
  */
-public class RaidEvent<T extends Raid> {
+public abstract class RaidEvent<T extends Raid> {
 
     private final T info;
 

src/main/java/org/codeoverflow/chatoverflow/api/io/event/stream/tipeeestream/TipeeestreamHostEvent.java

@@ -0,0 +1,10 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream.TipeeestreamHost;
+import org.codeoverflow.chatoverflow.api.io.event.stream.HostEvent;
+
+public class TipeeestreamHostEvent extends HostEvent<TipeeestreamHost> implements TipeeestreamEvent {
+    public TipeeestreamHostEvent(TipeeestreamHost cheerInfo) {
+        super(cheerInfo);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/input/event/TipeeestreamEventInput.java

@@ -52,4 +52,13 @@ default void registerCheerEventHandler(Consumer<TipeeestreamCheerEvent> eventHan
     default void registerRaidEventHandler(Consumer<TipeeestreamRaidEvent> eventHandler) {
         registerEventHandler(eventHandler, TipeeestreamRaidEvent.class);
     }
+
+    /**
+     * Register an event handler that listens to all {@link TipeeestreamHostEvent}
+     *
+     * @param eventHandler consumer that receives the Events
+     */
+    default void registerHostEventHandler(Consumer<TipeeestreamHostEvent> eventHandler) {
+        registerEventHandler(eventHandler, TipeeestreamHostEvent.class);
+    }
 }