at.favre.lib.planb.parser

Interface MarkupRenderer

All Known Implementing Classes:

AsciiDocRenderer, HTML5Renderer, MarkdownRenderer, TextileRenderer

public interface MarkupRenderer

Interface for implementing markup render with the generic markup language provided in GenericMLParser

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MarkupRenderer.MarkupLanguage
static class	MarkupRenderer.Util

Field Summary

Fields

Modifier and Type	Field and Description
static int	ML_ASCIIDOC
static int	ML_HTML
static int	ML_MARKDOWN
static int	ML_TEXTILE

Method Summary

Modifier and Type	Method and Description
int	getType() The type as defined in MarkupRenderer.MarkupLanguage
java.lang.String	render(java.lang.String content, int tokenType) Renders the equivalent of given token in the specific language
java.lang.String	renderFooter() Add a document footer if necessary
java.lang.String	renderHeader() Add a document header if necessary

Field Detail

ML_MARKDOWN

static final int ML_MARKDOWN

See Also:

Constant Field Values

ML_TEXTILE

static final int ML_TEXTILE

See Also:

Constant Field Values

ML_ASCIIDOC

static final int ML_ASCIIDOC

See Also:

Constant Field Values

ML_HTML

static final int ML_HTML

See Also:

Constant Field Values

Method Detail

renderHeader

java.lang.String renderHeader()

Add a document header if necessary

Returns:

a header or empty string

render

java.lang.String render(java.lang.String content,
                        int tokenType)

Renders the equivalent of given token in the specific language

Parameters:

content - as string

tokenType - as defined in GenericMLParser.MarkupToken

Returns:

the rendered string in the implemented markup language

renderFooter

java.lang.String renderFooter()

Add a document footer if necessary

Returns:

a footer or empty string

getType

int getType()

The type as defined in MarkupRenderer.MarkupLanguage

Returns:

type as int