Package dev.vankka.mcdiscordreserializer.rules

Class DiscordMarkdownRules

  • public final class DiscordMarkdownRules
extends java.lang.Object
    Markdown rules for Discord formatting.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DiscordMarkdownRules.QuoteState
      A state for quotes, used to not recursively parse quotes.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <R> java.util.List<dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object>> createAllRulesForDiscord​(boolean includeText)
      Creates a set of rules for parsing Discord messages.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createChannelMentionRule()
      Creates a Rule for Discord's channel mentions.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createCodeBlockRule()
      Creates a Rule for Discord's code blocks.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createCodeStringRule()
      Creates a Rule for Discord's code strings.
      static <R> java.util.List<dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object>> createDiscordMarkdownRules()
      Creates all rules for Discord mentions and styles.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createEmoteMentionRule()
      Creates a Rule for Discord's emote mentions.
      static <R,​S>
      java.util.List<dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>>      		 createMentionRules()
      Creates all the mention rules.
      static <R> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object> createQuoteRule()
      Creates a Rule for Discord's quotes.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createRoleMentionRule()
      Creates a Rule for Discord's role mentions.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createSpecialTextRule()
      Creates a special text rule for Discord, required only if using quotes.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createSpoilerRule()
      Creates a Rule for Discord's spoilers.
      static <R> java.util.List<dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object>> createStyleRules()
      Creates all the style rules.
      static <R,​S>
      dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S>      		 createUserMentionRule()
      Creates a Rule for Discord's user mentions.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • createEmoteMentionRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createEmoteMentionRule()
        Creates a Rule for Discord's emote mentions. Discord developer docs

      • createChannelMentionRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createChannelMentionRule()
        Creates a Rule for Discord's channel mentions. Discord developer docs

      • createUserMentionRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createUserMentionRule()
        Creates a Rule for Discord's user mentions. Discord developer docs

      • createRoleMentionRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createRoleMentionRule()
        Creates a Rule for Discord's role mentions. Discord developer docs

      • createSpoilerRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createSpoilerRule()
        Creates a Rule for Discord's spoilers. Discord blog

      • createCodeStringRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createCodeStringRule()
        Creates a Rule for Discord's code strings. Discord blog

      • createQuoteRule

        public static <R> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object> createQuoteRule()
        Creates a Rule for Discord's quotes. Discord blog

        You will need to use the specialized text rule from this class

        See Also:
        createSpecialTextRule()

      • createCodeBlockRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createCodeBlockRule()
        Creates a Rule for Discord's code blocks. Discord blog

      • createSpecialTextRule

        public static <R,​S> dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​S> createSpecialTextRule()
        Creates a special text rule for Discord, required only if using quotes.
        See Also:
        createQuoteRule()

      • createDiscordMarkdownRules

        public static <R> java.util.List<dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object>> createDiscordMarkdownRules()
        Creates all rules for Discord mentions and styles.
        See Also:
        createMentionRules(), createStyleRules()

      • createAllRulesForDiscord

        public static <R> java.util.List<dev.vankka.simpleast.core.parser.Rule<R,​dev.vankka.simpleast.core.node.Node<R>,​java.lang.Object>> createAllRulesForDiscord​(boolean includeText)
        Creates a set of rules for parsing Discord messages.
        Parameters:
        includeText - Should the text rule be included?
        Returns:
        The rules for parsing Discord messages