Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-11-24 19:55:17 +01:00
Code Issues Projects Releases Wiki Activity

Improved Javadocs in User

Browse Source
This commit is contained in:
Florian CUNY 2019-01-01 21:50:20 +01:00
parent 3bc36b54c9
commit 4a7a4ed7db
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/main/java/world/bentobox/bentobox/api/user/User.java
View File

@ -17,9 +17,15 @@ import org.bukkit.util.Vector;
import world.bentobox.bentobox.BentoBox; import world.bentobox.bentobox.BentoBox;
/** /**
* BSB's user object. Wraps Player. * Combines {@link Player}, {@link OfflinePlayer} and {@link CommandSender} to provide convenience methods related to
* @author tastybento * localization and generic interactions.
* <br/>
* Therefore, a User could usually be a Player, an OfflinePlayer or the server's console.
* Preliminary checks should be performed before trying to run methods that relies on a specific implementation.
* <br/><br/>
* It is good practice to use the User instance whenever possible instead of Player or CommandSender.
* *
* @author tastybento
*/ */
public class User { public class User {
@ -33,7 +39,7 @@ public class User {
} }
/** /**
* Get an instance of User from a CommandSender * Gets an instance of User from a CommandSender
* @param sender - command sender, e.g. console * @param sender - command sender, e.g. console
* @return user - user * @return user - user
*/ */
@ -44,8 +50,9 @@ public class User {
// Console // Console
return new User(sender); return new User(sender);
} }
/** /**
* Get an instance of User from a Player object * Gets an instance of User from a Player object
* @param player - the player * @param player - the player
* @return user - user * @return user - user
*/ */
@ -58,8 +65,9 @@ public class User {
} }
return new User(player); return new User(player);
} }
/** /**
* Get an instance of User from a UUID * Gets an instance of User from a UUID
* @param uuid - UUID * @param uuid - UUID
* @return user - user * @return user - user
*/ */
@ -73,9 +81,10 @@ public class User {
// Return player, or null if they are not online // Return player, or null if they are not online
return new User(uuid); return new User(uuid);
} }
/** /**
* Removes this player from the User cache * Removes this player from the User cache
* @param player - the player * @param player the player
*/ */
public static void removePlayer(Player player) { public static void removePlayer(Player player) {
users.remove(player.getUniqueId()); users.remove(player.getUniqueId());
@ -342,7 +351,6 @@ public class User {
return Locale.forLanguageTag(plugin.getPlayers().getLocale(playerUUID)); return Locale.forLanguageTag(plugin.getPlayers().getLocale(playerUUID));
} }
return Locale.forLanguageTag(plugin.getSettings().getDefaultLanguage()); return Locale.forLanguageTag(plugin.getSettings().getDefaultLanguage());
} }
/** /**
@ -351,7 +359,6 @@ public class User {
*/ */
public void updateInventory() { public void updateInventory() {
player.updateInventory(); player.updateInventory();
} }
/** /**
@ -421,6 +428,7 @@ public class User {
result = prime * result + ((playerUUID == null) ? 0 : playerUUID.hashCode()); result = prime * result + ((playerUUID == null) ? 0 : playerUUID.hashCode());
return result; return result;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object) * @see java.lang.Object#equals(java.lang.Object)
*/ */