Beans (BeansLib 1.4-SNAPSHOT-108 API)

java.lang.Object
- me.croabeast.beanslib.Beans

```
public class Beans
extends Object
```
Represents the lib core, for the lib singleton handling.

Constructor Summary

Constructors
Constructor and Description

Beans()

Constructors
Constructor and Description
`Beans()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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.
`org.bukkit.configuration.ConfigurationSection`	`getBossbarSection()` The `ConfigurationSection` object to get all the custom bossbars.
`String`	`getCenterPrefix()` The center prefix to define a center chat message.
`Pattern`	`getCharPattern()` Creates a new `Pattern` instance using the defined char regex string.
`int[]`	`getDefaultTitleTicks()` In, stay and out ticks for a title message.
`String[]`	`getKeysDelimiters()` The delimiters of all the messages keys to identify what type of message is a string to be displayed.
`String`	`getLangPrefix()` The plugin's prefix that will replace the prefix key: `getLangPrefixKey()`.
`String`	`getLangPrefixKey()` A key that will be replaced by the main plugin prefix: `getLangPrefix()`.
`String`	`getLineSeparator()` The line splitter or separator to split multiple chat lines or split a title message between title and subtitle.
`@NotNull BeansLib`	`getLoaded()` Returns the static instance of the lib that is loaded by a plugin using this lib.
`@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.
`org.bukkit.configuration.ConfigurationSection`	`getWebhookSection()` The `ConfigurationSection` object to get all the available webhooks.
`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.
`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 `BeansLib.langPrefixKey` with the `BeansLib.langPrefix`.
`void`	`setLib(BeansLib lib)`
`String[]`	`splitLine(String s)` Creates a new string array from an input string using the `getLineSeparator()` as a split for the array.
`String[]`	`splitLine(String s, int limit)` Creates a new string array from an input string using the `getLineSeparator()` as a split for the array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Beans
```
public Beans()
```
- Method Detail
  - setLib
```
public void setLib(BeansLib lib)
```
  - getLangPrefix
```
public String getLangPrefix()
```
    The plugin's prefix that will replace the prefix key: getLangPrefixKey().
    
    Returns:
    
    the lang prefix
  - getLangPrefixKey
```
public String getLangPrefixKey()
```
    A key that will be replaced by the main plugin prefix: getLangPrefix().
    
    Returns:
    
    the lang prefix key
  - getCenterPrefix
```
public String getCenterPrefix()
```
    The center prefix to define a center chat message.
    
    Returns:
    
    the center prefix
  - getLineSeparator
```
public String getLineSeparator()
```
    The line splitter or separator to split multiple chat lines or split a title message between title and subtitle.
    If you want to override this string, the custom separator should be quoted using Pattern.quote(String).
```
 
 // Example of how setting a custom separator
 lib.setLineSeparator(Pattern.quote("{split}"));
  
```
    Returns:
    
    the line separator
  - getWebhookSection
```
public org.bukkit.configuration.ConfigurationSection getWebhookSection()
```
    The ConfigurationSection object to get all the available webhooks.
    
    Returns:
    
    the webhook section
  - getBossbarSection
```
public org.bukkit.configuration.ConfigurationSection getBossbarSection()
```
    The ConfigurationSection object to get all the custom bossbars.
    
    Returns:
    
    the bossbar section
  - getDefaultTitleTicks
```
public int[] getDefaultTitleTicks()
```
    In, stay and out ticks for a title message.
```
 
 int[] ticks = defaultTitleTicks();
 // Respective values
 int fadeIn = ticks[0];
 int stay = ticks[1];
 int fadeout = ticks[2];
  
```
    Returns:
    
    the default title ticks array
  - getKeysDelimiters
```
public String[] getKeysDelimiters()
```
    The delimiters of all the messages keys to identify what type of message is a string to be displayed.
    Example: default: [title] - custom: {{title}}
    
    Returns:
    
    tje keys delimiters 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
  - 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
  - replacePrefixKey
```
public String replacePrefixKey(String string,
                               boolean remove)
```
    Replace the BeansLib.langPrefixKey with the BeansLib.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 getLineSeparator() 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 getLineSeparator() as a split for the array.
    
    Parameters:
    
    s - an input string
    
    Returns:
    
    the requested array
  - 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.
  - playerLog
```
public 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 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 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 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 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
  - mixLog
```
public 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
  - getLoaded
```
@NotNull
public @NotNull BeansLib getLoaded()
```
    Returns the static instance of the lib that is loaded by a plugin using this lib. If there is no loaded instance, will return the NO_PLUGIN_INSTANCE.
    To avoid the no-plugin result, a lib instance should be initialized in the main class of the project, on JavaPlugin.onLoad() or JavaPlugin.onEnable().
```
 
 "Initialization example of the lib in the main plugin class"

 public void onEnable() {
     BeansLib lib = new BeansLib(this);
     // or this
     BeansLib lib = new BeansLib();
 } 
```
    Methods that depends on the plugin's instance, such as doLog(String...), will throw an NullPointerException if the NO_PLUGIN_INSTANCE is returned or if the instance has no plugin implementation.
    Returns:
    
    loaded instance

Class Beans

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Beans

Method Detail

setLib

getLangPrefix

getLangPrefixKey

getCenterPrefix

getLineSeparator

getWebhookSection

getBossbarSection

getDefaultTitleTicks

getKeysDelimiters

getCharPattern

getBossbarPattern

getBlankPattern

getSmallCapsPattern

getPlugin

replacePrefixKey

splitLine

splitLine

parseChars

convertToSmallCaps

formatPlaceholders

colorize

colorize

colorize

createCenteredChatMessage

createCenteredChatMessage

createCenteredChatMessage

playerLog

rawLog

doLog

doLog

mixLog

mixLog

getLoaded