Text (Telejam 7.0 API)

java.lang.Object
- io.github.ageofwar.telejam.text.Text

All Implemented Interfaces:

java.lang.CharSequence
```
public final class Text
extends java.lang.Object
implements java.lang.CharSequence
```
Class representing a text with entities.

See Also:

TextBuilder

Field Summary

Fields
Modifier and Type Field and Description

static Text EMPTY

Fields
Modifier and Type	Field and Description
`static Text`	`EMPTY`

Constructor Summary

Constructors
Constructor and Description

Text(java.lang.String text)
Constructs a text.

Text(java.lang.String text, java.util.List<MessageEntity> entities)
Constructs a text.

Constructors
Constructor and Description
`Text(java.lang.String text)` Constructs a text.
`Text(java.lang.String text, java.util.List<MessageEntity> entities)` Constructs a text.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Text`	`bold(java.lang.String text)` Creates a bold text.
`static Text`	`botCommand(java.lang.String botCommand)` Creates a bot command.
`static Text`	`cashtag(java.lang.String cashtag)` Creates a cashtag.
`char`	`charAt(int index)`
`static Text`	`code(java.lang.String text)` Creates a code.
`static Text`	`codeBlock(java.lang.String text)` Creates a code block.
`Text`	`concat(Text other)` Concatenates the specified text to the end of this text.
`static Text`	`email(java.lang.String email)` Creates an email.
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getBoldText()` Returns a list containing all the bold strings in this text.
`java.util.List<java.lang.String>`	`getBotCommands()` Returns a list containing all the bot commands in this text.
`java.util.List<java.lang.String>`	`getCashtags()` Returns a list containing all the cashtags in this text.
`java.util.List<java.lang.String>`	`getCodeBlocks()` Returns a list containing all the code blocks in this text.
`java.util.List<java.lang.String>`	`getCodeText()` Returns a list containing all the codes in this text.
`java.util.List<java.lang.String>`	`getEmails()` Returns a list containing all the emails in this text.
`java.util.List<MessageEntity>`	`getEntities()` Returns the text entities.
`java.util.List<java.lang.String>`	`getHashtags()` Returns a list containing all the hashtags in this text.
`java.util.List<java.lang.String>`	`getItalicText()` Returns a list containing all the italic strings in this text.
`java.util.List<Link>`	`getLinks()` Returns a list containing all the links in this text with their relative urls.
`java.util.List<java.lang.String>`	`getMentions()` Returns a list containing all the mentions in this text.
`java.util.List<java.lang.String>`	`getPhoneNumbers()` Returns a list containing all the phone numbers in this text.
`java.util.List<Mention>`	`getTextMentions()` Returns a list containing all the text mentions in this text with their relative users.
`java.util.List<java.lang.String>`	`getUrls()` Returns a list containing all the urls in this text.
`int`	`hashCode()`
`static Text`	`hashtag(java.lang.String hashtag)` Creates an hashtag.
`boolean`	`isEmpty()` Returns `true` if, and only if, `text` length is `0`.
`static Text`	`italic(java.lang.String text)` Creates an italic text.
`int`	`length()`
`static Text`	`link(Link link)` Creates a link.
`static Text`	`link(java.lang.String text, java.lang.String url)` Creates a link.
`static Text`	`mention(java.lang.String mention)` Creates a mention.
`static Text`	`mention(User mention)` Creates a mention.
`static Text`	`parseHtml(java.lang.String text)` Converts an HTML String into a Text.
`static Text`	`parseMarkdown(java.lang.String text)` Converts an Markdown String into a Text.
`static Text`	`phoneNumber(java.lang.String phoneNumber)` Creates a phone number.
`Text`	`subSequence(int start)`
`Text`	`subSequence(int start, int end)`
`static Text`	`textMention(Mention mention)` Creates a text mention.
`static Text`	`textMention(java.lang.String text, User mention)` Creates a text mention.
`static Text`	`textMention(User mention)` Creates a text mention.
`java.lang.String`	`toHtmlString()` Return this text in HTML format.
`java.lang.String`	`toMarkdownString()` Return this text in Markdown format.
`java.lang.String`	`toString()`
`Text`	`trim()`
`static Text`	`url(java.lang.String url)` Creates an url.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence
chars, codePoints

- Field Detail
 - EMPTY
```
public static final Text EMPTY
```
- Constructor Detail
 - Text
```
public Text(java.lang.String text,
 java.util.List<MessageEntity> entities)
```
 Constructs a text.
 
 Parameters:
 
 text - the text
 
 entities - text entities
 
 See Also:
 
 TextBuilder
 - Text
