org.anvilpowered.anvil.api.util

Interface TextService.Builder<TString,TCommandSource>

Enclosing interface:

TextService<TString,TCommandSource>

public static interface TextService.Builder<TString,TCommandSource>

Method Summary

Modifier and Type	Method and Description
TextService.Builder<TString,TCommandSource>	append(java.lang.CharSequence... contents) Append the provided contents to this builder
TextService.Builder<TString,TCommandSource>	append(java.lang.Object... contents) Append the provided contents to this builder
TextService.Builder<TString,TCommandSource>	appendCount(int count, java.lang.CharSequence... contents) Append the provided contents to this builder count times.
TextService.Builder<TString,TCommandSource>	appendCount(int count, java.lang.Object... contents) Append the provided contents to this builder count times.
TextService.Builder<TString,TCommandSource>	appendIf(boolean condition, java.lang.CharSequence... contents) Append the provided contents if condition is true.
TextService.Builder<TString,TCommandSource>	appendIf(boolean condition, java.lang.Object... contents) Append the provided contents if condition is true.
TextService.Builder<TString,TCommandSource>	appendJoining(java.lang.Object delimiter, java.lang.CharSequence... contents) Append the provided contents, putting the provided delimiter between each element
TextService.Builder<TString,TCommandSource>	appendJoining(java.lang.Object delimiter, java.lang.Object... contents) Append the provided contents, putting the provided delimiter between each element
TextService.Builder<TString,TCommandSource>	appendJoiningIf(boolean condition, java.lang.Object delimiter, java.lang.CharSequence... contents) Append the provided contents if condition is true, putting the provided delimiter between each element
TextService.Builder<TString,TCommandSource>	appendJoiningIf(boolean condition, java.lang.Object delimiter, java.lang.Object... contents) Append the provided contents if condition is true, putting the provided delimiter between each element
TextService.Builder<TString,TCommandSource>	appendWithPaddingAround(int width, java.lang.Object padding, java.lang.CharSequence... contents) Append the provided contents to this builder and add the provided padding on both the left and right side until the result is at most width wide.
TextService.Builder<TString,TCommandSource>	appendWithPaddingAround(int width, java.lang.Object padding, java.lang.Object... contents) Append the provided contents to this builder and add the provided padding on both the left and right side until the result is at most width wide.
TextService.Builder<TString,TCommandSource>	appendWithPaddingLeft(int width, java.lang.Object padding, java.lang.CharSequence... contents) Append the provided contents to this builder and add the provided padding on the left side until the result is at most width wide.
TextService.Builder<TString,TCommandSource>	appendWithPaddingLeft(int width, java.lang.Object padding, java.lang.Object... contents) Append the provided contents to this builder and add the provided padding on the left side until the result is at most width wide.
TextService.Builder<TString,TCommandSource>	appendWithPaddingRight(int width, java.lang.Object padding, java.lang.CharSequence... contents) Append the provided contents to this builder and add the provided padding on the right side until the result is at most width wide.
TextService.Builder<TString,TCommandSource>	appendWithPaddingRight(int width, java.lang.Object padding, java.lang.Object... contents) Append the provided contents to this builder and add the provided padding on the right side until the result is at most width wide.
TextService.Builder<TString,TCommandSource>	aqua() Sets the current color to aqua.
TextService.Builder<TString,TCommandSource>	black() Sets the current color to black.
TextService.Builder<TString,TCommandSource>	blue() Sets the current color to blue.
TextService.Builder<TString,TCommandSource>	bold() Sets the current style to bold.
TString	build() Creates a TString from this builder.
TextService.Builder<TString,TCommandSource>	dark_aqua() Sets the current color to dark aqua.
TextService.Builder<TString,TCommandSource>	dark_blue() Sets the current color to dark blue.
TextService.Builder<TString,TCommandSource>	dark_gray() Sets the current color to dark gray.
TextService.Builder<TString,TCommandSource>	dark_green() Sets the current color to dark green.
TextService.Builder<TString,TCommandSource>	dark_purple() Sets the current color to dark purple.
TextService.Builder<TString,TCommandSource>	dark_red() Sets the current color to dark red.
TextService.Builder<TString,TCommandSource>	gold() Sets the current color to gold.
TextService.Builder<TString,TCommandSource>	gray() Sets the current color to gray.
TextService.Builder<TString,TCommandSource>	green() Sets the current color to green.
TextService.Builder<TString,TCommandSource>	italic() Sets the current style to italic.
TextService.Builder<TString,TCommandSource>	light_purple() Sets the current color to light purple.
TextService.Builder<TString,TCommandSource>	obfuscated() Sets the current style to obfuscated.
TextService.Builder<TString,TCommandSource>	onClickExecuteCallback(java.util.function.Consumer<TCommandSource> callback) Run the provided callback, passing the provided TCommandSource, when they click.
TextService.Builder<TString,TCommandSource>	onClickOpenUrl(java.lang.String url) Open a url in a browser when this text is clicked.
TextService.Builder<TString,TCommandSource>	onClickOpenUrl(java.net.URL url) Open a url in a browser when this text is clicked.
TextService.Builder<TString,TCommandSource>	onClickRunCommand(java.lang.String command) Run the provided command as the provided TCommandSource when they click.
TextService.Builder<TString,TCommandSource>	onClickSuggestCommand(java.lang.String command) Suggest the provided command to the providedTCommandSource when they click This puts it in their chat bar but does not run the command.
TextService.Builder<TString,TCommandSource>	onHoverShowText(TextService.Builder<TString,TCommandSource> builder) Show the provided text as a tooltip while the mouse is hovering over this text
TextService.Builder<TString,TCommandSource>	onHoverShowText(TString text) Show the provided text as a tooltip while the mouse is hovering over this text
TextService.Builder<TString,TCommandSource>	red() Sets the current color to red.
TextService.Builder<TString,TCommandSource>	reset() Resets the current style to default.
void	sendTo(TCommandSource commandSource) Creates a TString from this builder and sends it to the provided TCommandSource
void	sendToConsole() Creates a TString from this builder and sends it to the console
TextService.Builder<TString,TCommandSource>	strikethrough() Sets the current style to strikethrough.
TextService.Builder<TString,TCommandSource>	underlined() Sets the current style to underlined.
TextService.Builder<TString,TCommandSource>	white() Sets the current color to white.
TextService.Builder<TString,TCommandSource>	yellow() Sets the current color to yellow.

