io.github.robwin.markup.builder.markdown

Class MarkdownBuilder

java.lang.Object

io.github.robwin.markup.builder.AbstractMarkupDocBuilder

io.github.robwin.markup.builder.markdown.MarkdownBuilder

All Implemented Interfaces:

MarkupDocBuilder

public class MarkdownBuilder
extends AbstractMarkupDocBuilder

Field Summary

Fields inherited from class io.github.robwin.markup.builder.AbstractMarkupDocBuilder

documentBuilder, logger, newLine

Constructor Summary

Constructors

Constructor and Description
MarkdownBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
MarkupDocBuilder	boldTextLine(java.lang.String text)
MarkupDocBuilder	crossReference(java.lang.String text)
MarkupDocBuilder	documentTitle(java.lang.String title)
MarkupDocBuilder	documentTitleWithAttributes(java.lang.String title)
MarkupDocBuilder	italicTextLine(java.lang.String text)
MarkupDocBuilder	listing(java.lang.String text)
MarkupDocBuilder	paragraph(java.lang.String text)
MarkupDocBuilder	sectionTitleLevel1(java.lang.String title)
MarkupDocBuilder	sectionTitleLevel2(java.lang.String title)
MarkupDocBuilder	sectionTitleLevel3(java.lang.String title)
MarkupDocBuilder	sectionTitleLevel4(java.lang.String title)
MarkupDocBuilder	source(java.lang.String text, java.lang.String language)
MarkupDocBuilder	tableWithHeaderRow(java.util.List<java.lang.String> rowsInPSV)
MarkupDocBuilder	unorderedList(java.util.List<java.lang.String> list)
void	writeToFile(java.lang.String directory, java.lang.String fileName, java.nio.charset.Charset charset) Writes the content of the builder to a file and clears the builder.

Methods inherited from class io.github.robwin.markup.builder.AbstractMarkupDocBuilder

boldTextLine, delimitedTextLine, delimitedTextLineWithoutLineBreaks, documentTitle, documentTitleWithAttributes, italicTextLine, listing, newLine, paragraph, preserveLineBreaks, sectionTitleLevel1, sectionTitleLevel2, sectionTitleLevel3, sectionTitleLevel4, textLine, toString, unorderedList

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownBuilder

public MarkdownBuilder()

Method Detail

documentTitle

public MarkupDocBuilder documentTitle(java.lang.String title)

documentTitleWithAttributes

public MarkupDocBuilder documentTitleWithAttributes(java.lang.String title)

sectionTitleLevel1

public MarkupDocBuilder sectionTitleLevel1(java.lang.String title)

sectionTitleLevel2

public MarkupDocBuilder sectionTitleLevel2(java.lang.String title)

sectionTitleLevel3

public MarkupDocBuilder sectionTitleLevel3(java.lang.String title)

sectionTitleLevel4

public MarkupDocBuilder sectionTitleLevel4(java.lang.String title)

paragraph

public MarkupDocBuilder paragraph(java.lang.String text)

listing

public MarkupDocBuilder listing(java.lang.String text)

source

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

boldTextLine

public MarkupDocBuilder boldTextLine(java.lang.String text)

italicTextLine

public MarkupDocBuilder italicTextLine(java.lang.String text)

unorderedList

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

tableWithHeaderRow

public MarkupDocBuilder tableWithHeaderRow(java.util.List<java.lang.String> rowsInPSV)

crossReference

public MarkupDocBuilder crossReference(java.lang.String text)

writeToFile

public void writeToFile(java.lang.String directory,
               java.lang.String fileName,
               java.nio.charset.Charset charset)
                 throws java.io.IOException

Description copied from interface: MarkupDocBuilder

Writes the content of the builder to a file and clears the builder.

Specified by:

writeToFile in interface MarkupDocBuilder

Overrides:

writeToFile in class AbstractMarkupDocBuilder

Parameters:

directory - the directory where the generated file should be stored

fileName - the name of the file

charset - the the charset to use for encoding

Throws:

java.io.IOException - if the file cannot be written