org.anvilpowered.anvil.api.util

Interface TextService<TString,TCommandSource>

All Superinterfaces:

Result<TString,java.lang.String>

public interface TextService<TString,TCommandSource>
extends Result<TString,java.lang.String>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TextService.Builder<TString,TCommandSource>
static interface	TextService.Pagination<TString,TCommandSource>
static interface	TextService.PaginationBuilder<TString,TCommandSource>

Method Summary

Modifier and Type	Method and Description
TextService.Builder<TString,TCommandSource>	builder()
TString	deserialize(java.lang.String text) Deserializes the provided String using the character '&' to determine styles.
TCommandSource	getConsole()
default int	length(TString text) Counts the number of characters in the provided TString excluding color codes.
int	lineCount(TString text) Counts the number of lines in the provided TString
default TString	of(java.lang.CharSequence... contents) Create a TString with the provided contents
default TString	of(java.lang.Object... contents) Create a TString with the provided contents
TextService.PaginationBuilder<TString,TCommandSource>	paginationBuilder()
void	send(TString text, TCommandSource commandSource) Send the provided TString to the provided TCommandSource
default void	sendToConsole(TString text) Send the provided text to the console
java.lang.String	serialize(TString text) Serializes the provided String using the character '&' to serialize styles.
java.lang.String	serializePlain(TString text) Serializes the provided String and ignores all styles.
java.lang.String	toPlain(java.lang.String text) Removes all styles codes from the provided String using the character '&' to determine styles

Methods inherited from interface org.anvilpowered.anvil.api.util.Result

fail, success

Method Detail

builder

TextService.Builder<TString,TCommandSource> builder()

Returns:

A new TextService.Builder instance

paginationBuilder

TextService.PaginationBuilder<TString,TCommandSource> paginationBuilder()

Returns:

A new TextService.PaginationBuilder instance

of

default TString of(java.lang.Object... contents)

Create a TString with the provided contents

Parameters:

contents - The contents to add to the result

Returns:

A built TString

of

default TString of(java.lang.CharSequence... contents)

Create a TString with the provided contents

Parameters:

contents - The contents to add to the result

Returns:

A built TString

send

void send(TString text,
          TCommandSource commandSource)

Send the provided TString to the provided TCommandSource

Parameters:

text - TString text to send

commandSource - TCommandSource source to send text to

sendToConsole

default void sendToConsole(TString text)

Send the provided text to the console

Parameters:

text - TString text to send

getConsole

TCommandSource getConsole()

Returns:

The server console

deserialize

TString deserialize(java.lang.String text)

Deserializes the provided String using the character '&' to determine styles.

Parameters:

text - String text to deserialize

Returns:

The TString result of the deserialization

serialize

java.lang.String serialize(TString text)

Serializes the provided String using the character '&' to serialize styles.

Parameters:

text - TString text to serialize

Returns:

The String result of the serialization

serializePlain

java.lang.String serializePlain(TString text)

Serializes the provided String and ignores all styles.

Parameters:

text - TString text to serialize

Returns:

The String result of the serialization

toPlain

java.lang.String toPlain(java.lang.String text)

Removes all styles codes from the provided String using the character '&' to determine styles

For example, "&l&bhello &aworld" becomes "hello world"

Parameters:

text - String text to remove color from

Returns:

The provided String without any color codes

lineCount

int lineCount(@Nullable
              TString text)

Counts the number of lines in the provided TString

Parameters:

text - TString text to count lines

Returns:

The number of lines in the provided TString. -1 if null. 0 if empty.

length

default int length(@Nullable
                   TString text)

Counts the number of characters in the provided TString excluding color codes.

Parameters:

text - TString text to count characters

Returns:

The number of characters in the provided TString. -1 if null. 0 if empty.