Method Detail

aqua

TextService.Builder<TString,TCommandSource> aqua()

Sets the current color to aqua. Only applies to text appended after this call.

Returns:

this

black

TextService.Builder<TString,TCommandSource> black()

Sets the current color to black. Only applies to text appended after this call.

Returns:

this

blue

TextService.Builder<TString,TCommandSource> blue()

Sets the current color to blue. Only applies to text appended after this call.

Returns:

this

dark_aqua

TextService.Builder<TString,TCommandSource> dark_aqua()

Sets the current color to dark aqua. Only applies to text appended after this call.

Returns:

this

dark_blue

TextService.Builder<TString,TCommandSource> dark_blue()

Sets the current color to dark blue. Only applies to text appended after this call.

Returns:

this

dark_gray

TextService.Builder<TString,TCommandSource> dark_gray()

Sets the current color to dark gray. Only applies to text appended after this call.

Returns:

this

dark_green

TextService.Builder<TString,TCommandSource> dark_green()

Sets the current color to dark green. Only applies to text appended after this call.

Returns:

this

dark_purple

TextService.Builder<TString,TCommandSource> dark_purple()

Sets the current color to dark purple. Only applies to text appended after this call.

Returns:

this

dark_red

TextService.Builder<TString,TCommandSource> dark_red()

Sets the current color to dark red. Only applies to text appended after this call.

Returns:

this

gold

TextService.Builder<TString,TCommandSource> gold()

Sets the current color to gold. Only applies to text appended after this call.

Returns:

this

gray

TextService.Builder<TString,TCommandSource> gray()

Sets the current color to gray. Only applies to text appended after this call.

Returns:

this

green

TextService.Builder<TString,TCommandSource> green()

Sets the current color to green. Only applies to text appended after this call.

Returns:

this

light_purple

TextService.Builder<TString,TCommandSource> light_purple()

Sets the current color to light purple. Only applies to text appended after this call.

Returns:

this

red

TextService.Builder<TString,TCommandSource> red()

Sets the current color to red. Only applies to text appended after this call.

Returns:

this

reset

TextService.Builder<TString,TCommandSource> reset()

Resets the current style to default. Only applies to text appended after this call.

Returns:

this

white

TextService.Builder<TString,TCommandSource> white()

Sets the current color to white. Only applies to text appended after this call.

Returns:

this

yellow

TextService.Builder<TString,TCommandSource> yellow()

Sets the current color to yellow. Only applies to text appended after this call.

Returns:

this

bold

TextService.Builder<TString,TCommandSource> bold()

Sets the current style to bold. Only applies to text appended after this call.

Returns:

this

italic

TextService.Builder<TString,TCommandSource> italic()

Sets the current style to italic. Only applies to text appended after this call.

Returns:

this

obfuscated

