Module md.grammar

Package io.fixprotocol.md.event

Class MarkdownUtil

java.lang.Object

io.fixprotocol.md.event.MarkdownUtil

public final class MarkdownUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static char	BACKTICK_CHARACTER
static char	ESCAPE_CHARACTER
static char	LINEFEED_CHARACTER
static String	MARKDOWN_MEDIA_TYPE
static String	MARKDOWN_PARAGRAPH_BREAK
static char	PIPE_CHARACTER

Constructor Summary

Constructors

Constructor	Description
MarkdownUtil()

Method Summary

Modifier and Type	Method	Description
static String	markdownLiteralToPlainText(String literal)	Translates a markdown literal surrounded by single backtick characters to plain text.
static String	plainTextToMarkdown(String text)	Translates plaintext to markdown A standard markdown paragraph break is used.
static String	plainTextToMarkdown(String text, String markdownParagraphBreak)	Translates plaintext to markdown Leading and trailing whitespace is removed Escape these characters: pipe '|' Convert linefeed to specified paragraph break token Pass through XML/HTML entity references
static String	plainTextToMarkdownLiteral(String text)	Text is surrounded by backtick characters Special characters within the literal are not escaped.
static String	stripCell(String str)	Trims leading and trailing whitespace or pipe characters, leaving just the text within a markdown table cell.

Methods inherited from class java.lang.Object

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

Field Detail

BACKTICK_CHARACTER

public static final char BACKTICK_CHARACTER

See Also:

Constant Field Values

ESCAPE_CHARACTER

public static final char ESCAPE_CHARACTER

See Also:

Constant Field Values

LINEFEED_CHARACTER

public static final char LINEFEED_CHARACTER

See Also:

Constant Field Values

MARKDOWN_MEDIA_TYPE

public static final String MARKDOWN_MEDIA_TYPE

See Also:

Constant Field Values

MARKDOWN_PARAGRAPH_BREAK

public static final String MARKDOWN_PARAGRAPH_BREAK

See Also:

Constant Field Values

PIPE_CHARACTER

public static final char PIPE_CHARACTER

See Also:

Constant Field Values

Constructor Detail

MarkdownUtil

public MarkdownUtil()

Method Detail

markdownLiteralToPlainText

public static String markdownLiteralToPlainText(String literal)

Translates a markdown literal surrounded by single backtick characters to plain text. Any characters prior to the first backtick or after the last one are ignored. If backticks are not present, the whole string is passed through.

Parameters:

literal - a markdown literal

Returns:

unescaped plain text

Throws:

NullPointerException - if literal is null

plainTextToMarkdown

public static String plainTextToMarkdown(String text)

Translates plaintext to markdown A standard markdown paragraph break is used.

Parameters:

text - plaintext

Returns:

a markdown string

See Also:

plainTextToMarkdown(String, String)

plainTextToMarkdown

public static String plainTextToMarkdown(String text,
                                         String markdownParagraphBreak)

Translates plaintext to markdown

• Leading and trailing whitespace is removed
• Escape these characters: pipe '|'
• Convert linefeed to specified paragraph break token
• Pass through XML/HTML entity references

Parameters:

text - plaintext

markdownParagraphBreak - token to use for paragraph break in markdown

Returns:

a markdown string

plainTextToMarkdownLiteral

public static String plainTextToMarkdownLiteral(String text)

Text is surrounded by backtick characters Special characters within the literal are not escaped.

Parameters:

text - plain text

Returns:

a markdown literal

stripCell

public static String stripCell(String str)

Trims leading and trailing whitespace or pipe characters, leaving just the text within a markdown table cell.

Parameters:

str - string to strip

Returns:

a string without leading or trailing whitespace, or null if the parameter is null