Package me.remigio07.chatplugin.api.common.util

Class UUIDFetcher

java.lang.Object

me.remigio07.chatplugin.api.common.util.UUIDFetcher

public abstract class UUIDFetcher
extends Object

Util class used to calculate and fetch Java and Bedrock players' UUIDs and names.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	CLASSIC_GAMERTAG_PATTERN	Pattern representing the allowed classic gamertags.

Constructor Summary

Constructors

Constructor	Description
UUIDFetcher()

Method Summary

Modifier and Type	Method	Description
static UUID	dash(String nonDashedUUID)	Applies dashes to the given UUID.
static UUIDFetcher	getInstance()	Gets the fetcher's current instance.
abstract CompletableFuture<String>	getName(long xuid)	Gets a Bedrock player's name.
abstract CompletableFuture<String>	getName(UUID uuid)	Gets a Java or Bedrock player's name based on the input: UUIDv0 for a Bedrock player UUIDv4 for a Java player
abstract UUID	getOfflineUUID(String name)	Calculates the specified Java player's offline UUIDv3 using UUID.nameUUIDFromBytes(byte[]).
abstract UUID	getOnlineUUID(long xuid)	Gets a Bedrock player's UUID.
abstract CompletableFuture<UUID>	getOnlineUUID(String name)	Gets a Java or Bedrock player's UUID based on the input: a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock player any other name for a Java player
abstract CompletableFuture<String>	getSkinTextureURL(long xuid)	Gets a Bedrock player's skin's texture's URL.
abstract CompletableFuture<String>	getSkinTextureURL(String name)	Gets a Java or Bedrock player's skin's texture's URL based on the input: a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock player any other name for a Java player
abstract CompletableFuture<String>	getSkinTextureURL(UUID uuid)	Gets a Java or Bedrock player's skin's texture's URL based on the input: UUIDv0 for a Bedrock player UUIDv4 for a Java player
abstract CompletableFuture<UUID>	getUUID(String name)	Gets a Java (online or offline) or Bedrock player's UUID based on the input: a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock player any other name while ChatPlugin.isOnlineMode() for a Java online player any other name while !ChatPlugin.isOnlineMode() for a Java offline player
abstract CompletableFuture<Long>	getXUID(String name)	Gets a Bedrock player's XUID by: their in-game username (a name starting with PlayerManager.getFloodgateUsernamePrefix() matching PlayerManager.getUsernamePattern()) their gamertag (any other name)
abstract long	getXUID(UUID uuid)	Gets a Bedrock player's XUID.
static boolean	isValidClassicGamertag(String classicGamertag)	Checks if the specified String is a valid classic gamertag.

Methods inherited from class java.lang.Object

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

Field Details

CLASSIC_GAMERTAG_PATTERN

public static final Pattern CLASSIC_GAMERTAG_PATTERN

Pattern representing the allowed classic gamertags.

Note: Microsoft's classic gamertags' documentation is not exhaustive at all:

• commas (',') should be allowed in gamertags, however, out of ~40M accounts tracked by GeyserMC, none of these contains any; this pattern does not allow commas
• it is unclear whether space-only and number-only gamertags are allowed; this pattern does not perform that kind of validation
• it is unclear where and how many consecutive spaces are allowed; this pattern does not perform that kind of validation

Regex: ^[a-zA-Z0-9 ]{1,15}$

See Also:

• isValidClassicGamertag(String)

Constructor Details

UUIDFetcher

public UUIDFetcher()

Method Details

getName

public abstract CompletableFuture<String> getName(UUID uuid)

Gets a Java or Bedrock player's name based on the input:

• UUIDv0 for a Bedrock player
• UUIDv4 for a Java player

The future throws:

• NoSuchElementException if the UUID does not belong to a paid Java or Bedrock account
• IOException if a connection or JSON error occurs

Parameters:

uuid - Java or Bedrock player's UUID

Returns:

Java or Bedrock player's name

Throws:

IllegalArgumentException - If UUID.version() != 0 && UUID.version() != 4

getName

public abstract CompletableFuture<String> getName(long xuid)

Gets a Bedrock player's name.

The future throws:

• NoSuchElementException if the XUID does not belong to a paid Bedrock account
• IOException if a connection or JSON error occurs

Parameters:

xuid - Bedrock player's XUID

Returns:

Bedrock player's name

getUUID

public abstract CompletableFuture<UUID> getUUID(String name)

Gets a Java (online or offline) or Bedrock player's UUID based on the input:

• a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock player
• any other name while ChatPlugin.isOnlineMode() for a Java online player
• any other name while !ChatPlugin.isOnlineMode() for a Java offline player

The future is instantly completed and will not throw any exception if specified name is not a Bedrock username and !ChatPlugin.isOnlineMode().

The future throws:

• NoSuchElementException if the name does not belong to a paid Java (if ChatPlugin.isOnlineMode()) or Bedrock account
• IOException if a connection or JSON error occurs

Parameters:

name - Java (online or offline) or Bedrock player's name

Returns:

Java (online or offline) or Bedrock player's UUID

Throws:

IllegalArgumentException - If specified name !PlayerManager.isValidUsername(String)

getOnlineUUID

public abstract CompletableFuture<UUID> getOnlineUUID(String name)

Gets a Java or Bedrock player's UUID based on the input:

• a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock player
• any other name for a Java player

The future throws:

• NoSuchElementException if the name does not belong to a paid Java or Bedrock account
• IOException if a connection or JSON error occurs

Parameters:

name - Java or Bedrock player's name

Returns:

Java or Bedrock player's UUID

Throws:

IllegalArgumentException - If specified name !PlayerManager.isValidUsername(String)

getOnlineUUID

public abstract UUID getOnlineUUID(long xuid)

Gets a Bedrock player's UUID.

This simply converts the specified XUID to its corresponding UUIDv0; no validation is performed.

Parameters:

xuid - Bedrock player's XUID

Returns:

Bedrock player's UUID

getOfflineUUID

public abstract UUID getOfflineUUID(String name)

Calculates the specified Java player's offline UUIDv3 using UUID.nameUUIDFromBytes(byte[]).

Parameters:

name - Java player's offline name

Returns:

Java player's offline UUIDv3

Throws:

IllegalArgumentException - If specified name is a Bedrock username or !PlayerManager.isValidUsername(String)

getXUID

public abstract CompletableFuture<Long> getXUID(String name)

Gets a Bedrock player's XUID by:

• their in-game username (a name starting with PlayerManager.getFloodgateUsernamePrefix() matching PlayerManager.getUsernamePattern())
• their gamertag (any other name)

The future throws:

• NoSuchElementException if the name does not belong to a paid Bedrock account
• IOException if a connection or JSON error occurs

Parameters:

name - Bedrock player's name or gamertag

Returns:

Bedrock player's XUID

Throws:

IllegalArgumentException - If !PlayerManager.isValidUsername(String) && !isValidClassicGamertag(String)

getXUID

public abstract long getXUID(UUID uuid)

Gets a Bedrock player's XUID.

This simply converts the specified UUIDv0 to its corresponding XUID; only a check on UUID.version() is performed.

Parameters:

uuid - Bedrock player's UUID

Returns:

Bedrock player's XUID

Throws:

IllegalArgumentException - If UUID.version() != 0

getSkinTextureURL

public abstract CompletableFuture<String> getSkinTextureURL(String name)

Gets a Java or Bedrock player's skin's texture's URL based on the input:

• a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock player
• any other name for a Java player

The future throws:

• NoSuchElementException if the name does not belong to a paid Java or Bedrock account with a skin
• IOException if a connection or JSON error occurs

All paid Java accounts have a default skin, but Bedrock ones do not. Skin texture URLs always point to textures.minecraft.net.

Parameters:

name - Java or Bedrock player's name

Returns:

Java or Bedrock player's skin's texture's URL

Throws:

IllegalArgumentException - If specified name !PlayerManager.isValidUsername(String)

getSkinTextureURL

public abstract CompletableFuture<String> getSkinTextureURL(UUID uuid)

Gets a Java or Bedrock player's skin's texture's URL based on the input:

• UUIDv0 for a Bedrock player
• UUIDv4 for a Java player

The future throws:

• NoSuchElementException if the UUID does not belong to a paid Java or Bedrock account with a skin
• IOException if a connection or JSON error occurs

All paid Java accounts have a default skin, but Bedrock ones do not. Skin texture URLs always point to textures.minecraft.net.

Parameters:

uuid - Java or Bedrock player's UUID

Returns:

Java or Bedrock player's skin's texture's URL

Throws:

IllegalArgumentException - If UUID.version() != 0 && UUID.version() != 4

getSkinTextureURL

public abstract CompletableFuture<String> getSkinTextureURL(long xuid)

Gets a Bedrock player's skin's texture's URL.

The future throws:

• NoSuchElementException if the XUID does not belong to a paid Bedrock account with a skin
• IOException if a connection or JSON error occurs

All paid Java accounts have a default skin, but Bedrock ones do not. Skin texture URLs always point to textures.minecraft.net.

Parameters:

xuid - Bedrock player's XUID

Returns:

Bedrock player's skin's texture's URL

getInstance

public static UUIDFetcher getInstance()

Gets the fetcher's current instance.

Returns:

Current instance

dash

public static UUID dash(String nonDashedUUID)

Applies dashes to the given UUID.

Example: "e1b47c83541c4a2a91d0b382279e9017" ➝ "e1b47c83-541c-4a2a-91d0-b382279e9017"

Parameters:

nonDashedUUID - UUID to dash

Returns:

Dashed UUID

Throws:

IllegalArgumentException - If specified UUID is invalid

isValidClassicGamertag

public static boolean isValidClassicGamertag(String classicGamertag)

Checks if the specified String is a valid classic gamertag.

Parameters:

classicGamertag - Classic gamertag to check

Returns:

Whether the specified classic gamertag is valid

See Also:

• CLASSIC_GAMERTAG_PATTERN