TextService.Builder<TString,TCommandSource> obfuscated()

Sets the current style to obfuscated. Only applies to text appended after this call.

Returns:

this

strikethrough

TextService.Builder<TString,TCommandSource> strikethrough()

Sets the current style to strikethrough. Only applies to text appended after this call.

Returns:

this

underlined

TextService.Builder<TString,TCommandSource> underlined()

Sets the current style to underlined. Only applies to text appended after this call.

Returns:

this

append

TextService.Builder<TString,TCommandSource> append(java.lang.Object... contents)

Append the provided contents to this builder

Parameters:

contents - Object contents to append

Returns:

this

append

TextService.Builder<TString,TCommandSource> append(java.lang.CharSequence... contents)

Append the provided contents to this builder

Parameters:

contents - CharSequence contents to append

Returns:

this

appendCount

TextService.Builder<TString,TCommandSource> appendCount(int count,
                                                        java.lang.Object... contents)

Append the provided contents to this builder count times.

This method is the same as:

 for (int i = 0; i < count; i++) {
     builder.append(contents);
 }
 

Parameters:

count - number of times to append the provided contents

contents - Object contents to append

Returns:

this

appendCount

TextService.Builder<TString,TCommandSource> appendCount(int count,
                                                        java.lang.CharSequence... contents)

Append the provided contents to this builder count times.

This method is the same as:

 for (int i = 0; i < count; i++) {
     builder.append(contents);
 }
 

Parameters:

count - number of times to append the provided contents

contents - CharSequence contents to append

Returns:

this

appendWithPaddingLeft

TextService.Builder<TString,TCommandSource> appendWithPaddingLeft(int width,
                                                                  java.lang.Object padding,
                                                                  java.lang.Object... contents)

Append the provided contents to this builder and add the provided padding on the left side until the result is at most width wide.

An example of usage is:

 builder.appendWithPaddingLeft(15, '-', "hello");
 

which appends the result "----------hello"

If the value for padding is longer than one character, the appended result may not reach the full provided width. This can be seen in the following example:

 builder.appendWithPaddingLeft(15, "abc", "hello");
 

which appends the result "abcabcabchello" (14 characters instead of 15)

This happens because the remaining width is not a multiple of the length of the provided padding, which makes it impossible fill the full length of the appended result.

Note: The appended result will be at most width wide, or an exception will be thrown

Parameters:

width - The maximum total width after padding

padding - The padding to fill the left side with

contents - The contents to append

Returns:

this

Throws:

java.lang.IllegalArgumentException - If width < 1

java.lang.IllegalArgumentException - If padding length < 1

java.lang.IllegalArgumentException - If padding length > width

java.lang.IllegalArgumentException - If contents length > width

appendWithPaddingLeft

TextService.Builder<TString,TCommandSource> appendWithPaddingLeft(int width,
                                                                  java.lang.Object padding,
                                                                  java.lang.CharSequence... contents)

Append the provided contents to this builder and add the provided padding on the left side until the result is at most width wide.

An example of usage is:

 builder.appendWithPaddingLeft(15, '-', "hello");
 

which appends the result "----------hello"

If the value for padding is longer than one character, the appended result may not reach the full provided width. This can be seen in the following example:

 builder.appendWithPaddingLeft(15, "abc", "hello");
 

which appends the result "abcabcabchello" (14 characters instead of 15)

This happens because the remaining width is not a multiple of the length of the provided padding, which makes it impossible fill the full length of the appended result.

Note: The appended result will be at most width wide, or an exception will be thrown

Parameters:

width - The maximum total width after padding

padding - The padding to fill the left side with

contents - The contents to append

Returns:

this

Throws:

java.lang.IllegalArgumentException - If width < 1

java.lang.IllegalArgumentException - If padding length < 1

java.lang.IllegalArgumentException - If padding length > width

java.lang.IllegalArgumentException - If contents length > width

appendWithPaddingAround

TextService.Builder<TString,TCommandSource> appendWithPaddingAround(int width,
                                                                    java.lang.Object padding,
                                                                    java.lang.Object... contents)

Append the provided contents to this builder and add the provided padding on both the left and right side until the result is at most width wide.

An example of usage is:

 builder.appendWithPaddingAround(15, '-', "hello");
 

which appends the result "-----hello-----"

If the value for padding is longer than one character, the appended result may not reach the full provided width. This can be seen in the following example:

 builder.appendWithPaddingAround(15, "abc", "hello");
 

which appends the result "abchelloabc" (11 characters instead of 15)

This happens because the remaining width is not a multiple of the length of the provided padding, which makes it impossible fill the full length of the appended result.

