io.github.swagger2markup.markup.builder.internal

Class AbstractMarkupDocBuilder

java.lang.Object

io.github.swagger2markup.markup.builder.internal.AbstractMarkupDocBuilder

All Implemented Interfaces:

MarkupDocBuilder

Direct Known Subclasses:

AsciiDocBuilder, ConfluenceMarkupBuilder, MarkdownBuilder

public abstract class AbstractMarkupDocBuilder
extends java.lang.Object
implements MarkupDocBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	ANCHOR_IGNORABLE_PATTERN
protected static java.lang.String	ANCHOR_SEPARATION_CHARACTERS
protected static java.util.regex.Pattern	ANCHOR_UNIGNORABLE_PATTERN
protected java.lang.String	anchorPrefix
protected java.lang.StringBuilder	documentBuilder
protected static boolean	LINE_BREAK_DEFAULT Explicit line break default behavior for line returns, when not specified.
protected org.slf4j.Logger	logger
protected static int	MAX_TITLE_LEVEL
protected static java.lang.String	NEW_LINES
protected java.lang.String	newLine
protected static java.lang.String	WHITESPACE

Constructor Summary

Constructors

Constructor and Description
AbstractMarkupDocBuilder()
AbstractMarkupDocBuilder(java.lang.String newLine)

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	addFileExtension(java.nio.file.Path file) Add an extension to file depending on markup language.
MarkupDocBuilder	anchor(java.lang.String anchor) Builds a custom anchor for later reference.
MarkupDocBuilder	block(java.lang.String text, MarkupBlockStyle style) Builds a block of text with specified style.
protected void	boldText(Markup markup, java.lang.String text)
MarkupDocBuilder	boldTextLine(java.lang.String text) Builds a bold text line.
MarkupDocBuilder	boldTextLine(java.lang.String text, boolean forceLineBreak) Builds a bold text line.
protected java.lang.String	convert(java.lang.String markupText, MarkupLanguage markupLanguage)
MarkupDocBuilder	crossReference(java.lang.String anchor) Builds an cross-reference to local document anchor.
MarkupDocBuilder	crossReference(java.lang.String anchor, java.lang.String text) Builds an cross-reference to local document anchor with specified text.
MarkupDocBuilder	crossReferenceRaw(java.lang.String anchor) Builds an cross-reference to local document anchor.
MarkupDocBuilder	crossReferenceRaw(java.lang.String anchor, java.lang.String text) Builds an cross-reference to local document anchor with specified text.
protected void	delimitedBlockText(Markup markup, java.lang.String text)
protected void	delimitedBlockText(Markup begin, java.lang.String text, Markup end)
protected void	delimitedBlockText(Markup begin, java.lang.String text, Markup end, boolean skipLeadingNewline)
protected void	delimitedTextWithoutLineBreaks(Markup markup, java.lang.String text)
protected void	delimitedTextWithoutLineBreaks(Markup begin, java.lang.String text, Markup end)
protected void	documentTitle(Markup markup, java.lang.String title)
java.lang.String	getAnchorPrefix()
protected abstract MarkupLanguage	getMarkupLanguage()
MarkupDocBuilder	importMarkup(java.io.Reader markupText, MarkupLanguage markupLanguage) Import some markup text into this builder.
protected void	importMarkupStyle1(java.util.regex.Pattern titlePattern, Markup titlePrefix, java.io.Reader markupText, MarkupLanguage markupLanguage, int levelOffset)
protected void	importMarkupStyle2(java.util.regex.Pattern titlePattern, java.lang.String titleFormat, boolean startFrom0, java.io.Reader markupText, MarkupLanguage markupLanguage, int levelOffset)
protected void	italicText(Markup markup, java.lang.String text)
MarkupDocBuilder	italicTextLine(java.lang.String text) Builds an italic text line.
MarkupDocBuilder	italicTextLine(java.lang.String text, boolean forceLineBreak) Builds an italic text line.
MarkupDocBuilder	listingBlock(java.lang.String text) Builds a listing text block.
protected void	literalText(Markup markup, java.lang.String text)
MarkupDocBuilder	literalTextLine(java.lang.String text) Builds a literal text line.
MarkupDocBuilder	literalTextLine(java.lang.String text, boolean forceLineBreak) Builds a literal text line.
MarkupDocBuilder	newLine() Builds a newline using System.getProperty("line.separator").
protected void	newLine(Markup markup, boolean forceLineBreak)
protected java.lang.String	normalizeAnchor(Markup spaceEscape, java.lang.String anchor)
MarkupDocBuilder	paragraph(java.lang.String text) Builds a text paragraph.
java.lang.String	replaceNewLines(java.lang.String content)
java.lang.String	replaceNewLines(java.lang.String content, java.lang.String replacement)
java.lang.String	replaceNewLinesWithWhiteSpace(java.lang.String content)
protected void	sectionTitleLevel(Markup markup, int level, java.lang.String title)
MarkupDocBuilder	sectionTitleLevel1(java.lang.String title) Builds a level 1 section title.
MarkupDocBuilder	sectionTitleLevel2(java.lang.String title) Builds a level 2 section title.
MarkupDocBuilder	sectionTitleLevel3(java.lang.String title) Builds a level 3 section title.
MarkupDocBuilder	sectionTitleLevel4(java.lang.String title) Builds a level 4 section title.
MarkupDocBuilder	sectionTitleLevel5(java.lang.String title) Builds a level 5 section title.
MarkupDocBuilder	sectionTitleWithAnchorLevel(int level, java.lang.String title) Builds a section title with an auto-generated anchor from the normalized title, for later reference.
protected void	sectionTitleWithAnchorLevel(Markup markup, int level, java.lang.String title, java.lang.String anchor)
MarkupDocBuilder	sectionTitleWithAnchorLevel1(java.lang.String title) Builds a level 1 section title with an auto-generated anchor from the normalized title, for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel1(java.lang.String title, java.lang.String anchor) Builds a level 1 section title with a custom anchor for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel2(java.lang.String title) Builds a level 2 section title with an auto-generated anchor from the normalized title, for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel2(java.lang.String title, java.lang.String anchor) Builds a level 2 section title with a custom anchor for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel3(java.lang.String title) Builds a level 3 section title with an auto-generated anchor from the normalized title, for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel3(java.lang.String title, java.lang.String anchor) Builds a level 3 section title with a custom anchor for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel4(java.lang.String title) Builds a level 4 section title with an auto-generated anchor from the normalized title, for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel4(java.lang.String title, java.lang.String anchor) Builds a level 4 section title with a custom anchor for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel5(java.lang.String title) Builds a level 5 section title with an auto-generated anchor from the normalized title, for later reference.
MarkupDocBuilder	sectionTitleWithAnchorLevel5(java.lang.String title, java.lang.String anchor) Builds a level 5 section title with a custom anchor for later reference.
MarkupDocBuilder	table(java.util.List<java.util.List<java.lang.String>> cells) Builds a table without column specifiers, using specified cell values.
MarkupDocBuilder	text(java.lang.String text) Builds a regular text.
MarkupDocBuilder	textLine(java.lang.String text) Builds a regular text line.
MarkupDocBuilder	textLine(java.lang.String text, boolean forceLineBreak) Builds a regular text line.
java.lang.String	toString() Returns a string representation of the document.
protected void	unorderedList(Markup markup, java.util.List<java.lang.String> list)
protected void	unorderedListItem(Markup markup, java.lang.String item)
MarkupDocBuilder	withAnchorPrefix(java.lang.String prefix) Configure this builder to prefix all generated anchors with prefix.
void	writeToFile(java.nio.file.Path file, java.nio.charset.Charset charset, java.nio.file.OpenOption... options) Writes the content of the builder to a file.
void	writeToFileWithoutExtension(java.nio.file.Path file, java.nio.charset.Charset charset, java.nio.file.OpenOption... options) 2 newLines are needed at the end of file for file to be included without protection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.swagger2markup.markup.builder.MarkupDocBuilder

