me.croabeast.beanslib.key

Class ValueReplacer

java.lang.Object

me.croabeast.beanslib.key.ValueReplacer

public class ValueReplacer
extends Object

A utility class that provides methods for replacing placeholders with values in a string. The values can be of any type, and some special cases are handled, such as CommandSender.

Constructor Summary

Constructors

Constructor and Description
ValueReplacer()

Method Summary

Modifier and Type	Method and Description
<T> String	forEach(List<String> keys, List<T> values, String string) Replaces multiple placeholders with values in a string, using lists instead of arrays and case-insensitive mode.
<T> String	forEach(List<String> keys, List<T> values, String string, boolean b) Replaces multiple placeholders with values in a string, using lists instead of arrays.
<T,R> String	forEach(Map<String,? extends T> map, java.util.function.Function<T,? extends R> function, String string) Replaces multiple placeholders with values in a string, using a map and an optional function to transform the values and case-insensitive mode.
<T,R> String	forEach(Map<String,? extends T> map, java.util.function.Function<T,? extends R> function, String string, boolean b) Replaces multiple placeholders with values in a string, using a map and an optional function to transform the values.
<T> String	forEach(Map<String,? extends T> map, String string) Replaces multiple placeholders with values in a string, using a map and no function and case-insensitive mode.
<T> String	forEach(Map<String,? extends T> map, String string, boolean b) Replaces multiple placeholders with values in a string, using a map and no function.
<T> String	forEach(String[] keys, T[] values, String string) Replaces multiple placeholders with values in a string, using case-insensitive mode.
<T> String	forEach(String[] keys, T[] values, String string, boolean b) Replaces multiple placeholders with values in a string.
<A,B> boolean	isApplicable(A[] as, B[] bs) Checks if two arrays are applicable for replacement, i.e. they are not empty and have matching lengths.
String	of(String key, String value, String string) Replaces a single placeholder with a value in a string, using case-insensitive mode.
String	of(String key, String value, String string, boolean b) Replaces a single placeholder with a value in a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueReplacer

public ValueReplacer()

Method Detail

of

public String of(String key,
                 String value,
                 String string,
                 boolean b)

Replaces a single placeholder with a value in a string.

Parameters:

key - the placeholder to be replaced, must not be blank

value - the value to replace the placeholder with, can be empty

string - the string to perform the replacement on, can be blank

b - a boolean flag indicating whether the placeholder is case-sensitive or not

Returns:

the modified string, or the original string if no replacement was done

of

public String of(String key,
                 String value,
                 String string)

Replaces a single placeholder with a value in a string, using case-insensitive mode.

Parameters:

key - the placeholder to be replaced, must not be blank

value - the value to replace the placeholder with, can be blank

string - the string to perform the replacement on, can be blank

Returns:

the modified string, or the original string if no replacement was done

isApplicable

public <A,B> boolean isApplicable(A[] as,
                                  B[] bs)

Checks if two arrays are applicable for replacement, i.e. they are not empty and have matching lengths.

Type Parameters:

A - the type of the placeholders

B - the type of the values

Parameters:

as - the array of placeholders

bs - the array of values

Returns:

true if the arrays are applicable, false otherwise

forEach

public <T> String forEach(String[] keys,
                          T[] values,
                          String string,
                          boolean b)

Replaces multiple placeholders with values in a string.

Type Parameters:

T - the type of the values

Parameters:

keys - the array of placeholders to be replaced, must not be empty

values - the array of values to replace the placeholders with, must not be empty and have at least the same length as keys

string - the string to perform the replacements on, can be blank

b - a boolean flag indicating whether the placeholders are case-sensitive or not

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T> String forEach(String[] keys,
                          T[] values,
                          String string)

Replaces multiple placeholders with values in a string, using case-insensitive mode.

Type Parameters:

T - the type of the values

Parameters:

keys - the array of placeholders to be replaced, must not be empty

values - the array of values to replace the placeholders with, must not be empty and have at least the same length as keys

string - the string to perform the replacements on, can be blank

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T> String forEach(List<String> keys,
                          List<T> values,
                          String string,
                          boolean b)

Replaces multiple placeholders with values in a string, using lists instead of arrays.

Type Parameters:

T - the type of the values

Parameters:

keys - the list of placeholders to be replaced, must not be empty

values - the list of values to replace the placeholders with, must not be empty and have at least the same size as keys

string - the string to perform the replacements on, can be blank

b - a boolean flag indicating whether the placeholders are case-sensitive or not

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T> String forEach(List<String> keys,
                          List<T> values,
                          String string)

Replaces multiple placeholders with values in a string, using lists instead of arrays and case-insensitive mode.

Type Parameters:

T - the type of the values

Parameters:

keys - the list of placeholders to be replaced, must not be empty

values - the list of values to replace the placeholders with, must not be empty and have at least the same size as keys

string - the string to perform the replacements on, can be blank

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T,R> String forEach(Map<String,? extends T> map,
                            java.util.function.Function<T,? extends R> function,
                            String string,
                            boolean b)

Replaces multiple placeholders with values in a string, using a map and an optional function to transform the values.

Type Parameters:

T - the type of the values in the map

R - the type of the transformed values

Parameters:

map - the map of placeholders and values to be replaced, must not be empty

function - an optional function to apply on the values before replacing them, can be null

string - the string to perform the replacements on, can be blank

b - a boolean flag indicating whether the placeholders are case-sensitive or not

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T,R> String forEach(Map<String,? extends T> map,
                            java.util.function.Function<T,? extends R> function,
                            String string)

Replaces multiple placeholders with values in a string, using a map and an optional function to transform the values and case-insensitive mode.

Type Parameters:

T - the type of the values in the map

R - the type of the transformed values

Parameters:

map - the map of placeholders and values to be replaced, must not be empty

function - an optional function to apply on the values before replacing them, can be null

string - the string to perform the replacements on, can be blank

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T> String forEach(Map<String,? extends T> map,
                          String string,
                          boolean b)

Replaces multiple placeholders with values in a string, using a map and no function.

Type Parameters:

T - the type of the values in the map

Parameters:

map - the map of placeholders and values to be replaced, must not be empty

string - the string to perform the replacements on, can be blank

b - a boolean flag indicating whether the placeholders are case-sensitive or not

Returns:

the modified string, or the original string if no replacements were done

forEach

public <T> String forEach(Map<String,? extends T> map,
                          String string)

Replaces multiple placeholders with values in a string, using a map and no function and case-insensitive mode.

Type Parameters:

T - the type of the values in the map

Parameters:

map - the map of placeholders and values to be replaced, must not be empty

string - the string to perform the replacements on, can be blank

Returns:

the modified string, or the original string if no replacements were done