me.croabeast.beanslib

Class BeansLib

java.lang.Object

me.croabeast.beanslib.BeansLib

public class BeansLib
extends Object

The main class of this lib. Most of the variables can be changed using chain setters.

Since:

1.0

Author:

CroaBeast

Constructor Summary

Constructors

Constructor and Description
BeansLib()
BeansLib(@Nullable org.bukkit.plugin.Plugin plugin) Creates a new instance of the lib using a Plugin implementation.

Method Summary

Modifier and Type	Method and Description
String	centerMessage(org.bukkit.entity.Player target, org.bukkit.entity.Player parser, String string) Deprecated.
String	colorize(org.bukkit.entity.Player target, org.bukkit.entity.Player parser, String string) Formats an input string parsing first PlaceholderAPI placeholders, replaced chars and then applying the respective colors.
String	colorize(org.bukkit.entity.Player player, String string) Formats an input string parsing first PlaceholderAPI placeholders, replaced chars and then applying the respective colors.
String	colorize(String string) Formats an input string parsing first PlaceholderAPI placeholders, replaced chars and then applying the respective colors.
String	convertToSmallCaps(String string)
String	createCenteredChatMessage(org.bukkit.entity.Player target, org.bukkit.entity.Player parser, String string) Formats a string to a centered string, that has a perfect amount of spaces before the actual string to be display in the chat as a centered message.
String	createCenteredChatMessage(org.bukkit.entity.Player player, String string) Formats a string to a centered string, that has a perfect amount of spaces before the actual string to be display in the chat as a centered message.
String	createCenteredChatMessage(String string) Formats a string to a centered string, that has a perfect amount of spaces before the actual string to be display in the chat as a centered message.
void	doLog(@Nullable org.bukkit.command.CommandSender sender, String... lines) Sends requested information to a CommandSender using the plugin's logger and its prefix.
void	doLog(String... lines) Sends requested information to a CommandSender using the plugin's logger and its prefix.
boolean	equals(Object o)
boolean	fixColorLogger() Deprecated. check and/or set the "coloredConsole" variable
String	formatPlaceholders(@Nullable org.bukkit.entity.Player parser, String string)
Pattern	getBlankPattern() Creates a new Pattern instance using the defined blank-space internal placeholder.
Pattern	getBossbarPattern() Creates a new Pattern instance using the defined custom bossbar internal placeholder.
Pattern	getCharPattern() Creates a new Pattern instance using the defined char regex string.
@NotNull org.bukkit.plugin.Plugin	getPlugin() The Plugin instance of your project.
Pattern	getSmallCapsPattern() Creates a new Pattern instance using the defined SmallCaps internal placeholder.
void	mixLog(org.bukkit.command.CommandSender sender, String... lines) Sends information choosing which of the two main methods will be used in each line.
void	mixLog(String... lines) Sends information choosing which of the two main methods will be used in each line.
String	parseChars(String string) Use a char pattern to find unicode values and replace them with its respective characters.
String	parsePlayerKeys(org.bukkit.entity.Player parser, String string) Deprecated. See PlayerKey.replaceKeys(Player, String)
String	parsePlayerKeys(org.bukkit.entity.Player parser, String string, boolean c) Deprecated. See PlayerKey.replaceKeys(Player, String, boolean)
void	playerLog(@NotNull org.bukkit.entity.Player player, String... lines) Sends information to a player using the MessageSender object.
void	rawLog(String... lines) Sends requested information using Bukkit.getLogger() to the console, avoiding the plugin prefix.
String	replacePrefixKey(String string, boolean remove) Replace the langPrefixKey with the langPrefix.
void	sendMessageList(org.bukkit.command.CommandSender sender, org.bukkit.configuration.ConfigurationSection section, String path) Deprecated. See MessageSender and its constructor.
void	sendMessageList(org.bukkit.command.CommandSender sender, org.bukkit.configuration.ConfigurationSection section, String path, String[] keys, String[] values) Deprecated. See MessageSender and its constructor.
void	sendMessageList(org.bukkit.command.CommandSender sender, List<String> list) Deprecated. See MessageSender and its constructor.
void	sendMessageList(org.bukkit.command.CommandSender sender, List<String> list, String[] keys, String[] values) Deprecated. See MessageSender and its constructor.
BeansLib	setKeysDelimiters(String start, String end) Sets the delimiters for the messages keys to identify what type of message is a string to be displayed.
BeansLib	setTitleTicks(int in, int stay, int out) Sets the default title ticks values.
String[]	splitLine(String s) Creates a new string array from an input string using the lineSeparator as a split for the array.
String[]	splitLine(String s, int limit) Creates a new string array from an input string using the lineSeparator as a split for the array.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeansLib

public BeansLib(@Nullable
                @Nullable org.bukkit.plugin.Plugin plugin)

