io.github.swagger2markup.markup.builder

Interface MarkupDocBuilder

All Known Implementing Classes:

AbstractMarkupDocBuilder, AsciiDocBuilder, ConfluenceMarkupBuilder, MarkdownBuilder

public interface MarkupDocBuilder

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.
java.lang.String	addFileExtension(java.lang.String fileName) Add an extension to fileName depending on markup language.
MarkupDocBuilder	anchor(java.lang.String anchor) Builds a custom anchor for later reference.
MarkupDocBuilder	anchor(java.lang.String anchor, java.lang.String text) Builds a custom anchor for later reference.
MarkupDocBuilder	block(java.lang.String text, MarkupBlockStyle style) Builds a block of text with specified style.
MarkupDocBuilder	block(java.lang.String text, MarkupBlockStyle style, java.lang.String title, MarkupAdmonition admonition) Builds a block of text with specified style.
MarkupDocBuilder	boldText(java.lang.String text) Builds a bold 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.
MarkupDocBuilder	copy(boolean copyBuffer) Builds a new instance of this builder with a state copy.
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	crossReference(java.lang.String document, java.lang.String anchor, java.lang.String text) Builds an inter-document cross-reference to 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.
MarkupDocBuilder	crossReferenceRaw(java.lang.String document, java.lang.String anchor, java.lang.String text) Builds an inter-document cross-reference to document#anchor with specified text.
MarkupDocBuilder	documentTitle(java.lang.String title) Builds a document section title.
java.lang.String	getAnchorPrefix()
MarkupDocBuilder	importMarkup(java.io.Reader markupText, MarkupLanguage markupLanguage) Import some markup text into this builder.
MarkupDocBuilder	importMarkup(java.io.Reader markupText, MarkupLanguage markupLanguage, int levelOffset) Import some markup text into this builder.
MarkupDocBuilder	italicText(java.lang.String text) Builds an italic 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.
MarkupDocBuilder	listingBlock(java.lang.String text, java.lang.String language) Builds a source code block using the specified language.
MarkupDocBuilder	literalText(java.lang.String text) Builds a literal 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").
MarkupDocBuilder	newLine(boolean forceLineBreak) Builds a newline using System.getProperty("line.separator").
MarkupDocBuilder	pageBreak() Insert a page break
MarkupDocBuilder	paragraph(java.lang.String text) Builds a text paragraph.
MarkupDocBuilder	paragraph(java.lang.String text, boolean hardbreaks) Builds a text paragraph.
MarkupDocBuilder	sectionTitleLevel(int level, java.lang.String title) Builds a section 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.
MarkupDocBuilder	sectionTitleWithAnchorLevel(int level, java.lang.String title, java.lang.String anchor) Builds a section title with a custom anchor for later reference.
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	tableWithColumnSpecs(java.util.List<MarkupTableColumn> columnSpecs, java.util.List<java.util.List<java.lang.String>> cells) Builds a table with 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.
MarkupDocBuilder	unorderedList(java.util.List<java.lang.String> list) Builds an unordered item list
MarkupDocBuilder	unorderedListItem(java.lang.String item) Builds a single list 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) Writes the content of the builder to a file.

Method Detail

documentTitle

MarkupDocBuilder documentTitle(java.lang.String title)

Builds a document section title.

Parameters:

title - title

Returns:

this builder

sectionTitleLevel

MarkupDocBuilder sectionTitleLevel(int level,
                                   java.lang.String title)

Builds a section title.

Parameters:

title - title

level - section title level [1, 5]

Returns:

this builder

sectionTitleWithAnchorLevel

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

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

Parameters:

title - title

level - section title level [1, 5]

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

Returns:

this builder

sectionTitleWithAnchorLevel

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

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).

Parameters:

title - title

level - section title level [1, 5]

Returns:

this builder

sectionTitleLevel1

MarkupDocBuilder sectionTitleLevel1(java.lang.String title)

Builds a level 1 section title.

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel1

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

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

Parameters:

title - title

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

Returns:

this builder

sectionTitleWithAnchorLevel1

MarkupDocBuilder sectionTitleWithAnchorLevel1(java.lang.String title)

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).

Parameters:

title - title

Returns:

this builder

sectionTitleLevel2

MarkupDocBuilder sectionTitleLevel2(java.lang.String title)