addFileExtension, anchor, block, boldText, copy, crossReference, crossReferenceRaw, documentTitle, importMarkup, italicText, listingBlock, literalText, newLine, pageBreak, paragraph, sectionTitleLevel, sectionTitleWithAnchorLevel, tableWithColumnSpecs, unorderedList, unorderedListItem

Field Detail

LINE_BREAK_DEFAULT

protected static final boolean LINE_BREAK_DEFAULT

Explicit line break default behavior for line returns, when not specified. Please, change documentation accordingly.

See Also:

Constant Field Values

ANCHOR_UNIGNORABLE_PATTERN

protected static final java.util.regex.Pattern ANCHOR_UNIGNORABLE_PATTERN

ANCHOR_IGNORABLE_PATTERN

protected static final java.util.regex.Pattern ANCHOR_IGNORABLE_PATTERN

ANCHOR_SEPARATION_CHARACTERS

protected static final java.lang.String ANCHOR_SEPARATION_CHARACTERS

See Also:

Constant Field Values

MAX_TITLE_LEVEL

protected static final int MAX_TITLE_LEVEL

See Also:

Constant Field Values

NEW_LINES

protected static final java.lang.String NEW_LINES

See Also:

Constant Field Values

WHITESPACE

protected static final java.lang.String WHITESPACE