```
public Text(java.lang.String text)
```
 Constructs a text.
 
 Parameters:
 
 text - the text
 
 See Also:
 
 TextBuilder
- Method Detail
 - parseHtml
```
public static Text parseHtml(java.lang.String text)
 throws TextParseException
```
 Converts an HTML String into a Text. The following tags are currently supported:
```
 bold, bold
 italic, italic
 <a href="http://www.example.com/">inline URL</a>
 <a href="tg://user?id=123456789">inline mention of a user</a>
 <code>inline fixed-width code</code>
 <pre>pre-formatted fixed-width code block</pre>
 
```
 All <, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with <, > with > and & with &)
 Parameters:
 
 text - the string to convert
 
 Returns:
 
 the parsed text
 
 Throws:
 
 TextParseException - if an error occurs when parsing the string
 - parseMarkdown
```
public static Text parseMarkdown(java.lang.String text)
 throws TextParseException
```
 Converts an Markdown String into a Text. Use the following syntax in your message:
```
 *bold text*
 _italic text_
 [inline URL](http://www.example.com/)
 [inline mention of a user](tg://user?id=123456789)
 `inline fixed-width code`
 `pre-formatted fixed-width
 code block`
 
```
 All Markdown symbols that are not a part of a Markdown entity must be escaped with the \ character.
 Parameters:
 
 text - the string to convert
 
 Returns:
 
 the parsed text
 
 Throws:
 
 TextParseException - if an error occurs when parsing the string
 - bold
```
public static Text bold(java.lang.String text)
```
 Creates a bold text.
 
 Parameters:
 
 text - the bold text
 
 Returns:
 
 the created text
 - italic
```
public static Text italic(java.lang.String text)
```
 Creates an italic text.
 
 Parameters:
 
 text - the italic text
 
 Returns:
 
 the created text
 - code
```
public static Text code(java.lang.String text)
```
 Creates a code.
 
 Parameters:
 
 text - the code
 
 Returns:
 
 the created text
 - codeBlock
```
public static Text codeBlock(java.lang.String text)
```
 Creates a code block.
 
 Parameters:
 
 text - the code block
 
 Returns:
 
 the created text
 - link
```
public static Text link(Link link)
```
 Creates a link.
 
 Parameters:
 
 link - the link
 
 Returns:
 
 the created text
 - link
```
public static Text link(java.lang.String text,
 java.lang.String url)
```
 Creates a link.
 
 Parameters:
 
 text - the text of the link
 
 url - the url of the link
 
 Returns:
 
 the created text
 - url
```
public static Text url(java.lang.String url)
```
 Creates an url.
 
 Parameters:
 
 url - the url
 
 Returns:
 
 the created text
 - email
```
public static Text email(java.lang.String email)
```
 Creates an email.
 
 Parameters:
 
 email - the email
 
 Returns:
 
 the created text
 - hashtag
```
public static Text hashtag(java.lang.String hashtag)
```
 Creates an hashtag.
 
 Parameters:
 
 hashtag - the hashtag
 
 Returns:
 
 the created text
 - mention
```
public static Text mention(User mention)
```
 Creates a mention.
 
 Parameters:
 
 mention - the mentioned user
 
 Returns:
 
 the created text
 - mention
```
public static Text mention(java.lang.String mention)
```
 Creates a mention.
 
 Parameters:
 
 mention - the mentioned username
 
 Returns:
 
 the created text
 - textMention
```
public static Text textMention(Mention mention)
```
 Creates a text mention.
 
 Parameters:
 
 mention - the mention
 
 Returns:
 
 the created text
 - textMention
```
public static Text textMention(java.lang.String text,
 User mention)
```
 Creates a text mention.
 
 Parameters:
 
 text - the text of the mention
 
 mention - the mentioned user
 
 Returns:
 
 the created text
 - textMention
```
public static Text textMention(User mention)
```
 Creates a text mention.
 
 Parameters:
 
 mention - the mentioned user
 
 Returns:
 
 the created text
 - botCommand
```
public static Text botCommand(java.lang.String botCommand)
```
 Creates a bot command.
 
 Parameters:
 
 botCommand - the bot command
 
 Returns:
 
 the created text
 - phoneNumber
```
public static Text phoneNumber(java.lang.String phoneNumber)
```
 Creates a phone number.
 
 Parameters:
 
 phoneNumber - the phone number
 
 Returns:
 
 the created text
 - cashtag
```
public static Text cashtag(java.lang.String cashtag)
```
 Creates a cashtag.
 
 Parameters:
 
 cashtag - the cashtag
 
 Returns:
 
 the created text
 - isEmpty
```
public boolean isEmpty()
```
 Returns true if, and only if, text length is 0.
 
 Returns:
 
 true if text length is 0, otherwise false
 - concat
