Annotate internal methods as so, remove custom Experimental annotation (#35)

Author: ConnorLinfoot

src/main/java/net/hypixel/modapi/HypixelModAPI.java

@@ -14,6 +14,7 @@
 import net.hypixel.modapi.packet.impl.serverbound.ServerboundPlayerInfoPacket;
 import net.hypixel.modapi.packet.impl.serverbound.ServerboundRegisterPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
@@ -74,21 +75,6 @@ private void registerDefaultHandler() {
  registerHandler(ClientboundHelloPacket.class, p -> sendRegisterPacket(true));
  }
 
- public PacketRegistry getRegistry() {
- return registry;
- }
-
- public <T extends ClientboundHypixelPacket> void registerHandler(Class<T> packetClass, ClientboundPacketHandler<T> handler) {
- if (packetClass == null || handler == null) return;
- handlers.computeIfAbsent(packetClass, cls -> new CopyOnWriteArrayList<>()).add(handler);
- }
-
- public void subscribeToEventPacket(Class<? extends EventPacket> packet) {
- if (subscribedEvents.add(getRegistry().getIdentifier(packet))) {
- sendRegisterPacket(false);
- }
- }
-
  private void sendRegisterPacket(boolean alwaysSendIfNotEmpty) {
  if (packetSender == null) {
  // Allow registering events before the mod has fully initialized
@@ -100,12 +86,17 @@ private void sendRegisterPacket(boolean alwaysSendIfNotEmpty) {
  }
 
  Set<String> lastSubscribedEvents = new HashSet<>(subscribedEvents);
- Map<String, Integer> versionsMap = getRegistry().getEventVersions(lastSubscribedEvents);
- if (sendPacket(new ServerboundRegisterPacket(versionsMap))) {
+ if (sendPacket(new ServerboundRegisterPacket(registry, lastSubscribedEvents))) {
  this.lastSubscribedEvents = lastSubscribedEvents;
  }
  }
 
+ @ApiStatus.Internal
+ public PacketRegistry getRegistry() {
+ return registry;
+ }
+
+ @ApiStatus.Internal
  public void handle(String identifier, PacketSerializer serializer) {
  if (handlers.isEmpty()) {
  return;
@@ -130,6 +121,7 @@ public void handle(String identifier, PacketSerializer serializer) {
  handle(packet);
  }
 
+ @ApiStatus.Internal
  @SuppressWarnings("unchecked")
  public void handle(ClientboundHypixelPacket packet) {
  Collection<ClientboundPacketHandler<?>> typedHandlers = handlers.get(packet.getClass());
@@ -141,13 +133,25 @@ public void handle(ClientboundHypixelPacket packet) {
  }
  }
 
+ @ApiStatus.Internal
  public void setPacketSender(Predicate<HypixelPacket> packetSender) {
  if (this.packetSender != null) {
  throw new IllegalArgumentException("Packet sender already set");
  }
  this.packetSender = packetSender;
  }
 
+ public <T extends ClientboundHypixelPacket> void registerHandler(Class<T> packetClass, ClientboundPacketHandler<T> handler) {
+ if (packetClass == null || handler == null) return;
+ handlers.computeIfAbsent(packetClass, cls -> new CopyOnWriteArrayList<>()).add(handler);
+ }
+
+ public void subscribeToEventPacket(Class<? extends EventPacket> packet) {
+ if (subscribedEvents.add(getRegistry().getIdentifier(packet))) {
+ sendRegisterPacket(false);
+ }
+ }
+
  /**
  * @return whether the packet was sent successfully
  */

src/main/java/net/hypixel/modapi/annotation/Experimental.java

@@ -1,9 +1,12 @@
 package net.hypixel.modapi.error;
 
+import org.jetbrains.annotations.ApiStatus;
+
 public class ModAPIException extends RuntimeException {
  private final String identifier;
  private final ErrorReason reason;
 
+ @ApiStatus.Internal
  public ModAPIException(String identifier, ErrorReason reason) {
  super(String.format("Received error response '%s' from packet '%s'", reason, identifier));
  this.identifier = identifier;

src/main/java/net/hypixel/modapi/error/ModAPIException.java

@@ -2,11 +2,14 @@
 
 import net.hypixel.modapi.HypixelModAPI;
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 public interface HypixelPacket {
 
+ @ApiStatus.Internal
  void write(PacketSerializer serializer);
 
+ @ApiStatus.Internal
  default String getIdentifier() {
  return HypixelModAPI.getInstance().getRegistry().getIdentifier(getClass());
  }

src/main/java/net/hypixel/modapi/packet/HypixelPacket.java

@@ -1,6 +1,7 @@
 package net.hypixel.modapi.packet;
 
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -10,6 +11,7 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
+@ApiStatus.Internal
 public class PacketRegistry {
 
  private final Map<String, Registration> registrations = new ConcurrentHashMap<>();

src/main/java/net/hypixel/modapi/packet/PacketRegistry.java

@@ -2,17 +2,20 @@
 
 import net.hypixel.modapi.packet.HypixelPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 /**
  * Represents a packet that is backed by a version. Versioned packets will only be handled if the incoming packet matches the version of the packet known.
  */
 public abstract class VersionedPacket implements HypixelPacket {
  protected int version;
 
+ @ApiStatus.Internal
  public VersionedPacket(int version) {
  this.version = version;
  }
 
+ @ApiStatus.Internal
  public VersionedPacket(PacketSerializer serializer) {
  read(serializer);
  }

src/main/java/net/hypixel/modapi/packet/impl/VersionedPacket.java

@@ -3,6 +3,7 @@
 import net.hypixel.data.region.Environment;
 import net.hypixel.modapi.packet.ClientboundHypixelPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 /**
  * This packet is automatically sent on every join to Hypixel to indicate that the client has connected to a Hypixel server.
@@ -11,10 +12,12 @@
 public class ClientboundHelloPacket implements ClientboundHypixelPacket {
  private final Environment environment;
 
+ @ApiStatus.Internal
  public ClientboundHelloPacket(Environment environment) {
  this.environment = environment;
  }
 
+ @ApiStatus.Internal
  public ClientboundHelloPacket(PacketSerializer serializer) {
  this.environment = Environment.getById(serializer.readVarInt()).orElseThrow(() -> new IllegalArgumentException("Invalid environment ID"));
 

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundHelloPacket.java

@@ -1,6 +1,7 @@
 package net.hypixel.modapi.packet.impl.clientbound;
 
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 import java.util.*;
 
@@ -10,6 +11,7 @@ public class ClientboundPartyInfoPacket extends ClientboundVersionedPacket {
  private boolean inParty;
  private Map<UUID, PartyMember> memberMap;
 
+ @ApiStatus.Internal
  public ClientboundPartyInfoPacket(int version, boolean inParty, Map<UUID, PartyMember> memberMap) {
  super(version);
  if (version > CURRENT_VERSION) {
@@ -20,6 +22,7 @@ public ClientboundPartyInfoPacket(int version, boolean inParty, Map<UUID, PartyM
  this.memberMap = memberMap;
  }
 
+ @ApiStatus.Internal
  public ClientboundPartyInfoPacket(PacketSerializer serializer) {
  super(serializer);
  }
@@ -117,11 +120,13 @@ public static class PartyMember {
  private final UUID uuid;
  private final PartyRole role;
 
+ @ApiStatus.Internal
  public PartyMember(UUID uuid, PartyRole role) {
  this.uuid = uuid;
  this.role = role;
  }
 
+ @ApiStatus.Internal
  PartyMember(PacketSerializer serializer) {
  this.uuid = serializer.readUuid();
  this.role = PartyRole.VALUES[serializer.readVarInt()];

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundPartyInfoPacket.java

@@ -1,17 +1,20 @@
 package net.hypixel.modapi.packet.impl.clientbound;
 
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 
 public class ClientboundPingPacket extends ClientboundVersionedPacket {
  private static final int CURRENT_VERSION = 1;
 
  private String response;
 
+ @ApiStatus.Internal
  public ClientboundPingPacket(String response) {
  super(CURRENT_VERSION);
  this.response = response;
  }
 
+ @ApiStatus.Internal
  public ClientboundPingPacket(PacketSerializer serializer) {
  super(serializer);
  }

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundPingPacket.java

@@ -4,6 +4,7 @@
 import net.hypixel.data.rank.PackageRank;
 import net.hypixel.data.rank.PlayerRank;
 import net.hypixel.modapi.serializer.PacketSerializer;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Optional;
@@ -17,6 +18,7 @@ public class ClientboundPlayerInfoPacket extends ClientboundVersionedPacket {
  @Nullable
  private String prefix;
 
+ @ApiStatus.Internal
  public ClientboundPlayerInfoPacket(PlayerRank playerRank, PackageRank packageRank, MonthlyPackageRank monthlyPackageRank, @Nullable String prefix) {
  super(CURRENT_VERSION);
  this.playerRank = playerRank;
@@ -25,6 +27,7 @@ public ClientboundPlayerInfoPacket(PlayerRank playerRank, PackageRank packageRan
  this.prefix = prefix;
  }
 
+ @ApiStatus.Internal
  public ClientboundPlayerInfoPacket(PacketSerializer serializer) {
  super(serializer);
  }