0

Added getName method, made documentation more clear

This commit is contained in:
Pepich 2017-03-10 20:49:23 +01:00
parent 4df0754970
commit 81c10e62c2

View File

@ -16,7 +16,7 @@ import net.md_5.bungee.api.ChatColor;
/** The utils class containing utility functions. Those include but are not limited to sending formatted messages, broadcasts and more. /** The utils class containing utility functions. Those include but are not limited to sending formatted messages, broadcasts and more.
* *
* @author Pepich */ * @author Pepich */
@Version(major = 1, minor = 2, revision = 11, compatible = 1) @Version(major = 1, minor = 2, revision = 12, compatible = 1)
public final class Utils public final class Utils
{ {
/** The SimpleDateFormat used for getting the current date. */ /** The SimpleDateFormat used for getting the current date. */
@ -164,7 +164,7 @@ public final class Utils
info(message); info(message);
} }
/** Prints an info message into console. Supports &x color codes. /** Prints an info message into console. Supports "&" color codes.
* *
* @param message The message to be put into console. Prefixes are automatically generated. Color defaults to grey. */ * @param message The message to be put into console. Prefixes are automatically generated. Color defaults to grey. */
@Debugable @Debugable
@ -176,7 +176,7 @@ public final class Utils
Bukkit.getConsoleSender().sendMessage(ChatColor.translateAlternateColorCodes('&', prefix + "§7" + message)); Bukkit.getConsoleSender().sendMessage(ChatColor.translateAlternateColorCodes('&', prefix + "§7" + message));
} }
/** Prints a warning message into console. Supports &x color codes. /** Prints a warning message into console. Supports "&" color codes.
* *
* @param message The message to be put into console. Prefixes are automatically generated. Color defaults to grey. */ * @param message The message to be put into console. Prefixes are automatically generated. Color defaults to grey. */
@Debugable @Debugable
@ -188,7 +188,7 @@ public final class Utils
Bukkit.getConsoleSender().sendMessage(ChatColor.translateAlternateColorCodes('&', prefix + "§7" + message)); Bukkit.getConsoleSender().sendMessage(ChatColor.translateAlternateColorCodes('&', prefix + "§7" + message));
} }
/** Used to make an error output to console. Supports &x color codes. /** Used to make an error output to console. Supports "&" color codes.
* *
* @param message The message to be put into console. Prefixes are automatically generated. Color defaults to red. */ * @param message The message to be put into console. Prefixes are automatically generated. Color defaults to red. */
@Debugable @Debugable
@ -231,4 +231,16 @@ public final class Utils
Date date = new Date(System.currentTimeMillis()); Date date = new Date(System.currentTimeMillis());
return dateFormat.format(date); return dateFormat.format(date);
} }
/** Provides a uniform way of getting the (display)name of a CommandSender.
*
* @param sender The CommandSender to get the name of.
* @return The DisplayName of the CommandSender or if not a player, the name in blue. */
public static String getName(CommandSender sender)
{
if (sender instanceof Player)
return ((Player) sender).getDisplayName();
else
return "&9" + sender.getName();
}
} }