See Also:

Constant Field Values

documentBuilder

protected java.lang.StringBuilder documentBuilder

newLine

protected java.lang.String newLine

logger

protected org.slf4j.Logger logger

anchorPrefix

protected java.lang.String anchorPrefix

Constructor Detail

AbstractMarkupDocBuilder

public AbstractMarkupDocBuilder()

AbstractMarkupDocBuilder

public AbstractMarkupDocBuilder(java.lang.String newLine)

Method Detail

getMarkupLanguage

protected abstract MarkupLanguage getMarkupLanguage()

withAnchorPrefix

public MarkupDocBuilder withAnchorPrefix(java.lang.String prefix)

Description copied from interface: MarkupDocBuilder

Configure this builder to prefix all generated anchors with prefix.

Specified by:

withAnchorPrefix in interface MarkupDocBuilder

Parameters:

prefix - anchor prefix

Returns:

this builder

getAnchorPrefix

public java.lang.String getAnchorPrefix()

Specified by:

getAnchorPrefix in interface MarkupDocBuilder

Returns:

anchor prefix configuration

documentTitle

protected void documentTitle(Markup markup,
                             java.lang.String title)

sectionTitleLevel

protected void sectionTitleLevel(Markup markup,
                                 int level,
                                 java.lang.String title)

sectionTitleWithAnchorLevel

protected void sectionTitleWithAnchorLevel(Markup markup,
                                           int level,
                                           java.lang.String title,
                                           java.lang.String anchor)

sectionTitleWithAnchorLevel

