Added enhanced exception checks and documentation.

This commit is contained in:
Aust1n46 2021-02-12 15:27:43 -06:00
parent 868b84aac8
commit bd6c5d0987

View File

@ -2,73 +2,158 @@ package mineverse.Aust1n46.chat.api;
import java.util.UUID; import java.util.UUID;
import org.bukkit.entity.Player;
import mineverse.Aust1n46.chat.MineverseChat; import mineverse.Aust1n46.chat.MineverseChat;
import mineverse.Aust1n46.chat.bungee.MineverseChatBungee; import mineverse.Aust1n46.chat.bungee.MineverseChatBungee;
import org.bukkit.entity.Player; /**
* API class for looking up wrapped {@link MineverseChatPlayer} objects from
//Beginning of the MineverseChat API, this class contains methods to obtain access to a MineverseChatPlayer using either * {@link Player}, {@link UUID}, or {@link String} user names.
//a player pointer, a UUID, or a name in the form of a string. *
* @author Aust1n46
*/
public final class MineverseChatAPI { public final class MineverseChatAPI {
/**
* Get a MineverseChatPlayer wrapper from a Bukkit Player instance.
*
* @param player
* {@link Player} object.
* @return {@link MineverseChatPlayer}
*/
public static MineverseChatPlayer getMineverseChatPlayer(Player player) { public static MineverseChatPlayer getMineverseChatPlayer(Player player) {
for(MineverseChatPlayer mcp : MineverseChat.players) { for (MineverseChatPlayer mcp : MineverseChat.players) {
if(mcp.getName().equals(player.getName())) { try {
if (mcp.getName().equals(player.getName())) {
return mcp; return mcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }
/**
* Get a MineverseChatPlayer wrapper from a UUID.
*
* @param uuid
* {@link UUID}.
* @return {@link MineverseChatPlayer}
*/
public static MineverseChatPlayer getMineverseChatPlayer(UUID uuid) { public static MineverseChatPlayer getMineverseChatPlayer(UUID uuid) {
for(MineverseChatPlayer mcp : MineverseChat.players) { for (MineverseChatPlayer mcp : MineverseChat.players) {
if(mcp.getUUID().toString().equals(uuid.toString())) { try {
if (mcp.getUUID().toString().equals(uuid.toString())) {
return mcp; return mcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }
/**
* Get a MineverseChatPlayer wrapper from a user name.
*
* @param name
* {@link String}.
* @return {@link MineverseChatPlayer}
*/
public static MineverseChatPlayer getMineverseChatPlayer(String name) { public static MineverseChatPlayer getMineverseChatPlayer(String name) {
for(MineverseChatPlayer mcp : MineverseChat.players) { for (MineverseChatPlayer mcp : MineverseChat.players) {
if(mcp.getName().equalsIgnoreCase(name)) { try {
if (mcp.getName().equalsIgnoreCase(name)) {
return mcp; return mcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }
/**
* Get a MineverseChatPlayer wrapper from a Bukkit Player instance. Only checks
* current online players. Much more efficient!
*
* @param player
* {@link Player} object.
* @return {@link MineverseChatPlayer}
*/
public static MineverseChatPlayer getOnlineMineverseChatPlayer(Player player) { public static MineverseChatPlayer getOnlineMineverseChatPlayer(Player player) {
for(MineverseChatPlayer mcp : MineverseChat.onlinePlayers) { for (MineverseChatPlayer mcp : MineverseChat.onlinePlayers) {
if(mcp.getName().equals(player.getName())) { try {
if (mcp.getName().equals(player.getName())) {
return mcp; return mcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }
/**
* Get a MineverseChatPlayer wrapper from a UUID. Only checks current online
* players. Much more efficient!
*
* @param uuid
* {@link UUID}.
* @return {@link MineverseChatPlayer}
*/
public static MineverseChatPlayer getOnlineMineverseChatPlayer(UUID uuid) { public static MineverseChatPlayer getOnlineMineverseChatPlayer(UUID uuid) {
for(MineverseChatPlayer mcp : MineverseChat.onlinePlayers) { for (MineverseChatPlayer mcp : MineverseChat.onlinePlayers) {
if(mcp.getUUID().toString().equals(uuid.toString())) { try {
if (mcp.getUUID().toString().equals(uuid.toString())) {
return mcp; return mcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }
/**
* Get a MineverseChatPlayer wrapper from a user name. Only checks current
* online players. Much more efficient!
*
* @param name
* {@link String}.
* @return {@link MineverseChatPlayer}
*/
public static MineverseChatPlayer getOnlineMineverseChatPlayer(String name) { public static MineverseChatPlayer getOnlineMineverseChatPlayer(String name) {
for(MineverseChatPlayer mcp : MineverseChat.onlinePlayers) { for (MineverseChatPlayer mcp : MineverseChat.onlinePlayers) {
if(mcp.getName().equalsIgnoreCase(name)) { try {
if (mcp.getName().equalsIgnoreCase(name)) {
return mcp; return mcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }
/**
* Get a SynchronizedMineverseChatPlayer from a UUID.
*
* @param uuid
* {@link UUID}
* @return {@link SynchronizedMineverseChatPlayer}
*/
public static SynchronizedMineverseChatPlayer getSynchronizedMineverseChatPlayer(UUID uuid) { public static SynchronizedMineverseChatPlayer getSynchronizedMineverseChatPlayer(UUID uuid) {
for(SynchronizedMineverseChatPlayer smcp : MineverseChatBungee.players) { for (SynchronizedMineverseChatPlayer smcp : MineverseChatBungee.players) {
if(smcp.getUUID().toString().equals(uuid.toString())) { try {
if (smcp.getUUID().toString().equals(uuid.toString())) {
return smcp; return smcp;
} }
} catch (Exception exception) {
continue;
}
} }
return null; return null;
} }