Package me.remigio07.chatplugin.api.common.player

Class OfflinePlayer

java.lang.Object

me.remigio07.chatplugin.api.common.player.OfflinePlayer

Direct Known Subclasses:

ChatPluginProxyPlayer, ChatPluginServerPlayer

public class OfflinePlayer
extends Object

Represents an offline player.

This object contains just two values: a UUID and a name. You can manually create offline players to interact with the plugin's code (for example with the punishment system) from an online player or just a UUID and a name. They may also be used to interact with the storage.

See Also:

• ChatPluginPlayer
• PlayerAdapter

Constructor Summary

Constructors

Constructor	Description
OfflinePlayer(String name)	Gets an offline player by their name.
OfflinePlayer(UUID uuid)	Gets an offline player by their UUID.
OfflinePlayer(UUID uuid, String name)	Constructs an offline player using given UUID and name.
OfflinePlayer(PlayerAdapter player)	Constructs an offline player using an existing PlayerAdapter's UUID and name.
OfflinePlayer(CommandSenderAdapter sender)	Constructs an offline player using an existing CommandSenderAdapter's UUID and name.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks if another object is an instance of OfflinePlayer and if this player's getUUID() (if running on online mode) or getName() (if running on offline mode) value is equal to the other object's one.
InetAddress	getIPAddress()	Gets this player's IP address.
String	getName()	Gets this player's name.
UUID	getUUID()	Gets this player's UUID.
int	hashCode()	Gets this player's hash code.
boolean	hasPermission(String permission)	Checks if this player has the specified permission.
boolean	hasPlayedBefore()	Checks if this player is contained in the DataContainer.PLAYERS data container using StorageConnector.isPlayerStored(OfflinePlayer).
boolean	isLoaded()	Checks if this player is loaded.
boolean	isOnline()	Checks if this player is online.
boolean	isPremiumAccount()	Checks if the specified player corresponds to a registered premium username.
PlayerAdapter	toAdapter()	Gets this player's corresponding PlayerAdapter object.
ChatPluginProxyPlayer	toProxyPlayer()	Gets this player's corresponding ChatPluginProxyPlayer object.
ChatPluginServerPlayer	toServerPlayer()	Gets this player's corresponding ChatPluginServerPlayer object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OfflinePlayer

public OfflinePlayer(PlayerAdapter player)

Constructs an offline player using an existing PlayerAdapter's UUID and name.

Parameters:

player - Online player

OfflinePlayer

public OfflinePlayer(CommandSenderAdapter sender)

Constructs an offline player using an existing CommandSenderAdapter's UUID and name.

Parameters:

sender - Command sender

OfflinePlayer

public OfflinePlayer(UUID uuid,
 String name)

Constructs an offline player using given UUID and name.

Note: this constructor is not checked and you should use it only if you are sure that the specified UUID and name corresponds to an existing account, which could be either premium or unauthenticated.

Parameters:

uuid - Player's UUID

name - Player's name

OfflinePlayer

public OfflinePlayer(UUID uuid)
              throws SQLException,
IOException

Gets an offline player by their UUID.

In order to obtain their name, the following operations will be performed:

1. if they are online, use the online player's name
2. check if they are saved in DataContainer.PLAYERS
3. check the UUID.version():
    if == 3, throw UnsupportedOperationException
    if == 4, check if the UUID belongs to a premium account:
     if true, fetch the name from Mojang's servers
     if false, set name to null and UUID to Utils.NIL_UUID

Note: this constructor may take some time to be executed when ChatPlugin.isOnlineMode(): async calls are recommended.

Parameters:

uuid - Player's UUID

Throws:

UnsupportedOperationException - When trying to obtain the name using an offline UUID

SQLException - If a database error occurrs (StorageMethod.isDatabase())

IOException - If name fetching is required and could not be completed

OfflinePlayer

public OfflinePlayer(String name)
              throws SQLException,
IOException

Gets an offline player by their name.

In order to obtain their UUID, the following operations will be performed:

