io.github.ageofwar.telejam.text

Class TextBuilder

java.lang.Object

io.github.ageofwar.telejam.text.TextBuilder

public class TextBuilder
extends java.lang.Object

Factory class for Text.

See Also:

Text

Constructor Summary

Constructors

Constructor and Description
TextBuilder() Constructs a TextBuilder.

Method Summary

Modifier and Type	Method and Description
TextBuilder	append(java.lang.String text) Appends a text to this TextBuilder.
TextBuilder	append(Text text) Appends a text to this TextBuilder.
TextBuilder	append(TextBuilder builder) Appends a text builder to this TextBuilder.
TextBuilder	appendBold(java.lang.String text) Appends a bold text to this TextBuilder.
TextBuilder	appendBotCommand(java.lang.String botCommand) Appends a bot command to this TextBuilder.
TextBuilder	appendCashtag(java.lang.String cashtag) Appends a cashtag to this TextBuilder.
TextBuilder	appendCode(java.lang.String text) Appends a code text to this TextBuilder.
TextBuilder	appendCodeBlock(java.lang.String text) Appends a code block text to this TextBuilder.
TextBuilder	appendEmail(java.lang.String email) Appends an email to this TextBuilder.
TextBuilder	appendHashtag(java.lang.String hashtag) Appends an hashtag to this TextBuilder.
TextBuilder	appendItalic(java.lang.String text) Appends a italic text to this TextBuilder.
TextBuilder	appendLink(Link link) Appends a link to this TextBuilder.
TextBuilder	appendLink(java.lang.String text, java.lang.String url) Appends a link to this TextBuilder.
TextBuilder	appendMention(java.lang.String text) Appends a mention to this TextBuilder.
TextBuilder	appendMention(java.lang.String text, long mention) Deprecated. use this method only if you can't obtain the user relative to its id
TextBuilder	appendMention(User mention) Appends a mention to this TextBuilder, or a text mention if the username is not available.
TextBuilder	appendPhoneNumber(java.lang.String phoneNumber) Appends a phone number to this TextBuilder.
TextBuilder	appendTextMention(Mention mention) Appends a text mention to this TextBuilder.
TextBuilder	appendTextMention(java.lang.String text, User mention) Appends a text mention to this TextBuilder.
TextBuilder	appendTextMention(User mention) Appends a text mention to this TextBuilder.
TextBuilder	appendUrl(java.lang.String url) Appends a bot command to this TextBuilder.
Text	build() Builds the Text.
int	length() Returns the length of the text.
void	setLength(int length) Sets the length of the text.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextBuilder

public TextBuilder()

Constructs a TextBuilder.

Method Detail

append

public TextBuilder append(java.lang.String text)

Appends a text to this TextBuilder.

Parameters:

text - the text to append

Returns:

this instance

append

public TextBuilder append(Text text)

Appends a text to this TextBuilder.

Parameters:

text - the text to append

Returns:

this instance

append

public TextBuilder append(TextBuilder builder)

Appends a text builder to this TextBuilder.

Parameters:

builder - the builder to append

Returns:

this instance

appendBold

public TextBuilder appendBold(java.lang.String text)

Appends a bold text to this TextBuilder.

Parameters:

text - the text to append

Returns:

this instance

appendItalic

public TextBuilder appendItalic(java.lang.String text)

Appends a italic text to this TextBuilder.

Parameters:

text - the text to append

Returns:

this instance

appendCode

public TextBuilder appendCode(java.lang.String text)

Appends a code text to this TextBuilder.

Parameters:

text - the text to append

Returns:

this instance

appendCodeBlock

public TextBuilder appendCodeBlock(java.lang.String text)

Appends a code block text to this TextBuilder.

Parameters:

text - the text to append

Returns:

this instance

appendLink

public TextBuilder appendLink(Link link)

Appends a link to this TextBuilder.

Parameters:

link - the link to append

Returns:

this instance

appendLink

public TextBuilder appendLink(java.lang.String text,
                              java.lang.String url)

Appends a link to this TextBuilder.

Parameters:

text - the text of the link

url - the url of the link

Returns:

this instance

appendMention

public TextBuilder appendMention(java.lang.String text)

Appends a mention to this TextBuilder.

Parameters:

text - the username to mention, without @

Returns:

this instance

appendMention

public TextBuilder appendMention(User mention)

Appends a mention to this TextBuilder, or a text mention if the username is not available.

Parameters:

mention - mentioned user

Returns:

this instance

appendTextMention

public TextBuilder appendTextMention(Mention mention)

Appends a text mention to this TextBuilder.

Parameters:

mention - the mentioned to append

Returns:

this instance

appendTextMention

public TextBuilder appendTextMention(java.lang.String text,
                                     User mention)

Appends a text mention to this TextBuilder.

Parameters:

text - the text of the mention

mention - the mention

Returns:

this instance

appendTextMention

public TextBuilder appendTextMention(User mention)

Appends a text mention to this TextBuilder.

Parameters:

mention - the mentioned user

Returns:

this instance

appendHashtag

public TextBuilder appendHashtag(java.lang.String hashtag)

Appends an hashtag to this TextBuilder.

Parameters:

hashtag - the hashtag to append, without #

Returns:

this instance

appendBotCommand

public TextBuilder appendBotCommand(java.lang.String botCommand)

Appends a bot command to this TextBuilder.

Parameters:

botCommand - the bot command to append, without /

Returns:

this instance

appendUrl

public TextBuilder appendUrl(java.lang.String url)

Appends a bot command to this TextBuilder.

Parameters:

url - the url to append

Returns:

this instance

appendEmail

public TextBuilder appendEmail(java.lang.String email)

Appends an email to this TextBuilder.

Parameters:

email - the email to append

Returns:

this instance

appendPhoneNumber

public TextBuilder appendPhoneNumber(java.lang.String phoneNumber)

Appends a phone number to this TextBuilder.

Parameters:

phoneNumber - the phone number to append

Returns:

this instance

appendCashtag

public TextBuilder appendCashtag(java.lang.String cashtag)

Appends a cashtag to this TextBuilder.

Parameters:

cashtag - the cashtag to append

Returns:

this instance

appendMention

@Deprecated
public TextBuilder appendMention(java.lang.String text,
                                             long mention)

Deprecated. use this method only if you can't obtain the user relative to its id

Appends a mention to this TextBuilder.

Parameters:

text - the text of the mention

mention - the id of the mentioned user

Returns:

this instance

length

public int length()

Returns the length of the text.

Returns:

the length of the text

setLength

public void setLength(int length)

Sets the length of the text.

Parameters:

length - the new length

Throws:

java.lang.StringIndexOutOfBoundsException - if the newLength argument is negative.

build

public Text build()

Builds the Text.

Returns:

the created text