me.croabeast.beanslib.utility

Class TextUtils

java.lang.Object

me.croabeast.beanslib.utility.TextUtils

public class TextUtils
extends Object

A class that stores static methods for text, string, configurations, and more.

Since:

1.0

Author:

CroaBeast

Field Summary

Fields

Modifier and Type	Field and Description
java.util.function.UnaryOperator<String>	CONVERT_OLD_JSON Coverts the old Json format to the new in-built one.
Pattern	FORMAT_CHAT_PATTERN The main pattern to identify the custom chat message format in a string.
java.util.function.Predicate<String>	IS_JSON Check if the line uses a valid json format on any part of the string.
java.util.function.BiFunction<org.bukkit.entity.Player,String,String>	PARSE_INTERACTIVE_CHAT Parse all the InteractiveChat values of an input string if InteractiveChat is enabled.
java.util.function.BiFunction<org.bukkit.entity.Player,String,String>	PARSE_PLACEHOLDERAPI Parse all the PlaceholderAPI placeholders of an input string if PlaceholderAPI is enabled.
java.util.function.UnaryOperator<String>	STRIP_FIRST_SPACES Strips the first spaces of an input string.
java.util.function.UnaryOperator<String>	STRIP_JSON Removes the in-built JSON pattern of a string, if there is any format.
Pattern	URL_PATTERN A regular expression pattern for matching URLs in a case-insensitive manner.

Constructor Summary

Constructors

Constructor and Description
TextUtils()

Method Summary

Modifier and Type	Method and Description
String	convertOldJson(String string) Deprecated.
String	parseInteractiveChat(org.bukkit.entity.Player player, String string) Deprecated.
String	parsePAPI(org.bukkit.entity.Player player, String string) Deprecated.
String	removeSpace(String string) Deprecated.
String	replaceEach(String[] keys, String[] values, String string, boolean b) Deprecated. See ValueReplacer.
String	replaceEach(String key, String value, String string, boolean b) Deprecated. See ValueReplacer.
String	replaceInsensitiveEach(String[] keys, String[] values, String string) Deprecated. See ValueReplacer.
String	replaceInsensitiveEach(String key, String value, String string) Deprecated. See ValueReplacer.
boolean	sendActionBar(org.bukkit.entity.Player player, String message) Sends an action bar message to a player.
boolean	sendTitle(org.bukkit.entity.Player player, @NotNull String[] message, int in, int stay, int out) Sends a title message to a player.
boolean	sendTitle(org.bukkit.entity.Player player, String title, int in, int stay, int out) Sends a title message to a player.
boolean	sendTitle(org.bukkit.entity.Player player, String title, String subtitle, int in, int stay, int out) Sends a title message to a player.
String	stripJson(String string) Deprecated.
@NotNull List<String>	toList(org.bukkit.configuration.ConfigurationSection section, String path) Converts a String to a List from a configuration section if it's not a list.
List<String>	toList(org.bukkit.configuration.ConfigurationSection section, String path, List<String> def) Converts a String to a List from a configuration section if it's not a list.

Methods inherited from class java.lang.Object

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

Field Detail

PARSE_PLACEHOLDERAPI

public final java.util.function.BiFunction<org.bukkit.entity.Player,String,String> PARSE_PLACEHOLDERAPI

Parse all the PlaceholderAPI placeholders of an input string if PlaceholderAPI is enabled.

Use the apply(Player, String) method to apply it on a string.

PARSE_INTERACTIVE_CHAT

public final java.util.function.BiFunction<org.bukkit.entity.Player,String,String> PARSE_INTERACTIVE_CHAT

Parse all the InteractiveChat values of an input string if InteractiveChat is enabled.

Use the apply(Player, String) method to apply it on a string.

STRIP_FIRST_SPACES

public final java.util.function.UnaryOperator<String> STRIP_FIRST_SPACES

Strips the first spaces of an input string.

Use the apply(String) method to apply it on a string.

CONVERT_OLD_JSON

public final java.util.function.UnaryOperator<String> CONVERT_OLD_JSON

Coverts the old Json format to the new in-built one.

Use the apply(String) method to apply it on a string.

IS_JSON

public final java.util.function.Predicate<String> IS_JSON

Check if the line uses a valid json format on any part of the string.

Use the apply(String) method to check a string.

STRIP_JSON

public final java.util.function.UnaryOperator<String> STRIP_JSON

Removes the in-built JSON pattern of a string, if there is any format.

Use the apply(String) method to apply it on a string.

URL_PATTERN

public final Pattern URL_PATTERN

A regular expression pattern for matching URLs in a case-insensitive manner.

The pattern matches URLs that start with an optional protocol (http or https), followed by a domain name consisting of at least two alphanumeric characters, and ending with an optional path.

Note: This pattern is a simplified version that matches basic URL formats and does not handle all possible cases. It may not validate all edge cases or specific scenarios. For more comprehensive URL matching, consider using specialized URL parsing libraries or additional validation.

FORMAT_CHAT_PATTERN

public final Pattern FORMAT_CHAT_PATTERN

The main pattern to identify the custom chat message format in a string.

Keep in mind that every string can only have one ClickEvent.Action; a click action has this format:

 
 Available Actions: RUN, SUGGEST, URL and all ClickAction values.
 "<ACTION>:<the click string>" -> "RUN:/me click to run"
  

 
 // • Examples:
 String hover = "<hover:\"a hover line\">text to apply</text>";
 String click = "<run:\"/click me\">text to apply</text>";
 String mixed = "<hover:\"a hover line<n>another line\"|run:\"/command\">text to apply</text>";
  