Creates a new instance of the lib using a Plugin implementation.

if the plugin instance is null, methods that use a plugin instance like logging with a plugin prefix, sending bossbar messages and others plugin-related will not work.

Parameters:

plugin - plugin's instance

BeansLib

public BeansLib()

Method Detail

getPlugin

@NotNull
public @NotNull org.bukkit.plugin.Plugin getPlugin()
                                                      throws NullPointerException

The Plugin instance of your project.

Returns:

plugin's instance

Throws:

NullPointerException - if the plugin is null

setTitleTicks

public final BeansLib setTitleTicks(int in,
                                    int stay,
                                    int out)

Sets the default title ticks values.

Parameters:

in - in server ticks

stay - stay server ticks

out - out server ticks

Returns:

a reference of this object

setKeysDelimiters

public final BeansLib setKeysDelimiters(String start,
                                        String end)

Sets the delimiters for the messages keys to identify what type of message is a string to be displayed.

Example: default: [title] - custom: {{title}}

Parameters:

start - start delimiter string

end - end delimiter string

Returns:

a reference of this object

fixColorLogger

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public boolean fixColorLogger()

Deprecated. check and/or set the "coloredConsole" variable

Returns if it will fix an RGB issue in some servers that RGB not working correctly.

Returns:

if this fix is enabled

replacePrefixKey

public String replacePrefixKey(String string,
                               boolean remove)

Replace the langPrefixKey with the langPrefix.

Parameters:

string - an input string

remove - if the prefix will be removed

Returns:

the formatted string

splitLine

public String[] splitLine(String s,
                          int limit)

Creates a new string array from an input string using the lineSeparator as a split for the array.

You can define the limit of the array.

Parameters:

s - an input string

limit - a limit

Returns:

the requested array

splitLine

public String[] splitLine(String s)

Creates a new string array from an input string using the lineSeparator as a split for the array.

Parameters:

s - an input string

Returns:

the requested array

getCharPattern

public Pattern getCharPattern()

Creates a new Pattern instance using the defined char regex string.

Returns:

the requested pattern

getBossbarPattern

public Pattern getBossbarPattern()

Creates a new Pattern instance using the defined custom bossbar internal placeholder.

Returns:

the requested pattern

getBlankPattern

public Pattern getBlankPattern()

Creates a new Pattern instance using the defined blank-space internal placeholder.

Returns:

the requested pattern

getSmallCapsPattern

public Pattern getSmallCapsPattern()

Creates a new Pattern instance using the defined SmallCaps internal placeholder.

Returns:

the requested pattern

parseChars

public String parseChars(String string)

Use a char pattern to find unicode values and replace them with its respective characters.

Parameters:

string - the input line

Returns:

the parsed message with the new characters

convertToSmallCaps

public String convertToSmallCaps(String string)

formatPlaceholders

public String formatPlaceholders(@Nullable
                                 @Nullable org.bukkit.entity.Player parser,
                                 String string)

colorize

public String colorize(org.bukkit.entity.Player target,
                       org.bukkit.entity.Player parser,
                       String string)

Formats an input string parsing first PlaceholderAPI placeholders, replaced chars and then applying the respective colors.

Parameters:

target - a target to parse colors depending on its client, can be null

parser - a player, can be null

string - the input message

Returns:

the formatted message

colorize

public String colorize(org.bukkit.entity.Player player,
                       String string)

Formats an input string parsing first PlaceholderAPI placeholders, replaced chars and then applying the respective colors.

Parameters:

player - a player, can be null

string - the input message

Returns:

the formatted message

colorize

public String colorize(String string)

Formats an input string parsing first PlaceholderAPI placeholders, replaced chars and then applying the respective colors.

Parameters:

string - the input message

Returns:

the formatted message

createCenteredChatMessage

public String createCenteredChatMessage(org.bukkit.entity.Player target,
                                        org.bukkit.entity.Player parser,
                                        String string)

Formats a string to a centered string, that has a perfect amount of spaces before the actual string to be display in the chat as a centered message.

Parameters:

target - a target to parse colors depending on its client, can be null

parser - a player to parse placeholders.

string - the input message

Returns:

the centered chat message.

createCenteredChatMessage

public String createCenteredChatMessage(org.bukkit.entity.Player player,
                                        String string)

Formats a string to a centered string, that has a perfect amount of spaces before the actual string to be display in the chat as a centered message.

Parameters:

player - a player to parse placeholders.

string - the input message

Returns:

the centered chat message.

createCenteredChatMessage

public String createCenteredChatMessage(String string)

Formats a string to a centered string, that has a perfect amount of spaces before the actual string to be display in the chat as a centered message.

Parameters:

string - the input message

Returns:

the centered chat message.