```
public Text concat(Text other)
```
 Concatenates the specified text to the end of this text.
 
 Parameters:
 
 other - the text that is concatenated to the end of this text.
 
 Returns:
 
 a text that represents the concatenation of this object to the other.
 - getBoldText
```
public java.util.List<java.lang.String> getBoldText()
```
 Returns a list containing all the bold strings in this text.
 
 Returns:
 
 a list containing all the bold strings in this text
 - getItalicText
```
public java.util.List<java.lang.String> getItalicText()
```
 Returns a list containing all the italic strings in this text.
 
 Returns:
 
 a list containing all the italic strings in this text
 - getCodeText
```
public java.util.List<java.lang.String> getCodeText()
```
 Returns a list containing all the codes in this text.
 
 Returns:
 
 a list containing all the codes in this text
 - getCodeBlocks
```
public java.util.List<java.lang.String> getCodeBlocks()
```
 Returns a list containing all the code blocks in this text.
 
 Returns:
 
 a list containing all the code blocks in this text
 - getLinks
```
public java.util.List<Link> getLinks()
```
 Returns a list containing all the links in this text with their relative urls.
 
 Returns:
 
 a list containing all the links in this text with their relative urls
 - getUrls
```
public java.util.List<java.lang.String> getUrls()
```
 Returns a list containing all the urls in this text.
 
 Returns:
 
 a list containing all the urls in this text
 - getEmails
```
public java.util.List<java.lang.String> getEmails()
```
 Returns a list containing all the emails in this text.
 
 Returns:
 
 a list containing all the emails in this text
 - getHashtags
```
public java.util.List<java.lang.String> getHashtags()
```
 Returns a list containing all the hashtags in this text.
 
 Returns:
 
 a list containing all the hashtags in this text
 - getMentions
```
public java.util.List<java.lang.String> getMentions()
```
 Returns a list containing all the mentions in this text.
 
 Returns:
 
 a list containing all the mentions in this text
 - getTextMentions
```
public java.util.List<Mention> getTextMentions()
```
 Returns a list containing all the text mentions in this text with their relative users.
 
 Returns:
 
 a list containing all the text mentions in this text with their relative users
 - getBotCommands
```
public java.util.List<java.lang.String> getBotCommands()
```
 Returns a list containing all the bot commands in this text.
 
 Returns:
 
 a list containing all the bot commands in this text
 - getPhoneNumbers
```
public java.util.List<java.lang.String> getPhoneNumbers()
```
 Returns a list containing all the phone numbers in this text.
 
 Returns:
 
 a list containing all the phone numbers in this text
 - getCashtags
```
public java.util.List<java.lang.String> getCashtags()
```
 Returns a list containing all the cashtags in this text.
 
 Returns:
 
 a list containing all the cashtags in this text
 - toHtmlString
```
public java.lang.String toHtmlString()
```
 Return this text in HTML format.
 
 Returns:
 
 this text in HTML format
 - toMarkdownString
```
public java.lang.String toMarkdownString()
```
 Return this text in Markdown format.
 
 Returns:
 
 this text in Markdown format
 - trim
```
public Text trim()
```
 - length
```
public int length()
```
 Specified by:
 
 length in interface java.lang.CharSequence
 - charAt
```
public char charAt(int index)
```
 Specified by:
 
 charAt in interface java.lang.CharSequence
 - subSequence
```
public Text subSequence(int start,
 int end)
```
 Specified by:
 
 subSequence in interface java.lang.CharSequence
 - subSequence
```
public Text subSequence(int start)
```
 - toString
```
public java.lang.String toString()
```
 Specified by:
 
 toString in interface java.lang.CharSequence
 
 Overrides:
 
 toString in class java.lang.Object
 - getEntities
```
public java.util.List<MessageEntity> getEntities()
```
 Returns the text entities.
 
 Returns:
 
 the text entities
 - equals
```
public boolean equals(java.lang.Object obj)
```
 Overrides:
 
 equals in class java.lang.Object
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class java.lang.Object

Class Text

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Field Detail

EMPTY

Constructor Detail

Text

Text

Method Detail

parseHtml

parseMarkdown

bold

italic

code

codeBlock

link

link

url

email

hashtag

mention

mention

textMention

textMention

textMention

botCommand

phoneNumber

cashtag

isEmpty

concat

getBoldText

getItalicText

getCodeText

getCodeBlocks

getLinks

getUrls

getEmails

getHashtags

getMentions

getTextMentions

getBotCommands

getPhoneNumbers

getCashtags

toHtmlString

toMarkdownString

trim

length

charAt

subSequence

subSequence

toString

getEntities

equals

hashCode