io.github.swagger2markup.markup.builder.internal.markdown

Class MarkdownBuilder

java.lang.Object

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

io.github.swagger2markup.markup.builder.internal.markdown.MarkdownBuilder

All Implemented Interfaces:

MarkupDocBuilder

public class MarkdownBuilder
extends AbstractMarkupDocBuilder

Field Summary

Fields inherited from class io.github.swagger2markup.markup.builder.internal.AbstractMarkupDocBuilder

ANCHOR_IGNORABLE_PATTERN, ANCHOR_SEPARATION_CHARACTERS, ANCHOR_UNIGNORABLE_PATTERN, anchorPrefix, documentBuilder, LINE_BREAK_DEFAULT, logger, MAX_TITLE_LEVEL, NEW_LINES, newLine, WHITESPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	addFileExtension(java.lang.String fileName) Add an extension to fileName depending on markup language.
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, 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	copy(boolean copyBuffer) Builds a new instance of this builder with a state copy.
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 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.
protected MarkupLanguage	getMarkupLanguage()
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	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	newLine(boolean forceLineBreak) Builds a newline using System.getProperty("line.separator").
MarkupDocBuilder	pageBreak() Insert a page break
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	sectionTitleWithAnchorLevel(int level, java.lang.String title, java.lang.String anchor) Builds a section title with a custom anchor for later reference.
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	unorderedList(java.util.List<java.lang.String> list) Builds an unordered item list
MarkupDocBuilder	unorderedListItem(java.lang.String item) Builds a single list item

Methods inherited from class io.github.swagger2markup.markup.builder.internal.AbstractMarkupDocBuilder

addFileExtension, anchor, block, boldText, boldTextLine, boldTextLine, convert, crossReference, crossReference, crossReferenceRaw, crossReferenceRaw, delimitedBlockText, delimitedBlockText, delimitedBlockText, delimitedTextWithoutLineBreaks, delimitedTextWithoutLineBreaks, documentTitle, getAnchorPrefix, importMarkup, importMarkupStyle1, importMarkupStyle2, italicText, italicTextLine, italicTextLine, listingBlock, literalText, literalTextLine, literalTextLine, newLine, newLine, normalizeAnchor, paragraph, replaceNewLines, replaceNewLines, replaceNewLinesWithWhiteSpace, sectionTitleLevel, sectionTitleLevel1, sectionTitleLevel2, sectionTitleLevel3, sectionTitleLevel4, sectionTitleLevel5, sectionTitleWithAnchorLevel, sectionTitleWithAnchorLevel, sectionTitleWithAnchorLevel1, sectionTitleWithAnchorLevel1, sectionTitleWithAnchorLevel2, sectionTitleWithAnchorLevel2, sectionTitleWithAnchorLevel3, sectionTitleWithAnchorLevel3, sectionTitleWithAnchorLevel4, sectionTitleWithAnchorLevel4, sectionTitleWithAnchorLevel5, sectionTitleWithAnchorLevel5, table, text, textLine, textLine, toString, unorderedList, unorderedListItem, withAnchorPrefix, writeToFile, writeToFileWithoutExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownBuilder

public MarkdownBuilder()

MarkdownBuilder

public MarkdownBuilder(java.lang.String newLine)

Method Detail

getMarkupLanguage

protected MarkupLanguage getMarkupLanguage()

Specified by:

getMarkupLanguage in class AbstractMarkupDocBuilder

copy

public MarkupDocBuilder copy(boolean copyBuffer)

Description copied from interface: MarkupDocBuilder

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

documentTitle

public MarkupDocBuilder documentTitle(java.lang.String title)

Description copied from interface: MarkupDocBuilder

Builds a document section title.

Parameters:

title - title

Returns:

this builder

sectionTitleLevel

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

Description copied from interface: MarkupDocBuilder

Builds a section title.

Parameters:

level - section title level [1, 5]

title - title

Returns:

this builder

sectionTitleWithAnchorLevel

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

Description copied from interface: MarkupDocBuilder

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

Parameters:

level - section title level [1, 5]

title - title

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

Returns:

this builder

paragraph

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

Description copied from interface: MarkupDocBuilder

Builds a text paragraph.

Parameters:

text - multi-line text

hardbreaks - force hardbreaks on all lines

Returns:

this builder

pageBreak

public MarkupDocBuilder pageBreak()

Description copied from interface: MarkupDocBuilder

Insert a page break

Returns:

this builder

block

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

Description copied from interface: MarkupDocBuilder

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

listingBlock

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

Description copied from interface: MarkupDocBuilder

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

literalText

public MarkupDocBuilder literalText(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a literal text.

Parameters:

text - text

Returns:

this builder

boldText

public MarkupDocBuilder boldText(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds a bold text.

Parameters:

text - text

Returns:

this builder

italicText

public MarkupDocBuilder italicText(java.lang.String text)

Description copied from interface: MarkupDocBuilder

Builds an italic text.

Parameters:

text - text

Returns:

this builder

unorderedList

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

Description copied from interface: MarkupDocBuilder

Builds an unordered item list

Parameters:

list - list of items

Returns:

this builder

unorderedListItem

public MarkupDocBuilder unorderedListItem(java.lang.String item)

Description copied from interface: MarkupDocBuilder

Builds a single list item

Parameters:

item - item

Returns:

this builder

anchor

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

Description copied from interface: MarkupDocBuilder

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

crossReferenceRaw

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

Description copied from interface: MarkupDocBuilder

Builds an inter-document cross-reference to document#anchor with specified text.
This is the "raw anchor" version. Use the preferred method MarkupDocBuilder.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

crossReference

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

Description copied from interface: MarkupDocBuilder

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

tableWithColumnSpecs

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

Description copied from interface: MarkupDocBuilder

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

newLine

public MarkupDocBuilder newLine(boolean forceLineBreak)

Description copied from interface: MarkupDocBuilder

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

Parameters:

forceLineBreak - add an explicit line break if true.

Returns:

this builder

importMarkup

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

Description copied from interface: MarkupDocBuilder

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

addFileExtension

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

Description copied from interface: MarkupDocBuilder

Add an extension to fileName depending on markup language.

Parameters:

fileName - without extension

Returns:

fileName with an extension