centerMessage

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public String centerMessage(org.bukkit.entity.Player target,
                                                                                           org.bukkit.entity.Player parser,
                                                                                           String string)

Deprecated.

parsePlayerKeys

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public final String parsePlayerKeys(org.bukkit.entity.Player parser,
                                                                                                   String string,
                                                                                                   boolean c)

Deprecated. See PlayerKey.replaceKeys(Player, String, boolean)

Parses the players keys defined in your keyManager object to its respective player variables.

Parameters:

parser - a player

string - an input string

c - if keys are case-sensitive

Returns:

the requested string

parsePlayerKeys

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public final String parsePlayerKeys(org.bukkit.entity.Player parser,
                                                                                                   String string)

Deprecated. See PlayerKey.replaceKeys(Player, String)

Parses the players keys defined in your keyManager object to its respective player variables. Keys are case-insensitive.

Parameters:

parser - a player

string - an input string

Returns:

the requested string

playerLog

public final void playerLog(@NotNull
                            @NotNull org.bukkit.entity.Player player,
                            String... lines)

Sends information to a player using the MessageSender object.

Parameters:

player - a valid player

lines - the information to send

rawLog

public final void rawLog(String... lines)

Sends requested information using Bukkit.getLogger() to the console, avoiding the plugin prefix.

Parameters:

lines - the information to send

doLog

public final void doLog(@Nullable
                        @Nullable org.bukkit.command.CommandSender sender,
                        String... lines)

Sends requested information to a CommandSender using the plugin's logger and its prefix.

If the sender is a Player and it's not null, it will log using playerLog(Player, String...).

Parameters:

sender - a valid sender, can be the console, a player or null

lines - the information to send

Throws:

NullPointerException - if the plugin is null

doLog

public final void doLog(String... lines)

Sends requested information to a CommandSender using the plugin's logger and its prefix.

Parameters:

lines - the information to send

Throws:

NullPointerException - if the plugin is null

mixLog

public final void mixLog(org.bukkit.command.CommandSender sender,
                         String... lines)

Sends information choosing which of the two main methods will be used in each line. (rawLog, doLog)

If the line does not start with a boolean value or that value is false, it will use the doLog method, otherwise will use the rawLog method.

 
 "My information for the console" >> // Uses "doLog"
 "true::My basic log information" >> // Uses "rawLog"
 "false::Some plugin's information" >> // Uses "doLog"
 "" or null >> // Uses "doLog", 'cause is empty/null
  

Parameters:

sender - a valid sender, can be the console, a player or null

lines - the information to send

equals

public boolean equals(Object o)

Overrides:

equals in class Object

mixLog

public final void mixLog(String... lines)

Sends information choosing which of the two main methods will be used in each line. (rawLog, doLog)

If the line does not start with a boolean value or that value is false, it will use the doLog method, otherwise will use the rawLog method.

 
 "My information for the console" >> // Uses "doLog"
 "true::My basic log information" >> // Uses "rawLog"
 "false::Some plugin's information" >> // Uses "doLog"
 "" or null >> // Uses "doLog", 'cause is empty/null
  

Parameters:

lines - the information to send

sendMessageList

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public void sendMessageList(org.bukkit.command.CommandSender sender,
                                                                                           List<String> list,
                                                                                           String[] keys,
                                                                                           String[] values)

Deprecated. See MessageSender and its constructor.

Parse keys and values using TextUtils.replaceInsensitiveEach(String[], String[], String)

Parameters:

sender - a sender to format and send the message

list - the message list

keys - a keys array

values - a values array

sendMessageList

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public void sendMessageList(org.bukkit.command.CommandSender sender,
                                                                                           org.bukkit.configuration.ConfigurationSection section,
                                                                                           String path,
                                                                                           String[] keys,
                                                                                           String[] values)

Deprecated. See MessageSender and its constructor.

Parse keys and values using TextUtils.replaceInsensitiveEach(String[], String[], String)

Parameters:

sender - a sender to format and send the message

section - the config file or section

path - the path of the string or string list

keys - a keys array

values - a values array

sendMessageList

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public void sendMessageList(org.bukkit.command.CommandSender sender,
                                                                                           List<String> list)

Deprecated. See MessageSender and its constructor.

Parse keys and values using TextUtils.replaceInsensitiveEach(String[], String[], String)

Parameters:

sender - a sender to format and send the message

list - the message list

sendMessageList

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public void sendMessageList(org.bukkit.command.CommandSender sender,
                                                                                           org.bukkit.configuration.ConfigurationSection section,
                                                                                           String path)

Deprecated. See MessageSender and its constructor.

Parse keys and values using TextUtils.replaceInsensitiveEach(String[], String[], String)

Parameters:

sender - a sender to format and send the message

section - the config file or section

path - the path of the string or string list