Note: The appended result will be at most width wide, or an exception will be thrown Note: The amount of padding on the left and right side will always be the same

Parameters:

width - The maximum total width after padding

padding - The padding to fill the left and right side with

contents - The contents to append

Returns:

this

Throws:

java.lang.IllegalArgumentException - If width < 1

java.lang.IllegalArgumentException - If padding length < 1

java.lang.IllegalArgumentException - If padding length > width

java.lang.IllegalArgumentException - If contents length > width

appendWithPaddingAround

TextService.Builder<TString,TCommandSource> appendWithPaddingAround(int width,
                                                                    java.lang.Object padding,
                                                                    java.lang.CharSequence... contents)

Append the provided contents to this builder and add the provided padding on both the left and right side until the result is at most width wide.

An example of usage is:

 builder.appendWithPaddingAround(15, '-', "hello");
 

which appends the result "-----hello-----"

If the value for padding is longer than one character, the appended result may not reach the full provided width. This can be seen in the following example:

 builder.appendWithPaddingAround(15, "abc", "hello");
 

which appends the result "abchelloabc" (11 characters instead of 15)

This happens because the remaining width is not a multiple of the length of the provided padding, which makes it impossible fill the full length of the appended result.

Note: The appended result will be at most width wide, or an exception will be thrown Note: The amount of padding on the left and right side will always be the same

Parameters:

width - The maximum total width after padding

padding - The padding to fill the left and right side with

contents - The contents to append

Returns:

this

Throws:

java.lang.IllegalArgumentException - If width < 1

java.lang.IllegalArgumentException - If padding length < 1

java.lang.IllegalArgumentException - If padding length > width

java.lang.IllegalArgumentException - If contents length > width

appendWithPaddingRight

TextService.Builder<TString,TCommandSource> appendWithPaddingRight(int width,
                                                                   java.lang.Object padding,
                                                                   java.lang.Object... contents)

Append the provided contents to this builder and add the provided padding on the right side until the result is at most width wide.

An example of usage is:

 builder.appendWithPaddingRight(15, '-', "hello");
 

which appends the result "hello----------"

If the value for padding is longer than one character, the appended result may not reach the full provided width. This can be seen in the following example:

 builder.appendWithPaddingRight(15, "abc", "hello");
 

which appends the result "helloabcabcabc" (14 characters instead of 15)

This happens because the remaining width is not a multiple of the length of the provided padding, which makes it impossible fill the full length of the appended result.

Note: The appended result will be at most width wide, or an exception will be thrown

Parameters:

width - The maximum total width after padding

padding - The padding to fill the right side with

contents - The contents to append

Returns:

this

Throws:

java.lang.IllegalArgumentException - If width < 1

java.lang.IllegalArgumentException - If padding length < 1

java.lang.IllegalArgumentException - If padding length > width

java.lang.IllegalArgumentException - If contents length > width

appendWithPaddingRight

TextService.Builder<TString,TCommandSource> appendWithPaddingRight(int width,
                                                                   java.lang.Object padding,
                                                                   java.lang.CharSequence... contents)

Append the provided contents to this builder and add the provided padding on the right side until the result is at most width wide.

An example of usage is:

 builder.appendWithPaddingRight(15, '-', "hello");
 

which appends the result "hello----------"

If the value for padding is longer than one character, the appended result may not reach the full provided width. This can be seen in the following example:

 builder.appendWithPaddingRight(15, "abc", "hello");
 

which appends the result "helloabcabcabc" (14 characters instead of 15)

This happens because the remaining width is not a multiple of the length of the provided padding, which makes it impossible fill the full length of the appended result.

Note: The appended result will be at most width wide, or an exception will be thrown

Parameters:

width - The maximum total width after padding

padding - The padding to fill the right side with

contents - The contents to append

Returns:

this

Throws:

java.lang.IllegalArgumentException - If width < 1

java.lang.IllegalArgumentException - If padding length < 1

java.lang.IllegalArgumentException - If padding length > width

java.lang.IllegalArgumentException - If contents length > width

appendIf

TextService.Builder<TString,TCommandSource> appendIf(boolean condition,
                                                     java.lang.Object... contents)

Append the provided contents if condition is true.

This method is the same as:

 if (condition) {
     builder.append(contents);
 }
 

Parameters:

condition - The condition to check

contents - The contents to append

Returns:

this

appendIf

TextService.Builder<TString,TCommandSource> appendIf(boolean condition,
                                                     java.lang.CharSequence... contents)

Append the provided contents if condition is true.

This method is the same as:

 if (condition) {
     builder.append(contents);
 }
 

Parameters:

condition - The condition to check

contents - The contents to append

Returns:

this

appendJoining

TextService.Builder<TString,TCommandSource> appendJoining(java.lang.Object delimiter,
                                                          java.lang.Object... contents)

Append the provided contents, putting the provided delimiter between each element

 builder.appendJoining(", ", "Bob", "Alice", "Steven");
 

is the same as

 builder.append("Bob", ", ", "Alice", ", ", "Steven");
 

They both append: "Bob, Alice, Steven"

Parameters:

delimiter - The delimiter to put between each element

contents - The contents to append

Returns:

this

appendJoining

TextService.Builder<TString,TCommandSource> appendJoining(java.lang.Object delimiter,
                                                          java.lang.CharSequence... contents)

Append the provided contents, putting the provided delimiter between each element

 builder.appendJoining(", ", "Bob", "Alice", "Steven");
 

is the same as

 builder.append("Bob", ", ", "Alice", ", ", "Steven");
 

They both append: "Bob, Alice, Steven"

Parameters:

delimiter - The delimiter to put between each element

contents - The contents to append

Returns:

this

appendJoiningIf

TextService.Builder<TString,TCommandSource> appendJoiningIf(boolean condition,
                                                            java.lang.Object delimiter,
                                                            java.lang.Object... contents)

Append the provided contents if condition is true, putting the provided delimiter between each element

This is a combination of appendIf(boolean, Object...) and appendJoining(Object, Object...)

 builder.appendJoiningIf(condition, ", ", "Bob", "Alice", "Steven");
 

is the same as

 if (condition) {
     builder.append("Bob", ", ", "Alice", ", ", "Steven");
 }
 

They both append: "Bob, Alice, Steven" if condition is true

Parameters:

condition - The condition to check before appending

delimiter - The delimiter to put between each element

contents - The contents to append

Returns:

this

appendJoiningIf

TextService.Builder<TString,TCommandSource> appendJoiningIf(boolean condition,
                                                            java.lang.Object delimiter,
                                                            java.lang.CharSequence... contents)

Append the provided contents if condition is true, putting the provided delimiter between each element

This is a combination of appendIf(boolean, CharSequence...) and appendJoining(Object, CharSequence...)

 builder.appendJoiningIf(condition, ", ", "Bob", "Alice", "Steven");
 

is the same as

 if (condition) {
     builder.append("Bob", ", ", "Alice", ", ", "Steven");
 }
 

They both append: "Bob, Alice, Steven" if condition is true

Parameters:

condition - The condition to check before appending

delimiter - The delimiter to put between each element

contents - The contents to append

Returns:

this

onHoverShowText

TextService.Builder<TString,TCommandSource> onHoverShowText(TString text)

Show the provided text as a tooltip while the mouse is hovering over this text

Parameters:

text - The text to show on hover

Returns:

this

onHoverShowText

TextService.Builder<TString,TCommandSource> onHoverShowText(TextService.Builder<TString,TCommandSource> builder)

Show the provided text as a tooltip while the mouse is hovering over this text

Parameters:

builder - The text to show on hover

Returns:

this

onClickSuggestCommand

TextService.Builder<TString,TCommandSource> onClickSuggestCommand(java.lang.String command)

Suggest the provided command to the providedTCommandSource when they click This puts it in their chat bar but does not run the command.

Parameters:

command - The command to suggest

Returns:

this

onClickRunCommand

TextService.Builder<TString,TCommandSource> onClickRunCommand(java.lang.String command)

Run the provided command as the provided TCommandSource when they click.

Parameters:

command - The command to run

Returns:

this

onClickExecuteCallback

TextService.Builder<TString,TCommandSource> onClickExecuteCallback(java.util.function.Consumer<TCommandSource> callback)

Run the provided callback, passing the provided TCommandSource, when they click.

Parameters:

callback - The callback to run

Returns:

this

onClickOpenUrl

TextService.Builder<TString,TCommandSource> onClickOpenUrl(java.net.URL url)

Open a url in a browser when this text is clicked.

Parameters:

url - The url to open

Returns:

this

onClickOpenUrl

TextService.Builder<TString,TCommandSource> onClickOpenUrl(java.lang.String url)

Open a url in a browser when this text is clicked.

Parameters:

url - The url to open

Returns:

this

build

TString build()

Creates a TString from this builder.

Returns:

The built TString

sendTo

void sendTo(TCommandSource commandSource)

Creates a TString from this builder and sends it to the provided TCommandSource

Parameters:

commandSource - The TCommandSource to send the TString to

sendToConsole

void sendToConsole()

Creates a TString from this builder and sends it to the console