Enum MarkdownSink.ElementContext

java.lang.Object

java.lang.Enum<MarkdownSink.ElementContext>

org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext

All Implemented Interfaces:

Serializable, Comparable<MarkdownSink.ElementContext>

Enclosing class:

MarkdownSink

static enum MarkdownSink.ElementContext
extends Enum<MarkdownSink.ElementContext>

Most important contextual metadata (of elements). This contains information about necessary escaping rules, potential prefixes and newlines

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	MarkdownSink.ElementContext.Type

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKQUOTE
BODY
CODE_BLOCK
CODE_SPAN
FIGURE
HEAD
HEADING
HTML_BLOCK
LIST_ITEM
ROOT_WITH_BUFFERING
ROOT_WITHOUT_BUFFERING
TABLE
TABLE_CAPTION
TABLE_CELL
TABLE_ROW

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final boolean	allowsMarkupLinebreaks	If markup linebreaks (i.e.
(package private) final MarkdownSink.TextEscapeFunction	escapeFunction	The function to call to escape the given text.
(package private) final String	prefix	prefix to be used for each line of (nested) block elements inside the current container context (only not empty for type being MarkdownSink.ElementContext.Type.CONTAINER_BLOCK)
(package private) final boolean	requiresBuffering	if true requires buffering any text appearing inside this context
(package private) final boolean	requiresSurroundingByBlankLines	Only relevant for block element, if set to true the element requires to be surrounded by blank lines.
(package private) final MarkdownSink.ElementContext.Type	type	true if block element, otherwise false for inline elements

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ElementContext(MarkdownSink.ElementContext.Type type, boolean allowsMarkupLinebreaks, MarkdownSink.TextEscapeFunction escapeFunction)
private	ElementContext(MarkdownSink.ElementContext.Type type, boolean allowsMarkupLinebreaks, MarkdownSink.TextEscapeFunction escapeFunction, boolean requiresBuffering)
private	ElementContext(MarkdownSink.ElementContext.Type type, boolean allowsMarkupLinebreaks, MarkdownSink.TextEscapeFunction escapeFunction, boolean requiresBuffering, String prefix)
private	ElementContext(MarkdownSink.ElementContext.Type type, boolean allowsMarkupLinebreaks, MarkdownSink.TextEscapeFunction escapeFunction, boolean requiresBuffering, String prefix, boolean requiresSurroundingByBlankLines)

Method Summary

Modifier and Type	Method	Description
(package private) String	escape(LastTwoLinesAwareWriter writer, String text)	Must be called for each inline text to be emitted directly within this context (not relevant for nested context)
private String	escapeForTableCell(LastTwoLinesAwareWriter writer, String text)	Escapes the pipe character according to GFM Table Extension in addition to the regular markdown escaping.
private String	escapeHtml(LastTwoLinesAwareWriter writer, String text)
private static String	escapeMarkdown(char c)
private String	escapeMarkdown(LastTwoLinesAwareWriter writer, String text)	First use XML escaping (leveraging the predefined entities, for browsers) afterwards escape special characters in a text with a leading backslash (for markdown parsers)
private static boolean	isAfterDigit(StringBuilder buffer, LastTwoLinesAwareWriter writer)
boolean	isAllowsMarkupLinebreaks()
(package private) boolean	isBlock()
(package private) boolean	isContainer()
(package private) boolean	isHtml()
private static boolean	isInBlankLine(StringBuilder buffer, LastTwoLinesAwareWriter writer)
static MarkdownSink.ElementContext	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MarkdownSink.ElementContext[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ROOT_WITH_BUFFERING

public static final MarkdownSink.ElementContext ROOT_WITH_BUFFERING

ROOT_WITHOUT_BUFFERING

public static final MarkdownSink.ElementContext ROOT_WITHOUT_BUFFERING

HEAD

public static final MarkdownSink.ElementContext HEAD

BODY

public static final MarkdownSink.ElementContext BODY

FIGURE

public static final MarkdownSink.ElementContext FIGURE

HEADING

public static final MarkdownSink.ElementContext HEADING

CODE_BLOCK

public static final MarkdownSink.ElementContext CODE_BLOCK

CODE_SPAN

public static final MarkdownSink.ElementContext CODE_SPAN

TABLE

public static final MarkdownSink.ElementContext TABLE

TABLE_CAPTION

public static final MarkdownSink.ElementContext TABLE_CAPTION

TABLE_ROW

public static final MarkdownSink.ElementContext TABLE_ROW

TABLE_CELL

public static final MarkdownSink.ElementContext TABLE_CELL

LIST_ITEM

public static final MarkdownSink.ElementContext LIST_ITEM

BLOCKQUOTE

public static final MarkdownSink.ElementContext BLOCKQUOTE

HTML_BLOCK

public static final MarkdownSink.ElementContext HTML_BLOCK

Field Details

type

final MarkdownSink.ElementContext.Type type

true if block element, otherwise false for inline elements

escapeFunction

final MarkdownSink.TextEscapeFunction escapeFunction

The function to call to escape the given text. The function is supposed to return the escaped text or return just the given text if no escaping is necessary in this context

requiresBuffering

final boolean requiresBuffering

if true requires buffering any text appearing inside this context

prefix

final String prefix

prefix to be used for each line of (nested) block elements inside the current container context (only not empty for type being MarkdownSink.ElementContext.Type.CONTAINER_BLOCK)

requiresSurroundingByBlankLines

final boolean requiresSurroundingByBlankLines

Only relevant for block element, if set to true the element requires to be surrounded by blank lines.

allowsMarkupLinebreaks

final boolean allowsMarkupLinebreaks

If markup linebreaks (i.e. insignificant linebreaks in the source) are allowed in this context. This is relevant for markdown as in some contexts (e.g. list items) linebreaks are always significant (while for HTML they wouldn't be)

Constructor Details

ElementContext

private ElementContext(MarkdownSink.ElementContext.Type type,
 boolean allowsMarkupLinebreaks,
 MarkdownSink.TextEscapeFunction escapeFunction)

ElementContext

private ElementContext(MarkdownSink.ElementContext.Type type,
 boolean allowsMarkupLinebreaks,
 MarkdownSink.TextEscapeFunction escapeFunction,
 boolean requiresBuffering)

ElementContext

private ElementContext(MarkdownSink.ElementContext.Type type,
 boolean allowsMarkupLinebreaks,
 MarkdownSink.TextEscapeFunction escapeFunction,
 boolean requiresBuffering,
 String prefix)

ElementContext

private ElementContext(MarkdownSink.ElementContext.Type type,
 boolean allowsMarkupLinebreaks,
 MarkdownSink.TextEscapeFunction escapeFunction,
 boolean requiresBuffering,
 String prefix,
 boolean requiresSurroundingByBlankLines)

Method Details

values

public static MarkdownSink.ElementContext[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MarkdownSink.ElementContext valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

escape

String escape(LastTwoLinesAwareWriter writer,
 String text)

Must be called for each inline text to be emitted directly within this context (not relevant for nested context)

Parameters:

text -

Returns:

the escaped text (may be same as text when no escaping is necessary)

isBlock

boolean isBlock()

Returns:

true for all block types, false otherwise

isHtml

boolean isHtml()

Returns:

true if only HTML is allowed in this context

isContainer

boolean isContainer()

Returns:

true for all containers (allowing block elements as children), false otherwise

isAllowsMarkupLinebreaks

public boolean isAllowsMarkupLinebreaks()

escapeMarkdown

private String escapeMarkdown(LastTwoLinesAwareWriter writer,
 String text)

First use XML escaping (leveraging the predefined entities, for browsers) afterwards escape special characters in a text with a leading backslash (for markdown parsers)

\, `, *, _, {, }, [, ], (, ), #, +, -, ., !

Parameters:

text - the string to escape, may be null

Returns:

the text escaped, "" if null String input

See Also:

• Backslash Escapes

isAfterDigit

private static boolean isAfterDigit(StringBuilder buffer,
 LastTwoLinesAwareWriter writer)

isInBlankLine

private static boolean isInBlankLine(StringBuilder buffer,
 LastTwoLinesAwareWriter writer)

escapeMarkdown

private static String escapeMarkdown(char c)

escapeHtml

private String escapeHtml(LastTwoLinesAwareWriter writer,
 String text)

escapeForTableCell

private String escapeForTableCell(LastTwoLinesAwareWriter writer,
 String text)

Escapes the pipe character according to GFM Table Extension in addition to the regular markdown escaping.

Parameters:

text -

Returns:

the escaped text