Deprecate setCancelSend and isCancelSend

Exceptionflug · Dec 7, 2019 · 0d51060 · 0d51060
1 parent c1a0014
commit 0d51060
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/protocolize-api/src/main/java/de/exceptionflug/protocolize/api/protocol/AbstractPacket.java b/protocolize-api/src/main/java/de/exceptionflug/protocolize/api/protocol/AbstractPacket.java
@@ -17,10 +17,18 @@ public void handle(final AbstractPacketHandler abstractPacketHandler) {
             throw CancelSendSignal.INSTANCE;
     }
 
+    @Deprecated
     public boolean isCancelSend() {
         return cancelSend;
     }
 
+    /**
+     * If set to true, the packet handler will throw an instance of {@link CancelSendSignal}. Since this is deprecated,
+     * use the setCancelled(boolean cancelled) method of the {@link de.exceptionflug.protocolize.api.event.PacketReceiveEvent}
+     * or {@link de.exceptionflug.protocolize.api.event.PacketSendEvent} instead.
+     * @param cancelSend
+     */
+    @Deprecated
     public void setCancelSend(final boolean cancelSend) {
         this.cancelSend = cancelSend;
     }