Package me.hsgamer.hscore.common

Interface StringReplacer

public interface StringReplacer

A simple interface for String replacement

Field Summary

Fields

Modifier and Type	Field	Description
static final StringReplacer	DUMMY	The dummy replacer that does nothing

Method Summary

Modifier and Type	Method	Description
static @NotNull StringReplacer	combine(@NotNull Collection<? extends StringReplacer> stringReplacers)	Combine multiple string replacers
static @NotNull StringReplacer	combine(@NotNull StringReplacer... stringReplacers)	Combine multiple string replacers
static @NotNull StringReplacer	of(@NotNull BiFunction<String,UUID,String> function)	Create a new StringReplacer from a BiFunction as replace(String, UUID)
static @NotNull StringReplacer	of(@NotNull UnaryOperator<String> operator)	Create a new StringReplacer from a UnaryOperator as replace(String)
static @NotNull StringReplacer	of(@NotNull UnaryOperator<String> operator, @NotNull BiFunction<String,UUID,String> function)	Create a new StringReplacer from a UnaryOperator as replace(String) and a BiFunction as replace(String, UUID)
@Nullable String	replace(@NotNull String original)	Replace a string
default @Nullable String	replace(@NotNull String original, @NotNull UUID uuid)	Replace a string based on the unique id
default String	replaceOrDefault(@NotNull String original, @Nullable UUID uuid, @NotNull String def)	Replace a string or return the default value
default String	replaceOrOriginal(@NotNull String original, @Nullable UUID uuid)	Replace a string or return the original value
default @Nullable String	tryReplace(@NotNull String original, @Nullable UUID uuid)	Try to replace a string based on the unique id.

Field Details

DUMMY

static final StringReplacer DUMMY

The dummy replacer that does nothing

Method Details

combine

@NotNull
static @NotNull StringReplacer combine(@NotNull
 @NotNull Collection<? extends StringReplacer> stringReplacers)

Combine multiple string replacers

Parameters:

stringReplacers - the string replacers

Returns:

the combined string replacer

combine

@NotNull
static @NotNull StringReplacer combine(@NotNull
 @NotNull StringReplacer... stringReplacers)

Combine multiple string replacers

Parameters:

stringReplacers - the string replacers

Returns:

the combined string replacer

of

@NotNull
static @NotNull StringReplacer of(@NotNull
 @NotNull UnaryOperator<String> operator,
 @NotNull
 @NotNull BiFunction<String,UUID,String> function)

Create a new StringReplacer from a UnaryOperator as replace(String) and a BiFunction as replace(String, UUID)

Parameters:

operator - the UnaryOperator

function - the BiFunction

Returns:

the StringReplacer

of

@NotNull
static @NotNull StringReplacer of(@NotNull
 @NotNull UnaryOperator<String> operator)

Create a new StringReplacer from a UnaryOperator as replace(String)

Parameters:

operator - the UnaryOperator

Returns:

the StringReplacer

of

@NotNull
static @NotNull StringReplacer of(@NotNull
 @NotNull BiFunction<String,UUID,String> function)

Create a new StringReplacer from a BiFunction as replace(String, UUID)

Parameters:

function - the BiFunction

Returns:

the StringReplacer

replace

@Nullable
@Nullable String replace(@NotNull
 @NotNull String original)

Replace a string

Parameters:

original - the original string

Returns:

the replaced string

replace

@Nullable
default @Nullable String replace(@NotNull
 @NotNull String original,
 @NotNull
 @NotNull UUID uuid)

Replace a string based on the unique id

Parameters:

original - the original string

uuid - the unique id

Returns:

the replaced string

tryReplace

@Nullable
default @Nullable String tryReplace(@NotNull
 @NotNull String original,
 @Nullable
 @Nullable UUID uuid)

Try to replace a string based on the unique id. If the unique id is null, it will use replace(String). Otherwise, it will use replace(String, UUID).

Parameters:

original - the original string

uuid - the unique id

Returns:

the replaced string

replaceOrDefault

default String replaceOrDefault(@NotNull
 @NotNull String original,
 @Nullable
 @Nullable UUID uuid,
 @NotNull
 @NotNull String def)

Replace a string or return the default value

Parameters:

original - the original string

uuid - the unique id

def - the default value

Returns:

the replaced string or the default value

replaceOrOriginal

default String replaceOrOriginal(@NotNull
 @NotNull String original,
 @Nullable
 @Nullable UUID uuid)

Replace a string or return the original value

Parameters:

original - the original string

Returns:

the replaced string or the original value