Builds a level 2 section title.

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel2

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

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

Parameters:

title - title

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

Returns:

this builder

sectionTitleWithAnchorLevel2

MarkupDocBuilder sectionTitleWithAnchorLevel2(java.lang.String title)

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).

Parameters:

title - title

Returns:

this builder

sectionTitleLevel3

MarkupDocBuilder sectionTitleLevel3(java.lang.String title)

Builds a level 3 section title.

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel3

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

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

Parameters:

title - title

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

Returns:

this builder

sectionTitleWithAnchorLevel3

MarkupDocBuilder sectionTitleWithAnchorLevel3(java.lang.String title)

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).

Parameters:

title - title

Returns:

this builder

sectionTitleLevel4

MarkupDocBuilder sectionTitleLevel4(java.lang.String title)

Builds a level 4 section title.

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel4

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

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

Parameters:

title - title

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

Returns:

this builder

sectionTitleWithAnchorLevel4

MarkupDocBuilder sectionTitleWithAnchorLevel4(java.lang.String title)

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).

Parameters:

title - title

Returns:

this builder

sectionTitleLevel5

MarkupDocBuilder sectionTitleLevel5(java.lang.String title)

Builds a level 5 section title.

Parameters:

title - title

Returns:

this builder

sectionTitleWithAnchorLevel5

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

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

Parameters:

title - title

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

Returns:

this builder

sectionTitleWithAnchorLevel5

MarkupDocBuilder sectionTitleWithAnchorLevel5(java.lang.String title)

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).

Parameters:

title - title

Returns:

this builder

textLine

MarkupDocBuilder textLine(java.lang.String text)

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

Parameters:

text - text

Returns:

this builder

textLine

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

Builds a regular text line.

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

text

MarkupDocBuilder text(java.lang.String text)

Builds a regular text.

Parameters:

text - text

Returns:

this builder

paragraph

MarkupDocBuilder paragraph(java.lang.String text,
                           boolean hardbreaks)

Builds a text paragraph.

Parameters:

text - multi-line text

hardbreaks - force hardbreaks on all lines

Returns:

this builder

paragraph

MarkupDocBuilder paragraph(java.lang.String text)

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

Parameters:

text - multi-line text

Returns:

this builder

pageBreak

MarkupDocBuilder pageBreak()

Insert a page break

Returns:

this builder

block

MarkupDocBuilder block(java.lang.String text,
                       MarkupBlockStyle style,
                       java.lang.String title,
                       MarkupAdmonition admonition)

Builds a block of text with specified style.

Parameters:

text - text

style - block style

title - an optional title for the block. No title if null.

admonition - an optional admonition for the block. No admonition if null.

Returns:

this builder

block

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

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

Parameters:

text - text

style - block style

Returns:

this builder

listingBlock

MarkupDocBuilder listingBlock(java.lang.String text,
                              java.lang.String language)

Builds a source code block using the specified language.
Line breaks are respected.

Parameters:

text - multi-line text

language - source code language. Simple listing if language == null.

Returns:

this builder

listingBlock

MarkupDocBuilder listingBlock(java.lang.String text)

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

Parameters:

text - multi-line text

Returns:

this builder

literalTextLine

MarkupDocBuilder literalTextLine(java.lang.String text)

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

Parameters:

text - text

Returns:

this builder

literalTextLine

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

Builds a literal text line.

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

literalText

MarkupDocBuilder literalText(java.lang.String text)

Builds a literal text.

Parameters:

text - text

Returns:

this builder

boldTextLine

MarkupDocBuilder boldTextLine(java.lang.String text)

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

Parameters:

text - text

Returns:

this builder

boldTextLine

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

Builds a bold text line.

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

boldText

MarkupDocBuilder boldText(java.lang.String text)

Builds a bold text.

Parameters:

text - text

Returns:

this builder

italicTextLine

MarkupDocBuilder italicTextLine(java.lang.String text)

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

Parameters:

text - text

Returns:

this builder

italicTextLine

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

Builds an italic text line.

Parameters:

text - text

forceLineBreak - add an explicit line break if true.

Returns:

this builder

italicText

MarkupDocBuilder italicText(java.lang.String text)

Builds an italic text.

Parameters:

text - text

Returns:

this builder

unorderedList

MarkupDocBuilder unorderedList(java.util.List<java.lang.String> list)

Builds an unordered item list

Parameters:

list - list of items

Returns:

this builder

unorderedListItem

MarkupDocBuilder unorderedListItem(java.lang.String item)

Builds a single list item

Parameters:

item - item

Returns:

this builder

table

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

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.

Parameters:

cells - cell values

Returns:

this builder

tableWithColumnSpecs

MarkupDocBuilder tableWithColumnSpecs(java.util.List<MarkupTableColumn> columnSpecs,
                                      java.util.List<java.util.List<java.lang.String>> cells)

Builds a table with column specifiers, using specified cell values.

Parameters:

columnSpecs - list of column specifiers. Ignored if null.

cells - cell values

Returns:

this builder

anchor

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

Builds a custom anchor for later reference.
Specified anchor will be normalized anyway.
Limited support : Markdown does not support default text for anchors, and will ignore text.

Parameters:

anchor - custom anchor

text - default text to display when a cross-reference does not have text itself. Ignored if null.

Returns:

this builder

anchor

MarkupDocBuilder anchor(java.lang.String anchor)

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

Parameters:

anchor - custom anchor

Returns:

this builder

crossReferenceRaw

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

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

Parameters:

document - document to point to. Reference becomes a simple cross-reference if null.

anchor - anchor to point to

text - display text

Returns:

this builder

crossReferenceRaw

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

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

Parameters:

anchor - anchor to point to

text - display text

Returns:

this builder

crossReferenceRaw

MarkupDocBuilder crossReferenceRaw(java.lang.String anchor)

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

Parameters:

anchor - anchor to point to

Returns:

this builder

crossReference

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

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

Parameters:

document - document to point to. Reference becomes a simple cross-reference if null.

anchor - anchor to point to

text - display text

Returns:

this builder

crossReference

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

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

Parameters:

anchor - anchor to point to

text - display text

Returns:

this builder

crossReference

MarkupDocBuilder crossReference(java.lang.String anchor)

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

Parameters:

anchor - anchor to point to

Returns:

this builder

newLine

MarkupDocBuilder newLine()

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

Returns:

this builder

newLine

MarkupDocBuilder newLine(boolean forceLineBreak)

Builds a newline using System.getProperty("line.separator").

Parameters:

forceLineBreak - add an explicit line break if true.

Returns:

this builder

importMarkup

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

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

Parameters:

markupText - markup reader to read data from

markupLanguage - identify the imported markup language

Returns:

this builder

importMarkup

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

Import some markup text into this builder.
If markupLanguage is different from current builder language, markupText is converted when supported, or conversion is just ignored.
Currently supported conversions :

• Markdown -> AsciiDoc

Newlines are normalized in the process.

Parameters:

markupText - markup reader to read data from

markupLanguage - identify the imported markup language

levelOffset - adapt section leveling by adding levelOffset [-5, 5]

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - if levelOffset is too high for the imported markup

toString

java.lang.String toString()

Returns a string representation of the document.

Overrides:

toString in class java.lang.Object

withAnchorPrefix

MarkupDocBuilder withAnchorPrefix(java.lang.String prefix)

Configure this builder to prefix all generated anchors with prefix.

Parameters:

prefix - anchor prefix

Returns:

this builder

getAnchorPrefix

java.lang.String getAnchorPrefix()

Returns:

anchor prefix configuration

copy

MarkupDocBuilder copy(boolean copyBuffer)

Builds a new instance of this builder with a state copy.

Parameters:

copyBuffer - copy current buffer into the new instance

Returns:

new builder instance with a state copy

addFileExtension

java.lang.String addFileExtension(java.lang.String fileName)

Add an extension to fileName depending on markup language.

Parameters:

fileName - without extension

Returns:

fileName with an extension

addFileExtension

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

Add an extension to file depending on markup language.

Parameters:

file - without extension

Returns:

file with an extension

writeToFile

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.
An extension will be dynamically added to fileName depending on the markup language.

Parameters:

file - the generated file without extension

charset - the the charset to use for encoding

options - the file open options

writeToFileWithoutExtension

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

Writes the content of the builder to a file.

Parameters:

file - the generated file

charset - the the charset to use for encoding

options - the file open options