Constructor Detail

TextUtils

public TextUtils()

Method Detail

parsePAPI

@Deprecated
public String parsePAPI(org.bukkit.entity.Player player,
                                     String string)

Deprecated.

Parses the placeholders from PlaceholderAPI if is enabled.

Parameters:

player - a player, can be null

string - the input line

Returns:

the parsed message

parseInteractiveChat

@Deprecated
public String parseInteractiveChat(org.bukkit.entity.Player player,
                                                String string)

Deprecated.

Parse InteractiveChat placeholders for using it a JSON message.

Parameters:

player - the requested player

string - the line to parse

Returns:

the line with the parsed placeholders.

removeSpace

@Deprecated
public String removeSpace(String string)

Deprecated.

Removes the first spaces of a line.

Parameters:

string - the input line

Returns:

the line without the first spaces

convertOldJson

@Deprecated
public String convertOldJson(String string)

Deprecated.

Converts the old JSON format to the new one.

Parameters:

string - an input string

Returns:

the converted string

stripJson

@Deprecated
public String stripJson(String string)

Deprecated.

Strips the JSON format from an input string.

Parameters:

string - an input string.

Returns:

the stripped line.

toList

public List<String> toList(org.bukkit.configuration.ConfigurationSection section,
                           String path,
                           List<String> def)

Converts a String to a List from a configuration section if it's not a list.

Parameters:

section - a config file or section, can be null

path - the path to locate the string or list

def - a default string list if value is not found

Returns:

the converted string list or default value if section is null

toList

@NotNull
public @NotNull List<String> toList(org.bukkit.configuration.ConfigurationSection section,
                                              String path)

Converts a String to a List from a configuration section if it's not a list.

Parameters:

section - a config file or section, can be null

path - the path to locate the string or list

Returns:

the converted string list or an empty list if section is null

sendActionBar

public boolean sendActionBar(org.bukkit.entity.Player player,
                             String message)

Sends an action bar message to a player.

Doesn't format the message. Use BeansLib.colorize(Player, Player, String).

Parameters:

player - a player

message - the message

Returns:

true is the message was sent, false otherwise

sendTitle

public boolean sendTitle(org.bukkit.entity.Player player,
                         String title,
                         String subtitle,
                         int in,
                         int stay,
                         int out)

Sends a title message to a player.

Doesn't format the message. Use BeansLib.colorize(Player, Player, String).

Parameters:

player - a player

title - a title

subtitle - a subtitle

in - the fadeIn number in ticks

stay - the stay number in ticks

out - the fadeOut number in ticks

Returns:

true is the message was sent, false otherwise

sendTitle

public boolean sendTitle(org.bukkit.entity.Player player,
                         String title,
                         int in,
                         int stay,
                         int out)

Sends a title message to a player.

Doesn't format the message. Use BeansLib.colorize(Player, Player, String).

Parameters:

player - a player

title - a title

in - the fadeIn number in ticks

stay - the stay number in ticks

out - the fadeOut number in ticks

Returns:

true is the message was sent, false otherwise

sendTitle

public boolean sendTitle(org.bukkit.entity.Player player,
                         @NotNull
                         @NotNull String[] message,
                         int in,
                         int stay,
                         int out)

Sends a title message to a player.

Doesn't format the message. Use BeansLib.colorize(Player, Player, String).

Parameters:

player - a player

message - an array of title and subtitle

in - the fadeIn number in ticks

stay - the stay number in ticks

out - the fadeOut number in ticks

Returns:

true is the message was sent, false otherwise

replaceEach

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public String replaceEach(String[] keys,
                                                                                         String[] values,
                                                                                         String string,
                                                                                         boolean b)

Deprecated. See ValueReplacer.

Replace a String array of keys with another String array of values.

Special characters are quoted to avoid errors.

Parameters:

string - an input string

keys - the array of keys

values - the array of values

b - if keys are case-sensitive

Returns:

the parsed string with the respective values

replaceEach

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public String replaceEach(String key,
                                                                                         String value,
                                                                                         String string,
                                                                                         boolean b)

Deprecated. See ValueReplacer.

Replace a String key with a String value.

Special characters are quoted to avoid errors.

Parameters:

string - an input string

key - a key

value - a value

b - if key is case-sensitive

Returns:

the parsed string with the respective value

replaceInsensitiveEach

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public String replaceInsensitiveEach(String[] keys,
                                                                                                    String[] values,
                                                                                                    String string)

Deprecated. See ValueReplacer.

Replace a String array of keys with another String array of values.

It's case-insensitive and special characters are quoted to avoid errors.

Parameters:

string - an input string

keys - the array of keys

values - the array of values

Returns:

the parsed string with the respective values

replaceInsensitiveEach

@ApiStatus.ScheduledForRemoval(inVersion="1.4")
 @Deprecated
public String replaceInsensitiveEach(String key,
                                                                                                    String value,
                                                                                                    String string)

Deprecated. See ValueReplacer.

Replace a String key with a String value.

It's case-insensitive and special characters are quoted to avoid errors.

Parameters:

string - an input string

key - a key

value - a value

Returns:

the parsed string with the respective value