public MarkupDocBuilder sectionTitleWithAnchorLevel(int level,
                                                    java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a section title with an auto-generated anchor from the normalized title, for later reference.
This is an alias for sectionTitleWithAnchorLevel(level, title, null).

Specified by:

sectionTitleWithAnchorLevel in interface MarkupDocBuilder

Parameters:

level - section title level [1, 5]

title - title

Returns:

this builder

sectionTitleLevel1

public MarkupDocBuilder sectionTitleLevel1(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 1 section title.

Specified by:

sectionTitleLevel1 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel1

public MarkupDocBuilder sectionTitleWithAnchorLevel1(java.lang.String title,
                                                     java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds a level 1 section title with a custom anchor for later reference.
Specified anchor will be normalized anyway.

Specified by:

sectionTitleWithAnchorLevel1 in interface MarkupDocBuilder

Parameters:

title - title

anchor - custom anchor. If null, auto-generate the anchor from the normalized title.

Returns:

this builder

sectionTitleWithAnchorLevel1

public MarkupDocBuilder sectionTitleWithAnchorLevel1(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 1 section title with an auto-generated anchor from the normalized title, for later reference.
This is an alias for sectionTitleWithAnchorLevel1(title, null).

Specified by:

sectionTitleWithAnchorLevel1 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleLevel2

public MarkupDocBuilder sectionTitleLevel2(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 2 section title.

Specified by:

sectionTitleLevel2 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel2

public MarkupDocBuilder sectionTitleWithAnchorLevel2(java.lang.String title,
                                                     java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds a level 2 section title with a custom anchor for later reference.
Specified anchor will be normalized anyway.

Specified by:

sectionTitleWithAnchorLevel2 in interface MarkupDocBuilder

Parameters:

title - title

anchor - custom anchor. If null, auto-generate the anchor from the normalized title.

Returns:

this builder

sectionTitleWithAnchorLevel2

public MarkupDocBuilder sectionTitleWithAnchorLevel2(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 2 section title with an auto-generated anchor from the normalized title, for later reference.
This is an alias for sectionTitleWithAnchorLevel2(title, null).

Specified by:

sectionTitleWithAnchorLevel2 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleLevel3

public MarkupDocBuilder sectionTitleLevel3(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 3 section title.

Specified by:

sectionTitleLevel3 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel3

public MarkupDocBuilder sectionTitleWithAnchorLevel3(java.lang.String title,
                                                     java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds a level 3 section title with a custom anchor for later reference.
Specified anchor will be normalized anyway.

Specified by:

sectionTitleWithAnchorLevel3 in interface MarkupDocBuilder

Parameters:

title - title

anchor - custom anchor. If null, auto-generate the anchor from the normalized title.

Returns:

this builder

sectionTitleWithAnchorLevel3

public MarkupDocBuilder sectionTitleWithAnchorLevel3(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 3 section title with an auto-generated anchor from the normalized title, for later reference.
This is an alias for sectionTitleWithAnchorLevel3(title, null).

Specified by:

sectionTitleWithAnchorLevel3 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleLevel4

public MarkupDocBuilder sectionTitleLevel4(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 4 section title.

Specified by:

sectionTitleLevel4 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel4

public MarkupDocBuilder sectionTitleWithAnchorLevel4(java.lang.String title,
                                                     java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds a level 4 section title with a custom anchor for later reference.
Specified anchor will be normalized anyway.

Specified by:

sectionTitleWithAnchorLevel4 in interface MarkupDocBuilder

Parameters:

title - title

anchor - custom anchor. If null, auto-generate the anchor from the normalized title.

Returns:

this builder

sectionTitleWithAnchorLevel4

public MarkupDocBuilder sectionTitleWithAnchorLevel4(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 4 section title with an auto-generated anchor from the normalized title, for later reference.
This is an alias for sectionTitleWithAnchorLevel4(title, null).

Specified by:

sectionTitleWithAnchorLevel4 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleLevel5

public MarkupDocBuilder sectionTitleLevel5(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 5 section title.

Specified by:

sectionTitleLevel5 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel5

public MarkupDocBuilder sectionTitleWithAnchorLevel5(java.lang.String title,
                                                     java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds a level 5 section title with a custom anchor for later reference.
Specified anchor will be normalized anyway.

Specified by:

sectionTitleWithAnchorLevel5 in interface MarkupDocBuilder

Parameters:

title - title

anchor - custom anchor. If null, auto-generate the anchor from the normalized title.

Returns:

this builder

sectionTitleWithAnchorLevel5

public MarkupDocBuilder sectionTitleWithAnchorLevel5(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a level 5 section title with an auto-generated anchor from the normalized title, for later reference.
This is an alias for sectionTitleWithAnchorLevel5(title, null).

Specified by:

sectionTitleWithAnchorLevel5 in interface MarkupDocBuilder

Parameters:

title - title

Returns:

this builder

textLine

public MarkupDocBuilder textLine(java.lang.String text,
                                 boolean forceLineBreak)

Description copied from interface: MarkupDocBuilder

Builds a regular text line.

Specified by:

textLine in interface MarkupDocBuilder

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

textLine

public MarkupDocBuilder textLine(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a regular text line.
This is an alias for textLine(text, false).

Specified by:

textLine in interface MarkupDocBuilder

Parameters:

text - text

Returns:

this builder

text

public MarkupDocBuilder text(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a regular text.

Specified by:

text in interface MarkupDocBuilder

Parameters:

text - text

Returns:

this builder

paragraph

public MarkupDocBuilder paragraph(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a text paragraph.
This is an alias for paragraph(text, false).

Specified by:

paragraph in interface MarkupDocBuilder

Parameters:

text - multi-line text

Returns:

this builder

block

public MarkupDocBuilder block(java.lang.String text,
                              MarkupBlockStyle style)

Description copied from interface: MarkupDocBuilder

Builds a block of text with specified style.
This is an alias for block(String, MarkupBlockStyle, null, null).

Specified by:

block in interface MarkupDocBuilder

Parameters:

text - text

style - block style

Returns:

this builder

listingBlock

public MarkupDocBuilder listingBlock(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a listing text block.
This is an alias for listingBlock(String, null).

Specified by:

listingBlock in interface MarkupDocBuilder

Parameters:

text - multi-line text

Returns:

this builder

delimitedBlockText

protected void delimitedBlockText(Markup begin,
                                  java.lang.String text,
                                  Markup end,
                                  boolean skipLeadingNewline)

delimitedBlockText

protected void delimitedBlockText(Markup begin,
                                  java.lang.String text,
                                  Markup end)

delimitedTextWithoutLineBreaks

protected void delimitedTextWithoutLineBreaks(Markup begin,
                                              java.lang.String text,
                                              Markup end)

delimitedBlockText

protected void delimitedBlockText(Markup markup,
                                  java.lang.String text)

delimitedTextWithoutLineBreaks

protected void delimitedTextWithoutLineBreaks(Markup markup,
                                              java.lang.String text)

literalText

protected void literalText(Markup markup,
                           java.lang.String text)

literalTextLine

public MarkupDocBuilder literalTextLine(java.lang.String text,
                                        boolean forceLineBreak)

Description copied from interface: MarkupDocBuilder

Builds a literal text line.

Specified by:

literalTextLine in interface MarkupDocBuilder

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

literalTextLine

public MarkupDocBuilder literalTextLine(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a literal text line.
This is an alias for literalTextLine(text, false).

Specified by:

literalTextLine in interface MarkupDocBuilder

Parameters:

text - text

Returns:

this builder

boldText

protected void boldText(Markup markup,
                        java.lang.String text)

boldTextLine

public MarkupDocBuilder boldTextLine(java.lang.String text,
                                     boolean forceLineBreak)

Description copied from interface: MarkupDocBuilder

Builds a bold text line.

Specified by:

boldTextLine in interface MarkupDocBuilder

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

boldTextLine

public MarkupDocBuilder boldTextLine(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a bold text line.
This is an alias for boldTextLine(text, false).

Specified by:

boldTextLine in interface MarkupDocBuilder

Parameters:

text - text

Returns:

this builder

italicText

protected void italicText(Markup markup,
                          java.lang.String text)

italicTextLine

public MarkupDocBuilder italicTextLine(java.lang.String text,
                                       boolean forceLineBreak)

Description copied from interface: MarkupDocBuilder

Builds an italic text line.

Specified by:

italicTextLine in interface MarkupDocBuilder

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

italicTextLine

public MarkupDocBuilder italicTextLine(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds an italic text line.
This is an alias for italicTextLine(text, false).

Specified by:

italicTextLine in interface MarkupDocBuilder

Parameters:

text - text

Returns:

this builder

unorderedList

protected void unorderedList(Markup markup,
                             java.util.List<java.lang.String> list)

unorderedListItem

protected void unorderedListItem(Markup markup,
                                 java.lang.String item)

anchor

public MarkupDocBuilder anchor(java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds a custom anchor for later reference.
Specified anchor will be normalized anyway.

Specified by:

anchor in interface MarkupDocBuilder

Parameters:

anchor - custom anchor

Returns:

this builder

normalizeAnchor

protected java.lang.String normalizeAnchor(Markup spaceEscape,
                                           java.lang.String anchor)

crossReferenceRaw

public MarkupDocBuilder crossReferenceRaw(java.lang.String anchor,
                                          java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds an cross-reference to local document anchor with specified text.
This is the "raw anchor" version. Use the preferred method MarkupDocBuilder.crossReference(String, String) instead.
Specified anchor is built as-is, without any normalization.

Specified by:

crossReferenceRaw in interface MarkupDocBuilder

Parameters:

anchor - anchor to point to

text - display text

Returns:

this builder

crossReferenceRaw

public MarkupDocBuilder crossReferenceRaw(java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds an cross-reference to local document anchor.
This is the "raw anchor" version. Use the preferred method MarkupDocBuilder.crossReference(String) instead.
Specified anchor is built as-is, without any normalization.

Specified by:

crossReferenceRaw in interface MarkupDocBuilder

Parameters:

anchor - anchor to point to

Returns:

this builder

crossReference

public MarkupDocBuilder crossReference(java.lang.String anchor,
                                       java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds an cross-reference to local document anchor with specified text.
Specified anchor will be normalized anyway.

Specified by:

crossReference in interface MarkupDocBuilder

Parameters:

anchor - anchor to point to

text - display text

Returns:

this builder

crossReference

public MarkupDocBuilder crossReference(java.lang.String anchor)

Description copied from interface: MarkupDocBuilder

Builds an cross-reference to local document anchor.
Specified anchor will be normalized anyway.

Specified by:

crossReference in interface MarkupDocBuilder

Parameters:

anchor - anchor to point to

Returns:

this builder

newLine

protected void newLine(Markup markup,
                       boolean forceLineBreak)

newLine

public MarkupDocBuilder newLine()

Description copied from interface: MarkupDocBuilder

Builds a newline using System.getProperty("line.separator").
This is an alias for newLine(false).

Specified by:

newLine in interface MarkupDocBuilder

Returns:

this builder

importMarkup

public MarkupDocBuilder importMarkup(java.io.Reader markupText,
                                     MarkupLanguage markupLanguage)

Description copied from interface: MarkupDocBuilder

Import some markup text into this builder.
This is an alias for importMarkup(markupText, markupLanguage, 0).

Specified by:

importMarkup in interface MarkupDocBuilder

Parameters:

markupText - markup reader to read data from

markupLanguage - identify the imported markup language

Returns:

this builder

convert

protected java.lang.String convert(java.lang.String markupText,
                                   MarkupLanguage markupLanguage)

importMarkupStyle1

protected void importMarkupStyle1(java.util.regex.Pattern titlePattern,
                                  Markup titlePrefix,
                                  java.io.Reader markupText,
                                  MarkupLanguage markupLanguage,
                                  int levelOffset)

importMarkupStyle2

protected void importMarkupStyle2(java.util.regex.Pattern titlePattern,
                                  java.lang.String titleFormat,
                                  boolean startFrom0,
                                  java.io.Reader markupText,
                                  MarkupLanguage markupLanguage,
                                  int levelOffset)

table

public MarkupDocBuilder table(java.util.List<java.util.List<java.lang.String>> cells)

Description copied from interface: MarkupDocBuilder

Builds a table without column specifiers, using specified cell values.
This is an alias for tableWithColumnSpecs(null, cells).
Limited support : Markdown does not support table without headers.

Specified by:

table in interface MarkupDocBuilder

Parameters:

cells - cell values

Returns:

this builder

toString

public java.lang.String toString()

Description copied from interface: MarkupDocBuilder

Returns a string representation of the document.

Specified by:

toString in interface MarkupDocBuilder

Overrides:

toString in class java.lang.Object

addFileExtension

public java.nio.file.Path addFileExtension(java.nio.file.Path file)

Description copied from interface: MarkupDocBuilder

Add an extension to file depending on markup language.

Specified by:

addFileExtension in interface MarkupDocBuilder

Parameters:

file - without extension

Returns:

file with an extension

writeToFileWithoutExtension

public void writeToFileWithoutExtension(java.nio.file.Path file,
                                        java.nio.charset.Charset charset,
                                        java.nio.file.OpenOption... options)

2 newLines are needed at the end of file for file to be included without protection.

Specified by:

writeToFileWithoutExtension in interface MarkupDocBuilder

Parameters:

file - the generated file

charset - the the charset to use for encoding

options - the file open options

replaceNewLines

public java.lang.String replaceNewLines(java.lang.String content,
                                        java.lang.String replacement)

replaceNewLines

public java.lang.String replaceNewLines(java.lang.String content)

replaceNewLinesWithWhiteSpace

public java.lang.String replaceNewLinesWithWhiteSpace(java.lang.String content)

writeToFile

public void writeToFile(java.nio.file.Path file,
                        java.nio.charset.Charset charset,
                        java.nio.file.OpenOption... options)

Description copied from interface: MarkupDocBuilder

Writes the content of the builder to a file.
An extension will be dynamically added to fileName depending on the markup language.

Specified by:

writeToFile in interface MarkupDocBuilder

Parameters:

file - the generated file without extension

charset - the the charset to use for encoding

options - the file open options