diff --git a/src/main/java/net/milkbowl/vault/chat/Chat.java b/src/main/java/net/milkbowl/vault/chat/Chat.java index 6422be0..2cb2091 100644 --- a/src/main/java/net/milkbowl/vault/chat/Chat.java +++ b/src/main/java/net/milkbowl/vault/chat/Chat.java @@ -45,7 +45,7 @@ public abstract class Chat { abstract public boolean isEnabled(); /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerPrefix(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerPrefix(String, OfflinePlayer)} instead. * * Get players prefix * @param world World name @@ -68,7 +68,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerPrefix(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerPrefix(String, OfflinePlayer)} instead. * * Get players prefix * @param world World Object @@ -92,7 +92,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerPrefix(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerPrefix(String, OfflinePlayer, String)} instead. * * Set players prefix * @param world World name @@ -115,7 +115,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerPrefix(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerPrefix(String, OfflinePlayer, String)} instead. * * Set players prefix in the given world. * @@ -139,7 +139,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerSuffix(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerSuffix(String, OfflinePlayer)} instead. * * Get players suffix * @param world World name @@ -161,7 +161,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerSuffix(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerSuffix(String, OfflinePlayer)} instead. * * Get players suffix * @param world World Object @@ -184,7 +184,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerSuffix(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerSuffix(String, OfflinePlayer, String)} instead. * * Set players suffix * @param world World name @@ -206,7 +206,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerSuffix(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerSuffix(String, OfflinePlayer, String)} instead. * * Set players suffix * @param world World Object @@ -313,7 +313,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. * Get a players informational node (Integer) value * @param world World name * @param player Player name @@ -325,7 +325,7 @@ public abstract class Chat { abstract public int getPlayerInfoInteger(String world, String player, String node, int defaultValue); /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. * * Get a players informational node (Integer) value * @param world World Object @@ -362,7 +362,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. * * Set a players informational node (Integer) value * @param world World name @@ -374,7 +374,7 @@ public abstract class Chat { abstract public void setPlayerInfoInteger(String world, String player, String node, int value); /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoInteger(String, OfflinePlayer, String, int)} instead. * * Set a players informational node (Integer) value * @param world World Object @@ -452,7 +452,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoDouble(String, OfflinePlayer, String, double)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoDouble(String, OfflinePlayer, String, double)} instead. * * Get a players informational node (Double) value * @param world World name @@ -465,7 +465,7 @@ public abstract class Chat { abstract public double getPlayerInfoDouble(String world, String player, String node, double defaultValue); /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoDouble(String, OfflinePlayer, String, double)} instead + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoDouble(String, OfflinePlayer, String, double)} instead * * Get a players informational node (Double) value * @param world World Object @@ -502,7 +502,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoDouble(String, OfflinePlayer, String, double)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoDouble(String, OfflinePlayer, String, double)} instead. * Set a players informational node (Double) value * @param world World name * @param player Player name @@ -513,7 +513,7 @@ public abstract class Chat { abstract public void setPlayerInfoDouble(String world, String player, String node, double value); /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoDouble(String, OfflinePlayer, String, double)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoDouble(String, OfflinePlayer, String, double)} instead. * Set a players informational node (Double) value * @param world World Object * @param player Player name @@ -590,7 +590,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. * * Get a players informational node (Boolean) value * @param world World name @@ -603,7 +603,7 @@ public abstract class Chat { abstract public boolean getPlayerInfoBoolean(String world, String player, String node, boolean defaultValue); /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. * * Get a players informational node (Boolean) value * @param world World Object @@ -640,7 +640,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. * Set a players informational node (Boolean) value * @param world World name * @param player Player name @@ -651,7 +651,7 @@ public abstract class Chat { abstract public void setPlayerInfoBoolean(String world, String player, String node, boolean value); /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoBoolean(String, OfflinePlayer, String, boolean)} instead. * Set a players informational node (Boolean) value * @param world World Object * @param player Player name @@ -728,7 +728,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoString(String, OfflinePlayer, String, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoString(String, OfflinePlayer, String, String)} instead. * * Get a players informational node (String) value * @param world World name @@ -741,7 +741,7 @@ public abstract class Chat { abstract public String getPlayerInfoString(String world, String player, String node, String defaultValue); /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerInfoString(String, OfflinePlayer, String, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerInfoString(String, OfflinePlayer, String, String)} instead. * Get a players informational node (String) value * @param world World Object * @param player Player name @@ -777,7 +777,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoString(String, OfflinePlayer, String, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoString(String, OfflinePlayer, String, String)} instead. * Set a players informational node (String) value * @param world World name * @param player Player name @@ -788,7 +788,7 @@ public abstract class Chat { abstract public void setPlayerInfoString(String world, String player, String node, String value); /** - * @deprecated As of Vault 1.3.01 use {{@link #setPlayerInfoString(String, OfflinePlayer, String, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #setPlayerInfoString(String, OfflinePlayer, String, String)} instead. * Set a players informational node (String) value * @param world World name * @param player Player name @@ -864,7 +864,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #playerInGroup(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #playerInGroup(String, OfflinePlayer, String)} instead. * Check if player is member of a group. * @param world World name * @param player Player name @@ -877,7 +877,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #playerInGroup(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #playerInGroup(String, OfflinePlayer, String)} instead. * Check if player is member of a group. * @param world World Object * @param player Player name @@ -910,7 +910,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerGroups(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerGroups(String, OfflinePlayer)} instead. * Gets the list of groups that this player has * @param world World name * @param player Player name @@ -922,7 +922,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPlayerGroups(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPlayerGroups(String, OfflinePlayer)} instead. * Gets the list of groups that this player has * @param world World Object * @param player Player name @@ -953,7 +953,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPrimaryGroup(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPrimaryGroup(String, OfflinePlayer)} instead. * Gets players primary group * @param world World name * @param player Player name @@ -965,7 +965,7 @@ public abstract class Chat { } /** - * @deprecated As of Vault 1.3.01 use {{@link #getPrimaryGroup(String, OfflinePlayer)} instead. + * @deprecated As of VaultAPI 1.4 use {{@link #getPrimaryGroup(String, OfflinePlayer)} instead. * Gets players primary group * @param world World Object * @param player Player name diff --git a/src/main/java/net/milkbowl/vault/economy/Economy.java b/src/main/java/net/milkbowl/vault/economy/Economy.java index 5aa402a..f427913 100644 --- a/src/main/java/net/milkbowl/vault/economy/Economy.java +++ b/src/main/java/net/milkbowl/vault/economy/Economy.java @@ -80,14 +80,7 @@ public interface Economy { /** * - * @deprecated As of Vault 1.3.01 use {@link #hasAccount(OfflinePlayer)} instead. - * - * Checks if this player has an account on the server yet - * This will always return true if the player has joined the server at least once - * as all major economy plugins auto-generate a player account when the player joins the server - * - * @param playerName to check - * @return if the player has an account + * @deprecated As of VaultAPI 1.4 use {@link #hasAccount(OfflinePlayer)} instead. */ @Deprecated public boolean hasAccount(String playerName); @@ -103,15 +96,7 @@ public interface Economy { public boolean hasAccount(OfflinePlayer player); /** - * @deprecated As of Vault 1.3.01 use {@link #hasAccount(OfflinePlayer, String)} instead. - * - * Checks if this player has an account on the server yet on the given world - * This will always return true if the player has joined the server at least once - * as all major economy plugins auto-generate a player account when the player joins the server - * - * @param playerName to check in the world - * @param worldName world-specific account - * @return if the player has an account + * @deprecated As of VaultAPI 1.4 use {@link #hasAccount(OfflinePlayer, String)} instead. */ @Deprecated public boolean hasAccount(String playerName, String worldName); @@ -128,11 +113,7 @@ public interface Economy { public boolean hasAccount(OfflinePlayer player, String worldName); /** - * @deprecated As of Vault 1.3.01 use {@link #getBalance(OfflinePlayer)} instead. - * Gets balance of a player - * - * @param playerName of the player - * @return Amount currently held in players account + * @deprecated As of VaultAPI 1.4 use {@link #getBalance(OfflinePlayer)} instead. */ @Deprecated public double getBalance(String playerName); @@ -146,13 +127,7 @@ public interface Economy { public double getBalance(OfflinePlayer player); /** - * @deprecated As of Vault 1.3.01 use {@link #getBalance(OfflinePlayer, String)} instead. - * - * Gets balance of a player on the specified world. - * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned. - * @param playerName name of the player - * @param world name of the world - * @return Amount currently held in players account + * @deprecated As of VaultAPI 1.4 use {@link #getBalance(OfflinePlayer, String)} instead. */ @Deprecated public double getBalance(String playerName, String world); @@ -167,13 +142,7 @@ public interface Economy { public double getBalance(OfflinePlayer player, String world); /** - * @deprecated As of Vault 1.3.01 use {@link #has(OfflinePlayer, double)} instead. - * - * Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS - * - * @param playerName to check - * @param amount to check for - * @return True if playerName has amount, False else wise + * @deprecated As of VaultAPI 1.4 use {@link #has(OfflinePlayer, double)} instead. */ @Deprecated public boolean has(String playerName, double amount); @@ -188,15 +157,7 @@ public interface Economy { public boolean has(OfflinePlayer player, double amount); /** - * @deprecated As of Vault 1.3.01 use @{link {@link #has(OfflinePlayer, String, double)} instead. - * - * Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS - * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned. - * - * @param playerName to check - * @param worldName to check with - * @param amount to check for - * @return True if playerName has amount, False else wise + * @deprecated As of VaultAPI 1.4 use @{link {@link #has(OfflinePlayer, String, double)} instead. */ @Deprecated public boolean has(String playerName, String worldName, double amount); @@ -213,12 +174,7 @@ public interface Economy { public boolean has(OfflinePlayer player, String worldName, double amount); /** - * @deprecated As of Vault 1.3.01 use {@link #withdrawPlayer(OfflinePlayer, double)} instead. - * Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS - * - * @param playerName Name of player - * @param amount Amount to withdraw - * @return Detailed response of transaction + * @deprecated As of VaultAPI 1.4 use {@link #withdrawPlayer(OfflinePlayer, double)} instead. */ @Deprecated public EconomyResponse withdrawPlayer(String playerName, double amount); @@ -233,14 +189,7 @@ public interface Economy { public EconomyResponse withdrawPlayer(OfflinePlayer player, double amount); /** - * @deprecated As of Vault 1.3.01 use {@link #withdrawPlayer(OfflinePlayer, String, double)} instead. - * - * Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS - * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned. - * @param playerName Name of player - * @param worldName - name of the world - * @param amount Amount to withdraw - * @return Detailed response of transaction + * @deprecated As of VaultAPI 1.4 use {@link #withdrawPlayer(OfflinePlayer, String, double)} instead. */ @Deprecated public EconomyResponse withdrawPlayer(String playerName, String worldName, double amount); @@ -256,13 +205,7 @@ public interface Economy { public EconomyResponse withdrawPlayer(OfflinePlayer player, String worldName, double amount); /** - * @deprecated As of Vault 1.3.01 use {@link #depositPlayer(OfflinePlayer, double)} instead. - * - * Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS - * - * @param playerName Name of player - * @param amount Amount to deposit - * @return Detailed response of transaction + * @deprecated As of VaultAPI 1.4 use {@link #depositPlayer(OfflinePlayer, double)} instead. */ @Deprecated public EconomyResponse depositPlayer(String playerName, double amount); @@ -277,14 +220,7 @@ public interface Economy { public EconomyResponse depositPlayer(OfflinePlayer player, double amount); /** - * @deprecated As of Vault 1.3.01 use {@link #depositPlayer(OfflinePlayer, String, double)} instead. - * - * Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS - * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned. - * @param playerName Name of player - * @param worldName Name of the world - * @param amount Amount to deposit - * @return Detailed response of transaction + * @deprecated As of VaultAPI 1.4 use {@link #depositPlayer(OfflinePlayer, String, double)} instead. */ @Deprecated public EconomyResponse depositPlayer(String playerName, String worldName, double amount); @@ -292,6 +228,7 @@ public interface Economy { /** * Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned. + * * @param player to deposit to * @param worldName name of the world * @param amount Amount to deposit @@ -300,12 +237,7 @@ public interface Economy { public EconomyResponse depositPlayer(OfflinePlayer player, String worldName, double amount); /** - * @deprecated As of Vault 1.3.01 use {{@link #createBank(String, OfflinePlayer)} instead. - * - * Creates a bank account with the specified name and the player as the owner - * @param name of account - * @param player the account should be linked to - * @return EconomyResponse Object + * @deprecated As of VaultAPI 1.4 use {{@link #createBank(String, OfflinePlayer)} instead. */ @Deprecated public EconomyResponse createBank(String name, String player); @@ -360,13 +292,7 @@ public interface Economy { public EconomyResponse bankDeposit(String name, double amount); /** - * @deprecated As of Vault 1.3.01 use {{@link #isBankOwner(String, OfflinePlayer)} instead. - * - * Check if a player is the owner of a bank account - * - * @param name of the account - * @param playerName to check for ownership - * @return EconomyResponse Object + * @deprecated As of VaultAPI 1.4 use {{@link #isBankOwner(String, OfflinePlayer)} instead. */ @Deprecated public EconomyResponse isBankOwner(String name, String playerName); @@ -381,13 +307,7 @@ public interface Economy { public EconomyResponse isBankOwner(String name, OfflinePlayer player); /** - * @deprecated As of Vault 1.3.01 use {{@link #isBankMember(String, OfflinePlayer)} instead. - * - * Check if the player is a member of the bank account - * - * @param name of the account - * @param playerName to check membership - * @return EconomyResponse Object + * @deprecated As of VaultAPI 1.4 use {{@link #isBankMember(String, OfflinePlayer)} instead. */ @Deprecated public EconomyResponse isBankMember(String name, String playerName); @@ -408,11 +328,7 @@ public interface Economy { public List getBanks(); /** - * @deprecated As of Vault 1.3.01 use {{@link #createPlayerAccount(OfflinePlayer)} instead. - * - * Attempts to create a player account for the given player - * @param playerName name of the player - * @return if the account creation was successful + * @deprecated As of VaultAPI 1.4 use {{@link #createPlayerAccount(OfflinePlayer)} instead. */ @Deprecated public boolean createPlayerAccount(String playerName); @@ -425,13 +341,7 @@ public interface Economy { public boolean createPlayerAccount(OfflinePlayer player); /** - * @deprecated As of Vault 1.3.01 use {{@link #createPlayerAccount(OfflinePlayer, String)} instead. - * - * Attempts to create a player account for the given player on the specified world - * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned. - * @param playerName String name of the player - * @param worldName String name of the world - * @return if the account creation was successful + * @deprecated As of VaultAPI 1.4 use {{@link #createPlayerAccount(OfflinePlayer, String)} instead. */ @Deprecated public boolean createPlayerAccount(String playerName, String worldName); diff --git a/src/main/java/net/milkbowl/vault/permission/Permission.java b/src/main/java/net/milkbowl/vault/permission/Permission.java index a5f5acd..e5d3b60 100644 --- a/src/main/java/net/milkbowl/vault/permission/Permission.java +++ b/src/main/java/net/milkbowl/vault/permission/Permission.java @@ -53,15 +53,7 @@ public abstract class Permission { abstract public boolean hasSuperPermsCompat(); /** - * @deprecated As of Vault 1.3.01 use {@link #playerHas(String, OfflinePlayer, String)} instead. - * Checks if player has a permission node. (Short for playerHas(...) - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World name - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerHas(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean has(String world, String player, String permission) { @@ -72,15 +64,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerHas(String, OfflinePlayer, String)} instead. - * Checks if player has a permission node. (Short for playerHas(...) - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerHas(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean has(World world, String player, String permission) { @@ -115,29 +99,13 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerHas(String, OfflinePlayer, String)} instead. - * Checks if player has a permission node. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World name - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerHas(String, OfflinePlayer, String)} instead. */ @Deprecated abstract public boolean playerHas(String world, String player, String permission); /** - * @deprecated As of Vault 1.3.01 use {@link #playerHas(String, OfflinePlayer, String)} instead. - * Checks if player has a permission node. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerHas(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerHas(World world, String player, String permission) { @@ -149,6 +117,8 @@ public abstract class Permission { /** * Checks if player has a permission node. + * Supports NULL value for World if the permission system registered supports global permissions. + * But May return odd values if the servers registered permission system does not have a global permission store. * * @param world String world name * @param player to check @@ -164,6 +134,9 @@ public abstract class Permission { /** * Checks if player has a permission node. + * Defaults to world-specific permission check if the permission system supports it. + * See {@link #playerHas(String, OfflinePlayer, String)} for explicit global or world checks. + * * @param player Player Object * @param permission Permission node * @return Success or Failure @@ -173,7 +146,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerAdd(String, OfflinePlayer, String)} instead. + * @deprecated As of VaultAPI 1.4 use {@link #playerAdd(String, OfflinePlayer, String)} instead. * Add permission to a player. * Supports NULL value for World if the permission system registered supports global permissions. * But May return odd values if the servers registered permission system does not have a global permission store. @@ -187,15 +160,7 @@ public abstract class Permission { abstract public boolean playerAdd(String world, String player, String permission); /** - * @deprecated As of Vault 1.3.01 use {@link #playerAdd(String, OfflinePlayer, String)} instead. - * Add permission to a player. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerAdd(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerAdd(World world, String player, String permission) { @@ -225,6 +190,7 @@ public abstract class Permission { /** * Add permission to a player ONLY for the world the player is currently on. * This is a world-specific operation, if you want to add global permission you must explicitly use NULL for the world. + * See {@link #playerAdd(String, OfflinePlayer, String)} for global permission use. * * @param player Player Object * @param permission Permission node @@ -235,15 +201,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerAddTransient(OfflinePlayer, String)} instead. - * Add transient permission to a player. - * This implementation can be used by any subclass which implements a "pure" superperms plugin, i.e. - * one that only needs the built-in Bukkit API to add transient permissions to a player. Any subclass - * implementing a plugin which provides its own API for this needs to override this method. - * - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerAddTransient(OfflinePlayer, String)} instead. */ @Deprecated public boolean playerAddTransient(String player, String permission) throws UnsupportedOperationException { @@ -272,7 +230,7 @@ public abstract class Permission { /** * Add transient permission to a player. - * This operation adds a world-unspecific permission onto the player object in bukkit via Bukkit's permission interface. + * This operation adds a permission onto the player object in bukkit via Bukkit's permission interface. * * @param player Player Object * @param permission Permission node @@ -293,7 +251,8 @@ public abstract class Permission { } /** - * Adds a world specific transient permission to the player - ONLY WORKS IN PEX/P3 - otherwise it defaults to GLOBAL! + * Adds a world specific transient permission to the player, may only work with some permission managers. + * Defaults to GLOBAL permissions for any permission system that does not support world-specific transient permissions! * * @param worldName to check on * @param player to add to @@ -305,7 +264,9 @@ public abstract class Permission { } /** - * Adds a world specific transient permission to the player - ONLY WORKS IN PEX/P3 - otherwise it defaults to GLOBAL! + * Adds a world specific transient permission to the player, may only work with some permission managers. + * Defaults to GLOBAL permissions for any permission system that does not support world-specific transient permissions! + * * @param worldName to check on * @param player to check * @param permission to check for @@ -316,12 +277,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerAddTransient(String, OfflinePlayer, String)} instead. - * Adds a world specific transient permission to the player - ONLY WORKS IN PEX/P3 - otherwise it defaults to GLOBAL! - * @param worldName to check on - * @param player to check - * @param permission to check - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerAddTransient(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerAddTransient(String worldName, String player, String permission) { @@ -333,12 +289,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerRemoveTransient(String, OfflinePlayer, String)} instead. - * Removes a world specific transient permission from the player - Only works in PEX/P3 - otherwise it defaults to Global! - * @param worldName to check on - * @param player to check - * @param permission to check for - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerRemoveTransient(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerRemoveTransient(String worldName, String player, String permission) { @@ -350,7 +301,9 @@ public abstract class Permission { } /** - * Removes a world specific transient permission from the player - Only works in PEX/P3 - otherwise it defaults to Global! + * Removes a world specific transient permission from the player, may only work with some permission managers. + * Defaults to GLOBAL permissions for any permission system that does not support world-specific transient permissions! + * * @param worldName to remove for * @param player to remove for * @param permission to remove @@ -361,7 +314,9 @@ public abstract class Permission { } /** - * Removes a world specific transient permission from the player - Only works in PEX/P3 - otherwise it defaults to Global! + * Removes a world specific transient permission from the player, may only work with some permission managers. + * Defaults to GLOBAL permissions for any permission system that does not support world-specific transient permissions! + * * @param worldName to check on * @param player to check * @param permission to check for @@ -372,12 +327,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerRemove(String, OfflinePlayer, String)} instead. - * Remove permission from a player. - * @param world World name - * @param player Name of Player - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerRemove(String, OfflinePlayer, String)} instead. */ @Deprecated abstract public boolean playerRemove(String world, String player, String permission); @@ -430,15 +380,7 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerRemoveTransient(OfflinePlayer, String)} instead. - * Remove transient permission from a player. - * This implementation can be used by any subclass which implements a "pure" superperms plugin, i.e. - * one that only needs the built-in Bukkit API to remove transient permissions from a player. Any subclass - * implementing a plugin which provides its own API for this needs to override this method. - * - * @param player Player name - * @param permission Permission node - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerRemoveTransient(OfflinePlayer, String)} instead. */ @Deprecated public boolean playerRemoveTransient(String player, String permission) { @@ -572,32 +514,13 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerInGroup(String, OfflinePlayer, String)} instead. - * Check if player is member of a group. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * This method is known to return unexpected results depending on what permission system is being used. Different permission systems - * will store the player groups differently, It is HIGHLY suggested you test your code out first. - * - * @param world World name - * @param player Player name - * @param group Group name - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerInGroup(String, OfflinePlayer, String)} instead. */ @Deprecated abstract public boolean playerInGroup(String world, String player, String group); /** - * @deprecated As of Vault 1.3.01 use {@link #playerInGroup(String, OfflinePlayer, String)} instead. - * Check if player is member of a group. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @param group Group name - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerInGroup(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerInGroup(World world, String player, String group) { @@ -638,29 +561,13 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerAddGroup(String, OfflinePlayer, String)} instead. - * Add player to a group. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World name - * @param player Player name - * @param group Group name - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerAddGroup(String, OfflinePlayer, String)} instead. */ @Deprecated abstract public boolean playerAddGroup(String world, String player, String group); /** - * @deprecated As of Vault 1.3.01 use {@link #playerAddGroup(String, OfflinePlayer, String)} instead. - * Add player to a group. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @param group Group name - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerAddGroup(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerAddGroup(World world, String player, String group) { @@ -701,29 +608,13 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #playerRemoveGroup(String, OfflinePlayer, String)} instead. - * Remove player from a group. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World name - * @param player Player name - * @param group Group name - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerRemoveGroup(String, OfflinePlayer, String)} instead. */ @Deprecated abstract public boolean playerRemoveGroup(String world, String player, String group); /** - * @deprecated As of Vault 1.3.01 use {@link #playerRemoveGroup(String, OfflinePlayer, String)} instead. - * Remove player from a group. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @param group Group name - * @return Success or Failure + * @deprecated As of VaultAPI 1.4 use {@link #playerRemoveGroup(String, OfflinePlayer, String)} instead. */ @Deprecated public boolean playerRemoveGroup(World world, String player, String group) { @@ -764,27 +655,13 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #getPlayerGroups(String, OfflinePlayer)} instead. - * Gets the list of groups that this player has. - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World name - * @param player Player name - * @return Array of groups + * @deprecated As of VaultAPI 1.4 use {@link #getPlayerGroups(String, OfflinePlayer)} instead. */ @Deprecated abstract public String[] getPlayerGroups(String world, String player); /** - * @deprecated As of Vault 1.3.01 use {@link #getPlayerGroups(String, OfflinePlayer)} instead. - * Gets the list of groups that this player has - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @return Array of groups + * @deprecated As of VaultAPI 1.4 use {@link #getPlayerGroups(String, OfflinePlayer)} instead. */ @Deprecated public String[] getPlayerGroups(World world, String player) { @@ -810,6 +687,7 @@ public abstract class Permission { /** * Returns a list of world-specific groups that this player is currently in. May return unexpected results if * you are looking for global groups, or if the registered permission system does not support world-specific groups. + * See {@link #getPlayerGroups(String, OfflinePlayer)} for better control of World-specific or global groups. * * @param player Player Object * @return Array of groups @@ -819,27 +697,13 @@ public abstract class Permission { } /** - * @deprecated As of Vault 1.3.01 use {@link #getPrimaryGroup(String, OfflinePlayer)} instead. - * Gets players primary group - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World name - * @param player Player name - * @return Players primary group + * @deprecated As of VaultAPI 1.4 use {@link #getPrimaryGroup(String, OfflinePlayer)} instead. */ @Deprecated abstract public String getPrimaryGroup(String world, String player); /** - * @deprecated As of Vault 1.3.01 use {@link #getPrimaryGroup(String, OfflinePlayer)} instead. - * Gets players primary group - * Supports NULL value for World if the permission system registered supports global permissions. - * But May return odd values if the servers registered permission system does not have a global permission store. - * - * @param world World Object - * @param player Player name - * @return Players primary group + * @deprecated As of VaultAPI 1.4 use {@link #getPrimaryGroup(String, OfflinePlayer)} instead. */ @Deprecated public String getPrimaryGroup(World world, String player) { @@ -863,7 +727,10 @@ public abstract class Permission { } /** - * Get players primary group + * Get players primary group. + * Defaults to the players current world, so may return only world-specific groups. + * In most cases {@link #getPrimaryGroup(String, OfflinePlayer)} is preferable. + * * @param player Player Object * @return Players primary group */