gyurix.spigotlib

Class SU

java.lang.Object

gyurix.spigotlib.SU

public final class SU
extends java.lang.Object

SpigotLib utilities class

Field Summary

Fields

Modifier and Type	Field and Description
static net.milkbowl.vault.chat.Chat	chat The instance of current Chat provider in Vault
static CustomCommandMap	cm Instance of the CustomCommandMap used by SpigotLibs CommandAPI
static org.bukkit.command.ConsoleCommandSender	cs The main instance of the ConsoleCommandSender object.
static net.milkbowl.vault.economy.Economy	econ The instance of current Economy provider in Vault
static javax.script.ScriptEngine	js An instance of the Javascript script engine, used for the eval variable
static java.util.Set<java.util.UUID>	loadedPlayers
static org.bukkit.plugin.messaging.Messenger	msg The main instance of the Messenger object.
static net.milkbowl.vault.permission.Permission	perm The instance of current Permission provider in Vault
static ConfigFile	pf Player configuration file instance (players.yml file in the SpigotLib)
static org.bukkit.plugin.PluginManager	pm The main instance of the PluginManager object.
static java.util.Random	rand An instance of the Random number generator
static org.bukkit.scheduler.BukkitScheduler	sch The main instance of the BukkitScheduler object.
static org.bukkit.plugin.ServicesManager	sm The main instance of the ServicesManager object
static org.bukkit.Server	srv The main instance of the CraftServer object.
static Protocol	tp PacketAPI instance
static java.nio.charset.Charset	utf8
static DualMap<java.lang.String,java.util.UUID>	uuidCache Name - UUID cache
static boolean	vault True if Vault is found on the server

Constructor Summary

Constructors

Constructor and Description
SU()

Method Summary

Modifier and Type	Method and Description
static void	error(org.bukkit.command.CommandSender sender, java.lang.Throwable err, java.lang.String plugin, java.lang.String author) Sends an error report to the given sender and to console.
static java.lang.String	escapeRegex(java.lang.String regex) Escapes the given regex, without quoting it, like Pattern.quote does
static java.lang.String	escapeText(java.lang.String text) Escape multi line text to a single line one
static java.util.ArrayList<java.lang.String>	fillVariables(java.lang.Iterable<java.lang.String> iterable, java.lang.Object... vars) Fills variables in an iterable
static java.lang.String	fillVariables(java.lang.String s, java.util.HashMap<java.lang.String,java.lang.Object> vars) Fills variables in a String
static java.lang.String	fillVariables(java.lang.String s, java.lang.Object... vars) Fills variables in a String
static java.lang.String	fillVariablesHighlighted(java.lang.String prefix, java.lang.String suffix, java.lang.String s, java.lang.Object... vars) Fills variables in a String and highlight them by using the given prefix and suffix
static java.util.ArrayList<java.lang.String>	filterStart(java.lang.Iterable<java.lang.String> data, java.lang.String start) Filters the startings of the given data
static java.util.ArrayList<java.lang.String>	filterStart(java.lang.String[] data, java.lang.String start) Filters the startings of the given data
static java.lang.String	getName(java.util.UUID id) Get the name of an offline player based on it's UUID.
static java.util.UUID	getOfflineUUID(java.lang.String name)
static java.util.UUID	getOnlineUUID(java.lang.String name)
static int	getPing(org.bukkit.entity.Player plr) Get the ping of a player in milliseconds
static java.util.TreeMap<java.lang.String,java.lang.String>	getPlaceholders(java.lang.String format, java.lang.String text) Gets the placeholders with their values from the given text
static org.bukkit.entity.Player	getPlayer(java.lang.String name) Get an online player or optionally load an offline player based on its name
static org.bukkit.entity.Player	getPlayer(java.util.UUID uid)
static ConfigFile	getPlayerConfig(org.bukkit.entity.Player plr) Get the configuration part of a player or the CONSOLE
static ConfigFile	getPlayerConfig(java.util.UUID plr) Get the configuration part of an online/offline player using based on his UUID, or the configuration part of the CONSOLE, if the given UUID is null.
static org.bukkit.plugin.Plugin	getPlugin(java.lang.Class cl) Get the plugin containing the given class
static GameProfile	getProfile(org.bukkit.entity.Player plr) Get GameProfile of the given player.
static java.util.UUID	getUUID(java.lang.String name) Get the UUID of an offline player based on his name.
static java.util.UUID	getUUIDExact(java.lang.String name) Get the UUID of an offline player based on his name.
static org.bukkit.entity.Player	loadPlayer(java.util.UUID uuid) Load an offline player to be handleable like an online one.
static void	loadPlayerConfig(java.util.UUID uid)
static void	log(org.bukkit.plugin.Plugin pl, java.lang.Iterable<java.lang.Object>... msg) Logs messages from the given plugin.
static void	log(org.bukkit.plugin.Plugin pl, java.lang.Object... msg) Logs messages from the given plugin.
static java.util.ArrayList<java.lang.String>	namesFromUUIDs(java.util.Collection<java.util.UUID> uuids) Convertion of a collection of player UUIDs to the Arraylist containing the player names matching with the UUIDs.
static java.util.ArrayList<java.util.UUID>	namesToUUIDs(java.util.Collection<java.lang.String> names) Convertion of a collection of player names to the Arraylist containing the player UUIDs matching with the names.
static java.lang.String	optimizeColorCodes(java.lang.String in) Optimizes color and formatting code usage in a string by removing redundant color/formatting codes
static double	rand(double min, double max) Generates a random number between min (inclusive) and max (exclusive)
static org.bukkit.Color	randColor(double minSaturation, double maxSaturation, double minLuminance, double maxLuminance) Generate a configurable random color
static void	savePlayer(org.bukkit.entity.Player plr) Save a active offline player.
static void	savePlayerConfig(java.util.UUID uid)
static void	savePlayerConfigNoAsync(java.util.UUID uid)
static void	saveResources(org.bukkit.plugin.Plugin pl, java.lang.String... fileNames) Save files from the given plugins jar file to its subfolder in the plugins folder.
static java.lang.String	setLength(java.lang.String in, int len) Set maximum length of a String by cutting the redundant characters off from it
static java.lang.String[]	splitPage(java.lang.String text, int lines)
static java.lang.String	toCamelCase(java.lang.String name)
static void	transloadStream(java.io.InputStream is, java.io.OutputStream os) Transloads an InputStream to an OutputStream, closes the InputStream, when it's done
static java.lang.String	unescapeText(java.lang.String text) Unescape multi line to single line escaped text
static boolean	unloadPlayerConfig(java.util.UUID uid) Unloads the configuration of the given player or of the console if uid = null
static void	unloadPlugin(org.bukkit.plugin.Plugin p) Unloads a plugin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

