io.github.robwin.markup.builder

Interface MarkupDocBuilder

All Known Implementing Classes:

AbstractMarkupDocBuilder, AsciiDocBuilder, MarkdownBuilder

public interface MarkupDocBuilder

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	newLine()
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	textLine(java.lang.String text)
java.lang.String	toString() Returns a string representation of the document.
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.

Method Detail

documentTitle

MarkupDocBuilder documentTitle(java.lang.String title)

documentTitleWithAttributes

MarkupDocBuilder documentTitleWithAttributes(java.lang.String title)

sectionTitleLevel1

MarkupDocBuilder sectionTitleLevel1(java.lang.String title)

sectionTitleLevel2

MarkupDocBuilder sectionTitleLevel2(java.lang.String title)

sectionTitleLevel3

MarkupDocBuilder sectionTitleLevel3(java.lang.String title)

sectionTitleLevel4

MarkupDocBuilder sectionTitleLevel4(java.lang.String title)

textLine

MarkupDocBuilder textLine(java.lang.String text)

paragraph

MarkupDocBuilder paragraph(java.lang.String text)

listing

MarkupDocBuilder listing(java.lang.String text)

source

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

boldTextLine

MarkupDocBuilder boldTextLine(java.lang.String text)

italicTextLine

MarkupDocBuilder italicTextLine(java.lang.String text)

unorderedList

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

tableWithHeaderRow

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

crossReference

MarkupDocBuilder crossReference(java.lang.String text)

newLine

MarkupDocBuilder newLine()

toString

java.lang.String toString()

Returns a string representation of the document.

Overrides:

toString in class java.lang.Object

writeToFile

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

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

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