Package xyz.gmitch215.socketmc.spigot

Class SocketPlayerRegistry

java.lang.Object

xyz.gmitch215.socketmc.spigot.SocketPlayerRegistry

public final class SocketPlayerRegistry
extends Object

Thread-safe utility class for caching a SocketPlayer object.

Method Summary

Modifier and Type	Method	Description
static @NotNull SocketPlayer	create(@NotNull UUID pid)	Creates a new SocketPlayer object and caches it.
static @NotNull SocketPlayer	create(@NotNull Player p)	Creates a new SocketPlayer object and caches it.
static @NotNull SocketPlayer	createIfAbsent(@NotNull UUID pid)	Creates a new SocketPlayer object and caches it if one does not already exist.
static @NotNull SocketPlayer	createIfAbsent(@NotNull Player p)	Creates a new SocketPlayer object and caches it if one does not already exist.
static @Nullable SocketPlayer	get(@NotNull UUID pid)	Gets a SocketPlayer object from the cache.
static @Nullable SocketPlayer	get(@NotNull Player p)	Gets a SocketPlayer object from the cache.
static void	remove(@NotNull UUID pid)	Removes a SocketPlayer object from the cache.
static void	remove(@NotNull Player p)	Removes a SocketPlayer object from the cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

@Nullable
public static @Nullable SocketPlayer get(@NotNull
 @NotNull UUID pid)

Gets a SocketPlayer object from the cache.

Parameters:

pid - The UUID of the player to get the object for.

Returns:

The SocketPlayer object, or null if the player is not in the cache.

get

@Nullable
public static @Nullable SocketPlayer get(@NotNull
 @NotNull Player p)

Gets a SocketPlayer object from the cache.

Parameters:

p - The player to get the object for.

Returns:

The SocketPlayer object, or null if the player is not in the cache.

create

@NotNull
public static @NotNull SocketPlayer create(@NotNull
 @NotNull UUID pid)

Creates a new SocketPlayer object and caches it. This will remove any existing object for the player.

Parameters:

pid - The UUID of the player to create the object for.

Returns:

The new SocketPlayer object.

create

@NotNull
public static @NotNull SocketPlayer create(@NotNull
 @NotNull Player p)

Creates a new SocketPlayer object and caches it. This will remove any existing object for the player.

Parameters:

p - The player to create the object for.

Returns:

The new SocketPlayer object.

createIfAbsent

@NotNull
public static @NotNull SocketPlayer createIfAbsent(@NotNull
 @NotNull UUID pid)

Creates a new SocketPlayer object and caches it if one does not already exist.

Parameters:

pid - The UUID of the player to create the object for.

Returns:

The SocketPlayer object.

createIfAbsent

@NotNull
public static @NotNull SocketPlayer createIfAbsent(@NotNull
 @NotNull Player p)

Creates a new SocketPlayer object and caches it if one does not already exist.

Parameters:

p - The player to create the object for.

Returns:

The SocketPlayer object.

remove

public static void remove(@NotNull
 @NotNull UUID pid)

Removes a SocketPlayer object from the cache.

Parameters:

pid - The UUID of the player to remove the object for.

remove

public static void remove(@NotNull
 @NotNull Player p)

Removes a SocketPlayer object from the cache.

Parameters:

p - The player to remove the object for.