utf8

public static final java.nio.charset.Charset utf8

chat

public static net.milkbowl.vault.chat.Chat chat

The instance of current Chat provider in Vault

cm

public static CustomCommandMap cm

Instance of the CustomCommandMap used by SpigotLibs CommandAPI

cs

public static org.bukkit.command.ConsoleCommandSender cs

The main instance of the ConsoleCommandSender object.

econ

public static net.milkbowl.vault.economy.Economy econ

The instance of current Economy provider in Vault

js

public static javax.script.ScriptEngine js

An instance of the Javascript script engine, used for the eval variable

loadedPlayers

public static java.util.Set<java.util.UUID> loadedPlayers

msg

public static org.bukkit.plugin.messaging.Messenger msg

The main instance of the Messenger object.

perm

public static net.milkbowl.vault.permission.Permission perm

The instance of current Permission provider in Vault

pf

public static ConfigFile pf

Player configuration file instance (players.yml file in the SpigotLib)

pm

public static org.bukkit.plugin.PluginManager pm

The main instance of the PluginManager object.

rand

public static java.util.Random rand

An instance of the Random number generator

sch

public static org.bukkit.scheduler.BukkitScheduler sch

The main instance of the BukkitScheduler object.

sm

public static org.bukkit.plugin.ServicesManager sm

The main instance of the ServicesManager object

srv

public static org.bukkit.Server srv

The main instance of the CraftServer object.

tp

public static Protocol tp

PacketAPI instance

uuidCache

public static DualMap<java.lang.String,java.util.UUID> uuidCache

Name - UUID cache

vault

public static boolean vault

True if Vault is found on the server

Constructor Detail

SU

public SU()

Method Detail

error

public static void error(org.bukkit.command.CommandSender sender,
                         java.lang.Throwable err,
                         java.lang.String plugin,
                         java.lang.String author)

Sends an error report to the given sender and to console. The report only includes the stack trace parts, which contains the authors name

Parameters:

sender - - The CommandSender who should receive the error report

err - - The error

plugin - - The plugin where the error appeared

author - - The author name, which will be searched in the error report

escapeRegex

public static java.lang.String escapeRegex(java.lang.String regex)

Escapes the given regex, without quoting it, like Pattern.quote does

Parameters:

regex - - The escapable regex

Returns:

The escaped regex

escapeText

public static java.lang.String escapeText(java.lang.String text)

Escape multi line text to a single line one

Parameters:

text - multi line escapeable text input

Returns:

