Skip to content

Add nullability annotations to getChannel methods in player manager classes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
3add wants to merge 1 commit into from
Closed

Add nullability annotations to getChannel methods in player manager classes #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions api/src/main/java/com/github/retrooper/packetevents/manager/player/PlayerManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,22 @@
import com.github.retrooper.packetevents.wrapper.PacketWrapper;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface PlayerManager {
int getPing(@NotNull Object player);

@NotNull ClientVersion getClientVersion(@NotNull Object player);

Object getChannel(@NotNull Object player);
/**
* Gets the channel of a platform specific player object. This returns null if no channel for the player has been established.
*/
@Nullable Object getChannel(@NotNull Object player);

User getUser(@NotNull Object player);
/**
* Get the user from the platform specific player object. This returns null if the player's channel is null.
*/
@Nullable User getUser(@NotNull Object player);

/**
* <strong>WARNING</strong>: Usage of this method should be avoided. Please use either
Expand Down
3 changes: 2 additions & 1 deletion api/src/main/java/com/github/retrooper/packetevents/manager/protocol/ProtocolManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import com.github.retrooper.packetevents.util.PacketTransformationUtil;
import com.github.retrooper.packetevents.wrapper.PacketWrapper;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;
import java.util.Map;
Expand Down Expand Up @@ -167,7 +168,7 @@ default void setUser(Object channel, User user) {
PacketEvents.getAPI().getInjector().updateUser(channel, user);
}

default Object getChannel(UUID uuid) {
default @Nullable Object getChannel(UUID uuid) {
return CHANNELS.get(uuid);
}

Expand Down
4 changes: 2 additions & 2 deletions .../main/java/io/github/retrooper/packetevents/bungee/factory/BungeePacketEventsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,12 @@ public int getPing(@NotNull Object player) {
}

@Override
public Object getChannel(@NotNull Object player) {
public @Nullable Object getChannel(@NotNull Object player) {
return PacketEvents.getAPI().getProtocolManager().getChannel(((ProxiedPlayer) player).getUniqueId());
}

@Override
public User getUser(@NotNull Object player) {
public @Nullable User getUser(@NotNull Object player) {
ProxiedPlayer p = (ProxiedPlayer) player;
Object channel = getChannel(p);
User user = PacketEvents.getAPI().getProtocolManager().getUser(channel);
Expand Down
3 changes: 2 additions & 1 deletion ...lient/java/io/github/retrooper/packetevents/factory/fabric/FabricClientPlayerManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import net.minecraft.client.Minecraft;
import net.minecraft.client.multiplayer.PlayerInfo;
import net.minecraft.client.player.LocalPlayer;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NullMarked;

@NullMarked
Expand All @@ -42,7 +43,7 @@ public int getPing(Object playerObj) {
}

@Override
public Object getChannel(Object player) {
public @Nullable Object getChannel(Object player) {
if (player instanceof LocalPlayer) {
return ((LocalPlayer) player).connection.getConnection().channel;
}
Expand Down
3 changes: 2 additions & 1 deletion ...ry/src/main/java/io/github/retrooper/packetevents/factory/fabric/FabricPlayerManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import io.github.retrooper.packetevents.impl.netty.manager.player.PlayerManagerAbstract;
import net.minecraft.server.level.ServerPlayer;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NullMarked;

@NullMarked
Expand All @@ -34,7 +35,7 @@ public int getPing(Object player) {
}

@Override
public Object getChannel(Object player) {
public @Nullable Object getChannel(Object player) {
if (player instanceof ServerPlayer) {
return ((ServerPlayer) player).connection.connection.channel;
}
Expand Down
3 changes: 2 additions & 1 deletion ...lient/java/io/github/retrooper/packetevents/factory/fabric/FabricClientPlayerManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import net.minecraft.client.Minecraft;
import net.minecraft.client.multiplayer.PlayerInfo;
import net.minecraft.client.player.LocalPlayer;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NullMarked;

@NullMarked
Expand All @@ -42,7 +43,7 @@ public int getPing(Object playerObj) {
}

@Override
public Object getChannel(Object player) {
public @Nullable Object getChannel(Object player) {
if (player instanceof LocalPlayer) {
return ((LocalPlayer) player).connection.getConnection().channel;
}
Expand Down
3 changes: 2 additions & 1 deletion ...al/src/main/java/io/github/retrooper/packetevents/factory/fabric/FabricPlayerManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import io.github.retrooper.packetevents.impl.netty.manager.player.PlayerManagerAbstract;
import net.minecraft.server.level.ServerPlayer;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NullMarked;

@NullMarked
Expand All @@ -34,7 +35,7 @@ public int getPing(Object player) {
}

@Override
public Object getChannel(Object player) {
public @Nullable Object getChannel(Object player) {
if (player instanceof ServerPlayer) {
return ((ServerPlayer) player).connection.connection.channel;
}
Expand Down
5 changes: 3 additions & 2 deletions ...ava/io/github/retrooper/packetevents/impl/netty/manager/player/PlayerManagerAbstract.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,22 @@
import com.github.retrooper.packetevents.protocol.player.ClientVersion;
import com.github.retrooper.packetevents.protocol.player.User;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class PlayerManagerAbstract implements PlayerManager {
@Override
public abstract int getPing(@NotNull Object player);

@Override
public abstract Object getChannel(@NotNull Object player);
public abstract @Nullable Object getChannel(@NotNull Object player);

@Override
public @NotNull ClientVersion getClientVersion(@NotNull Object player) {
return getUser(player).getClientVersion();
}

@Override
public User getUser(@NotNull Object player) {
public @Nullable User getUser(@NotNull Object player) {
Object channel = getChannel(player);
return PacketEvents.getAPI().getProtocolManager().getUser(channel);
}
Expand Down
6 changes: 3 additions & 3 deletions spigot/src/main/java/io/github/retrooper/packetevents/manager/player/PlayerManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import io.github.retrooper.packetevents.util.viaversion.ViaVersionUtil;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.NotNull;import org.jetbrains.annotations.Nullable;

import java.lang.ref.WeakReference;
import java.util.Map;
Expand Down Expand Up @@ -88,7 +88,7 @@ public int getPing(@NotNull Object player) {
}

@Override
public Object getChannel(@NotNull Object player) {
public @Nullable Object getChannel(@NotNull Object player) {
UUID uuid = ((Player) player).getUniqueId();
ProtocolManager protocolManager = PacketEvents.getAPI().getProtocolManager();
Object channel = protocolManager.getChannel(uuid);
Expand All @@ -108,7 +108,7 @@ public Object getChannel(@NotNull Object player) {
}

@Override
public User getUser(@NotNull Object player) {
public @Nullable User getUser(@NotNull Object player) {
Player p = (Player) player;
Object channel = getChannel(p);

Expand Down
5 changes: 3 additions & 2 deletions ...c/main/java/io/github/retrooper/packetevents/sponge/manager/player/PlayerManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import io.github.retrooper.packetevents.sponge.util.SpongeReflectionUtil;
import io.github.retrooper.packetevents.sponge.util.viaversion.ViaVersionUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.spongepowered.api.entity.living.player.server.ServerPlayer;
import org.spongepowered.api.network.ServerConnectionState;
import org.spongepowered.api.network.ServerSideConnection;
Expand Down Expand Up @@ -67,7 +68,7 @@ public int getPing(@NotNull Object player) {
}

@Override
public Object getChannel(@NotNull Object player) {
public @Nullable Object getChannel(@NotNull Object player) {
UUID uuid = ((ServerPlayer) player).uniqueId();
ProtocolManager protocolManager = PacketEvents.getAPI().getProtocolManager();
Object channel = protocolManager.getChannel(uuid);
Expand All @@ -87,7 +88,7 @@ public Object getChannel(@NotNull Object player) {
}

@Override
public User getUser(@NotNull Object player) {
public @Nullable User getUser(@NotNull Object player) {
ServerPlayer p = (ServerPlayer) player;
Object channel = getChannel(p);

Expand Down
3 changes: 2 additions & 1 deletion velocity/src/main/java/io/github/retrooper/packetevents/manager/PlayerManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import io.github.retrooper.packetevents.impl.netty.manager.player.PlayerManagerAbstract;
import io.netty.channel.Channel;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class PlayerManagerImpl extends PlayerManagerAbstract {
private static Class<?> CONNECTED_PLAYER, MINECRAFT_CONNECTION_CLASS;
Expand All @@ -35,7 +36,7 @@ public int getPing(@NotNull Object player) {
}

@Override
public Object getChannel(@NotNull Object player) {
public @Nullable Object getChannel(@NotNull Object player) {
ProtocolManager protocolManager = PacketEvents.getAPI().getProtocolManager();
Object channel = protocolManager.getChannel(((Player) player).getUniqueId());
if (channel == null) {
Expand Down
Loading