1. if specified name !Utils.isValidUsername(String), throw IllegalArgumentException
2. if they are online, use the online player's UUID and name
3. check if they are saved in DataContainer.PLAYERS:
    if true, use the UUID and name stored in the storage
    if false, check if ChatPlugin.isOnlineMode():
     if false, use UUIDFetcher.getOfflineUUID(String)
     if true, check if the name belongs to a premium account:
      if true, fetch the name from Mojang's servers
      if false, set name to null and UUID to Utils.NIL_UUID

Note: this constructor may take some time to be executed when ChatPlugin.isOnlineMode(): async calls are recommended.

Parameters:

name - Player's name

Throws:

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

SQLException - If a database error occurrs (StorageMethod.isDatabase())

IOException - If name or UUID fetching is required and could not be completed

Method Details

isPremiumAccount

public boolean isPremiumAccount()

Checks if the specified player corresponds to a registered premium username.

Returns:

Whether this player is premium

equals

public boolean equals(Object obj)

Checks if another object is an instance of OfflinePlayer and if this player's getUUID() (if running on online mode) or getName() (if running on offline mode) value is equal to the other object's one.

Overrides:

equals in class Object

Parameters:

obj - Object to compare

Returns:

Whether the two objects are equal

Throws:

IllegalStateException - If ChatPlugin.isOnlineMode() cannot be run yet

hashCode

public int hashCode()

Gets this player's hash code.

Will return getUUID()'s (if running on online mode) or getName()'s (if running on offline mode) hash code or -1 if the name is null.

Overrides:

hashCode in class Object

Returns:

Player's hash code

Throws:

IllegalStateException - If ChatPlugin.isOnlineMode() cannot be run yet

getUUID

public UUID getUUID()

Gets this player's UUID.

Will return Utils.NIL_UUID if ChatPlugin.isOnlineMode() and the UUID or the name specified at construction did not belong to a premium player.

Returns:

Player's UUID

getName

public String getName()

Gets this player's name.

Will return null if ChatPlugin.isOnlineMode() and the UUID or the name specified at construction did not belong to a premium player.

Returns:

Player's name

getIPAddress

public InetAddress getIPAddress()

Gets this player's IP address.

Will grab it from the storage if they are offline, but it will return null if they have never joined the server before.

Note: BungeeCord supports connections via Unix domain sockets. If this method is called on a player connected through a Unix domain socket, "127.0.0.1" is returned.

Returns:

Player's IP address

isOnline

public boolean isOnline()

Checks if this player is online.

Returns:

Whether this player is online

isLoaded

public boolean isLoaded()

Checks if this player is loaded.

Returns:

Whether this player is loaded

See Also:

• PlayerManager

hasPlayedBefore

public boolean hasPlayedBefore()

Checks if this player is contained in the DataContainer.PLAYERS data container using StorageConnector.isPlayerStored(OfflinePlayer).

Returns:

Whether this player has played before

hasPermission

public boolean hasPermission(String permission)

Checks if this player has the specified permission.

Will always return false unless isOnline() or a PermissionIntegration is enabled: in those cases, it will be actually checked.

Note: this method might take some time to be executed: async calls are recommended.

Parameters:

permission - Permission to check

Returns:

Whether this player has the permission

toAdapter

public PlayerAdapter toAdapter()

Gets this player's corresponding PlayerAdapter object.

Will return null if !isOnline().

Returns:

Corresponding PlayerAdapter

toServerPlayer

public ChatPluginServerPlayer toServerPlayer()

Gets this player's corresponding ChatPluginServerPlayer object.

Will return null if !isLoaded().

Returns:

Corresponding ChatPluginServerPlayer

Throws:

UnsupportedOperationException - If Environment.isProxy()

toProxyPlayer

public ChatPluginProxyPlayer toProxyPlayer()

Gets this player's corresponding ChatPluginProxyPlayer object.

Will return null if !isLoaded().

Returns:

Corresponding ChatPluginProxyPlayer

Throws:

UnsupportedOperationException - If !Environment.isProxy()