The escaped text

fillVariables

public static java.lang.String fillVariables(java.lang.String s,
                                             java.util.HashMap<java.lang.String,java.lang.Object> vars)

Fills variables in a String

Parameters:

s - - The String

vars - - The variables and their values, which should be filled

Returns:

The variable filled String

fillVariables

public static java.lang.String fillVariables(java.lang.String s,
                                             java.lang.Object... vars)

Fills variables in a String

Parameters:

s - - The String

vars - - The variables and their values, which should be filled

Returns:

The variable filled String

fillVariables

public static java.util.ArrayList<java.lang.String> fillVariables(java.lang.Iterable<java.lang.String> iterable,
                                                                  java.lang.Object... vars)

Fills variables in an iterable

Parameters:

iterable - - The iterable

vars - - The variables and their values, which should be filled

Returns:

The variable filled iterable converted to an ArrayList

fillVariablesHighlighted

public static java.lang.String fillVariablesHighlighted(java.lang.String prefix,
                                                        java.lang.String suffix,
                                                        java.lang.String s,
                                                        java.lang.Object... vars)

Fills variables in a String and highlight them by using the given prefix and suffix

Parameters:

s - - The String

prefix - - The prefix used for highlighting

suffix - - The suffix used for highlighting

vars - - The variables and their values, which should be filled

Returns:

The variable filled String

filterStart

public static java.util.ArrayList<java.lang.String> filterStart(java.lang.String[] data,
                                                                java.lang.String start)

Filters the startings of the given data

Parameters:

data - - The data to be filtered

start - - Filter every string which starts with this one

Returns:

The filtered Strings

filterStart

public static java.util.ArrayList<java.lang.String> filterStart(java.lang.Iterable<java.lang.String> data,
                                                                java.lang.String start)

Filters the startings of the given data

Parameters:

data - - The data to be filtered

start - - Filter every string which starts with this one

Returns:

The filtered Strings

getName

public static java.lang.String getName(java.util.UUID id)

Get the name of an offline player based on it's UUID.

Parameters:

id - UUID of the target player

Returns:

The name of the requested player or null if the name was not found.

getOfflineUUID

public static java.util.UUID getOfflineUUID(java.lang.String name)

getOnlineUUID

public static java.util.UUID getOnlineUUID(java.lang.String name)

getPing

public static int getPing(org.bukkit.entity.Player plr)

Get the ping of a player in milliseconds

Parameters:

plr - target player

Returns:

The ping of the given player in milliseconds.

getPlaceholders

public static java.util.TreeMap<java.lang.String,java.lang.String> getPlaceholders(java.lang.String format,
                                                                                   java.lang.String text)

Gets the placeholders with their values from the given text

Parameters:

format - - The texts placeholder arrangement format

text - - The text

Returns:

TreeMap with the placeholders as keys and placeholder values as values, or null if the text can not be matched with the format

getPlayer

public static org.bukkit.entity.Player getPlayer(java.lang.String name)

Get an online player or optionally load an offline player based on its name

Parameters:

name - name of the player, which should be got / active.

Returns:

The online player / active offline player who has the given name, or null if no such player have found.

getPlayer

public static org.bukkit.entity.Player getPlayer(java.util.UUID uid)

getPlayerConfig

public static ConfigFile getPlayerConfig(org.bukkit.entity.Player plr)

Get the configuration part of a player or the CONSOLE

Parameters:

plr - the player, whos configuration part will be returned

Returns:

the configuration part of the given player, or the configuration part of the CONSOLE, if the given player is null.

getPlayerConfig

public static ConfigFile getPlayerConfig(java.util.UUID plr)

Get the configuration part of an online/offline player using based on his UUID, or the configuration part of the CONSOLE, if the given UUID is null.

Parameters:

plr - the UUID of the online/offline player

Returns:

the configuration part of the given player, or the configuration part of the CONSOLE, if the given player UUID is null.

getPlugin

public static org.bukkit.plugin.Plugin getPlugin(java.lang.Class cl)

Get the plugin containing the given class

Parameters:

cl - - The checkable class

Returns:

The plugin

getProfile

public static GameProfile getProfile(org.bukkit.entity.Player plr)

Get GameProfile of the given player. The GameProfile contains the players name, UUID and skin.

Parameters:

plr - target player

Returns:

the GameProfile of the target player

getUUID

public static java.util.UUID getUUID(java.lang.String name)

Get the UUID of an offline player based on his name.

Parameters:

name - name of the target player

Returns:

The UUID of the requested player, or null if it was not found.

getUUIDExact

public static java.util.UUID getUUIDExact(java.lang.String name)

Get the UUID of an offline player based on his name.

