Package io.manebot.chat

Class DefaultTextBuilder

  • All Implemented Interfaces:
    TextBuilder
    public class DefaultTextBuilder
extends java.lang.Object
implements TextBuilder

    • Method Summary

      Modifier and Type Method Description
      TextBuilder append​(java.lang.String message)
      Appends unformatted, escaped text to the message.
      TextBuilder append​(java.lang.String message, java.util.EnumSet<TextStyle> styles)
      Appends formatted text to the message.
      TextBuilder appendMention​(Chat chat)
      Appends a chat mention to the formatted message.
      TextBuilder appendMention​(PlatformUser user)
      Appends a user mention to the formatted message.
      TextBuilder appendRaw​(java.lang.String message)
      Appends unformatted, unescaped text to the message.
      TextBuilder appendUrl​(java.lang.String message)
      Appends a formatted URL to this message.
      java.lang.String build()
      Builds the formatted message.
      Chat getChat()
      Gets the sender associated with this formatted message.
      TextFormat getFormat()
      Gets the text format instance being used in this message.
      boolean hasContent()
      Finds if the formatted message has content in its buffer.
      TextBuilder newLine()
      Adds a new line to the message output.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DefaultTextBuilder

        public DefaultTextBuilder​(Chat chat,
                          TextFormat format)

    • Method Detail

      • getChat

        public Chat getChat()
        Description copied from interface: TextBuilder
        Gets the sender associated with this formatted message.
        Specified by:
        getChat in interface TextBuilder
        Returns:
        ChatSender instance.

      • getFormat

        public TextFormat getFormat()
        Description copied from interface: TextBuilder
        Gets the text format instance being used in this message.
        Specified by:
        getFormat in interface TextBuilder
        Returns:
        TextFormat instance.

      • hasContent

        public boolean hasContent()
        Description copied from interface: TextBuilder
        Finds if the formatted message has content in its buffer.
        Specified by:
        hasContent in interface TextBuilder
        Returns:
        true if the formatted message has content, false otherwise.

      • newLine

        public TextBuilder newLine()
        Description copied from interface: TextBuilder
        Adds a new line to the message output.
        Specified by:
        newLine in interface TextBuilder
        Returns:
        continued FormattedMessage instance.

      • appendMention

        public TextBuilder appendMention​(PlatformUser user)
        Description copied from interface: TextBuilder
        Appends a user mention to the formatted message.
        Specified by:
        appendMention in interface TextBuilder
        Parameters:
        user - user to mention.
        Returns:
        continued FormattedMessage instance.

      • appendMention

        public TextBuilder appendMention​(Chat chat)
        Description copied from interface: TextBuilder
        Appends a chat mention to the formatted message.
        Specified by:
        appendMention in interface TextBuilder
        Parameters:
        chat - chat to mention.
        Returns:
        continued FormattedMessage instance.

      • appendRaw

        public TextBuilder appendRaw​(java.lang.String message)
        Description copied from interface: TextBuilder
        Appends unformatted, unescaped text to the message.
        Specified by:
        appendRaw in interface TextBuilder
        Parameters:
        message - text to directly append to the message.
        Returns:
        continued FormattedMessage instance.

      • append

        public TextBuilder append​(java.lang.String message)
        Description copied from interface: TextBuilder
        Appends unformatted, escaped text to the message.
        Specified by:
        append in interface TextBuilder
        Parameters:
        message - text to escape and append to the message.
        Returns:
        continued FormattedMessage instance.

      • appendUrl

        public TextBuilder appendUrl​(java.lang.String message)
        Description copied from interface: TextBuilder
        Appends a formatted URL to this message.
        Specified by:
        appendUrl in interface TextBuilder
        Parameters:
        message - URL to append to the message.
        Returns:
        continued FormattedMessage instance.

      • append

        public TextBuilder append​(java.lang.String message,
                          java.util.EnumSet<TextStyle> styles)
        Description copied from interface: TextBuilder
        Appends formatted text to the message.
        Specified by:
        append in interface TextBuilder
        Parameters:
        message - text to escape and append to the message.
        styles - styles to apply to the specified text.
        Returns:
        continued FormattedMessage instance.

      • build

        public java.lang.String build()
        Description copied from interface: TextBuilder
        Builds the formatted message.
        Specified by:
        build in interface TextBuilder
        Returns:
        formatted message.