Package com.github.rjeschke.txtmark

Class DefaultDecorator

  • All Implemented Interfaces:
    Decorator
    public class DefaultDecorator
extends java.lang.Object
implements Decorator
    Default Decorator implementation.

    Example for a user Decorator having a class attribute on <p> tags. 

     public class MyDecorator extends DefaultDecorator
 {
     @Override
     public void openParagraph(StringBuilder out)
     {
         out.append("<p class=\"myclass\">");
     }
 }

    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultDecorator()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void closeBlockquote​(java.lang.StringBuilder out)
      Called when a blockquote is closed.
      void closeCodeBlock​(java.lang.StringBuilder out)
      Called when a code block is closed.
      void closeCodeSpan​(java.lang.StringBuilder out)
      Called when a code span is closed.
      void closeEmphasis​(java.lang.StringBuilder out)
      Called when an emphasis span is closed.
      void closeHeadline​(java.lang.StringBuilder out, int level)
      Called when a headline is closed.
      void closeImage​(java.lang.StringBuilder out)
      Called when an image is closed.
      void closeLink​(java.lang.StringBuilder out)
      Called when a link is closed
      void closeListItem​(java.lang.StringBuilder out)
      Called when a list item is closed.
      void closeOrderedList​(java.lang.StringBuilder out)
      Called when an ordered list is closed.
      void closeParagraph​(java.lang.StringBuilder out)
      Called when a paragraph is closed.
      void closeStrong​(java.lang.StringBuilder out)
      Called when a strong span is closed.
      void closeSuper​(java.lang.StringBuilder out)
      Called when a superscript span is closed.
      void closeUnorderedList​(java.lang.StringBuilder out)
      Called when an unordered list is closed.
      void horizontalRuler​(java.lang.StringBuilder out)
      Called when a horizontal ruler is encountered.
      void openBlockquote​(java.lang.StringBuilder out)
      Called when a blockquote is opened.
      void openCodeBlock​(java.lang.StringBuilder out)
      Called when a code block is opened.
      void openCodeSpan​(java.lang.StringBuilder out)
      Called when a code span is opened.
      void openEmphasis​(java.lang.StringBuilder out)
      Called when an emphasis span is opened.
      void openHeadline​(java.lang.StringBuilder out, int level)
      Called when a headline is opened.
      void openImage​(java.lang.StringBuilder out)
      Called when an image is opened.
      void openLink​(java.lang.StringBuilder out)
      Called when a link is opened.
      void openListItem​(java.lang.StringBuilder out)
      Called when a list item is opened.
      void openOrderedList​(java.lang.StringBuilder out)
      Called when an ordered list is opened.
      void openParagraph​(java.lang.StringBuilder out)
      Called when a paragraph is opened.
      void openStrong​(java.lang.StringBuilder out)
      Called when a strong span is opened.
      void openSuper​(java.lang.StringBuilder out)
      Called when a superscript span is opened.
      void openUnorderedList​(java.lang.StringBuilder out)
      Called when an unordered list is opened.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DefaultDecorator

        public DefaultDecorator()
        Constructor.

    • Method Detail

      • openParagraph

        public void openParagraph​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a paragraph is opened.

        Default implementation is: 

         out.append("<p>");
        Specified by:
        openParagraph in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openParagraph(StringBuilder)

      • closeParagraph

        public void closeParagraph​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a paragraph is closed.

        Default implementation is: 

         out.append("</p>\n");
        Specified by:
        closeParagraph in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeParagraph(StringBuilder)

      • openBlockquote

        public void openBlockquote​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a blockquote is opened. Default implementation is: 
         out.append("<blockquote>");
        Specified by:
        openBlockquote in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openBlockquote(StringBuilder)

      • closeBlockquote

        public void closeBlockquote​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a blockquote is closed.

        Default implementation is: 

         out.append("</blockquote>\n");
        Specified by:
        closeBlockquote in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeBlockquote(StringBuilder)

      • openCodeBlock

        public void openCodeBlock​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a code block is opened.

        Default implementation is: 

         out.append("<pre><code>");
        Specified by:
        openCodeBlock in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openCodeBlock(StringBuilder)

      • closeCodeBlock

        public void closeCodeBlock​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a code block is closed.

        Default implementation is: 

         out.append("</code></pre>\n");
        Specified by:
        closeCodeBlock in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeCodeBlock(StringBuilder)

      • openCodeSpan

        public void openCodeSpan​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a code span is opened.

        Default implementation is: 

         out.append("<code>");
        Specified by:
        openCodeSpan in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openCodeSpan(StringBuilder)

      • closeCodeSpan

        public void closeCodeSpan​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a code span is closed.

        Default implementation is: 

         out.append("</code>");
        Specified by:
        closeCodeSpan in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeCodeSpan(StringBuilder)

      • openHeadline

        public void openHeadline​(java.lang.StringBuilder out,
                         int level)
        Description copied from interface: Decorator
        Called when a headline is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

          out.append("<h");
 out.append(level);
        Specified by:
        openHeadline in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        level - The level to use.
        See Also:
        Decorator.openHeadline(StringBuilder, int)

      • closeHeadline

        public void closeHeadline​(java.lang.StringBuilder out,
                          int level)
        Description copied from interface: Decorator
        Called when a headline is closed.

        Default implementation is: 

          out.append("</h");
 out.append(level);
 out.append(">\n");
        Specified by:
        closeHeadline in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        level - The level to use.
        See Also:
        Decorator.closeHeadline(StringBuilder, int)

      • openStrong

        public void openStrong​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a strong span is opened.

        Default implementation is: 

         out.append("<strong>");
        Specified by:
        openStrong in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openStrong(StringBuilder)

      • closeStrong

        public void closeStrong​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a strong span is closed.

        Default implementation is: 

         out.append("</strong>");
        Specified by:
        closeStrong in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeStrong(StringBuilder)

      • openEmphasis

        public void openEmphasis​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when an emphasis span is opened.

        Default implementation is: 

         out.append("<em>");
        Specified by:
        openEmphasis in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openEmphasis(StringBuilder)

      • closeEmphasis

        public void closeEmphasis​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when an emphasis span is closed.

        Default implementation is: 

         out.append("</em>");
        Specified by:
        closeEmphasis in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeEmphasis(StringBuilder)

      • openSuper

        public void openSuper​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a superscript span is opened.

        Default implementation is: 

         out.append("<sup>");
        Specified by:
        openSuper in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openSuper(StringBuilder)

      • closeSuper

        public void closeSuper​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a superscript span is closed.

        Default implementation is: 

         out.append("</sup>");
        Specified by:
        closeSuper in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeSuper(StringBuilder)

      • openOrderedList

        public void openOrderedList​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when an ordered list is opened.

        Default implementation is: 

         out.append("<ol>\n");
        Specified by:
        openOrderedList in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openOrderedList(StringBuilder)

      • openListItem

        public void openListItem​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a list item is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

         out.append("<li");
        Specified by:
        openListItem in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openListItem(StringBuilder)

      • closeListItem

        public void closeListItem​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a list item is closed.

        Default implementation is: 

         out.append("</li>\n");
        Specified by:
        closeListItem in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeListItem(StringBuilder)

      • horizontalRuler

        public void horizontalRuler​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a horizontal ruler is encountered.

        Default implementation is: 

         out.append("<hr />\n");
        Specified by:
        horizontalRuler in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.horizontalRuler(StringBuilder)

      • openLink

        public void openLink​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a link is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

         out.append("<a");
        Specified by:
        openLink in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openLink(StringBuilder)

      • closeLink

        public void closeLink​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when a link is closed

        Default implementation is: 

         out.append("</a>");
        Specified by:
        closeLink in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeLink(StringBuilder)

      • openImage

        public void openImage​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when an image is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

         out.append("<img");
        Specified by:
        openImage in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.openImage(StringBuilder)

      • closeImage

        public void closeImage​(java.lang.StringBuilder out)
        Description copied from interface: Decorator
        Called when an image is closed.

        Default implementation is: 

         out.append(" />");
        Specified by:
        closeImage in interface Decorator
        Parameters:
        out - The StringBuilder to write to.
        See Also:
        Decorator.closeImage(StringBuilder)