Parameters:

name - name of the target player

Returns:

The UUID of the requested player, or null if it was not found.

loadPlayer

public static org.bukkit.entity.Player loadPlayer(java.util.UUID uuid)

Load an offline player to be handleable like an online one.

Parameters:

uuid - uuid of the loadable offline player

Returns:

the active Player object, or null if the player was not found.

loadPlayerConfig

public static void loadPlayerConfig(java.util.UUID uid)

log

public static void log(org.bukkit.plugin.Plugin pl,
                       java.lang.Object... msg)

Logs messages from the given plugin. You can use color codes in the msg.

Parameters:

pl - - The plugin who wants to log the message

msg - - The message which should be logged

log

public static void log(org.bukkit.plugin.Plugin pl,
                       java.lang.Iterable<java.lang.Object>... msg)

Logs messages from the given plugin. You can use color codes in the msg.

Parameters:

pl - - The plugin who wants to log the message

msg - - The message which should be logged

namesFromUUIDs

public static java.util.ArrayList<java.lang.String> namesFromUUIDs(java.util.Collection<java.util.UUID> uuids)

Convertion of a collection of player UUIDs to the Arraylist containing the player names matching with the UUIDs.

Parameters:

uuids - collection of player uuids which will be converted to names

Returns:

the convertion result, which is an ArrayList of player names

namesToUUIDs

public static java.util.ArrayList<java.util.UUID> namesToUUIDs(java.util.Collection<java.lang.String> names)

Convertion of a collection of player names to the Arraylist containing the player UUIDs matching with the names.

Parameters:

names - collection of player names which will be converted to UUIDs

Returns:

the convertion result, which is an ArrayList of player UUIDs

optimizeColorCodes

public static java.lang.String optimizeColorCodes(java.lang.String in)

Optimizes color and formatting code usage in a string by removing redundant color/formatting codes

Parameters:

in - input message containing color and formatting codes

Returns:

The color and formatting code optimized string

rand

public static double rand(double min,
                          double max)

Generates a random number between min (inclusive) and max (exclusive)

Parameters:

min - - Minimal value of the random number

max - - Maximal value of the random number

Returns:

A random double between min and max

randColor

public static org.bukkit.Color randColor(double minSaturation,
                                         double maxSaturation,
                                         double minLuminance,
                                         double maxLuminance)

Generate a configurable random color

Parameters:

minSaturation - - Minimal saturation (0-1)

maxSaturation - - Maximal saturation (0-1)

minLuminance - - Minimal luminance (0-1)

maxLuminance - - Maximal luminance (0-1)

Returns:

The generated random color

savePlayer

public static void savePlayer(org.bukkit.entity.Player plr)

Save a active offline player. You should use this method when you have active an offline player and you have changed some of it's data

Parameters:

plr - Loaded offline players Player object

savePlayerConfig

public static void savePlayerConfig(java.util.UUID uid)

savePlayerConfigNoAsync

public static void savePlayerConfigNoAsync(java.util.UUID uid)

saveResources

public static void saveResources(org.bukkit.plugin.Plugin pl,
                                 java.lang.String... fileNames)

Save files from the given plugins jar file to its subfolder in the plugins folder. The files will only be saved if they doesn't exists in the plugins subfolder.

Parameters:

pl - instane of the plugin

fileNames - names of the saveable files

setLength

public static java.lang.String setLength(java.lang.String in,
                                         int len)

Set maximum length of a String by cutting the redundant characters off from it

Parameters:

in - input String

len - maximum length

Returns:

The cutted String, which will maximally len characters.

splitPage

public static java.lang.String[] splitPage(java.lang.String text,
                                           int lines)

toCamelCase

public static java.lang.String toCamelCase(java.lang.String name)

transloadStream

public static void transloadStream(java.io.InputStream is,
                                   java.io.OutputStream os)
                            throws java.io.IOException

Transloads an InputStream to an OutputStream, closes the InputStream, when it's done

Parameters:

is - - The InputStream

os - - The OutputStream

Throws:

java.io.IOException

unescapeText

public static java.lang.String unescapeText(java.lang.String text)

Unescape multi line to single line escaped text

Parameters:

text - multi line escaped text input

Returns:

The unescaped text

unloadPlayerConfig

public static boolean unloadPlayerConfig(java.util.UUID uid)

Unloads the configuration of the given player or of the console if uid = null

Parameters:

uid - - The UUID of the player, or null for console

Returns:

True if the unload was successful, false otherwise

unloadPlugin

public static void unloadPlugin(org.bukkit.plugin.Plugin p)

Unloads a plugin

Parameters:

p - - The unloadable plugin