io.github.robwin.markup.builder

Class AbstractMarkupDocBuilder

java.lang.Object

io.github.robwin.markup.builder.AbstractMarkupDocBuilder

All Implemented Interfaces:

MarkupDocBuilder

Direct Known Subclasses:

AsciiDocBuilder, MarkdownBuilder

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.StringBuilder	documentBuilder
protected org.slf4j.Logger	logger
protected java.lang.String	newLine

Constructor Summary

Constructors

Constructor and Description
AbstractMarkupDocBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	boldTextLine(Markup markup, java.lang.String text)
protected void	delimitedTextLine(Markup markup, java.lang.String text)
protected void	delimitedTextLineWithoutLineBreaks(Markup markup, java.lang.String text)
protected void	documentTitle(Markup markup, java.lang.String title)
protected void	documentTitleWithAttributes(Markup markup, java.lang.String title)
protected void	italicTextLine(Markup markup, java.lang.String text)
protected void	listing(Markup markup, java.lang.String text)
MarkupDocBuilder	newLine()
protected void	paragraph(Markup markup, java.lang.String text)
protected void	preserveLineBreaks(Markup markup)
protected void	sectionTitleLevel1(Markup markup, java.lang.String title)
protected void	sectionTitleLevel2(Markup markup, java.lang.String title)
protected void	sectionTitleLevel3(Markup markup, java.lang.String title)
protected void	sectionTitleLevel4(Markup markup, java.lang.String title)
MarkupDocBuilder	textLine(java.lang.String text)
java.lang.String	toString() Returns a string representation of the document.
protected void	unorderedList(Markup markup, java.util.List<java.lang.String> list)
void	writeToFile(java.lang.String directory, java.lang.String fileNameWithExtension, java.nio.charset.Charset charset) Writes the content of the builder to a file and clears the builder.

Methods inherited from class java.lang.Object

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

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

boldTextLine, crossReference, documentTitle, documentTitleWithAttributes, italicTextLine, listing, paragraph, sectionTitleLevel1, sectionTitleLevel2, sectionTitleLevel3, sectionTitleLevel4, source, tableWithHeaderRow, unorderedList

Field Detail

documentBuilder

protected java.lang.StringBuilder documentBuilder

newLine

protected java.lang.String newLine

logger

protected org.slf4j.Logger logger

Constructor Detail

AbstractMarkupDocBuilder

public AbstractMarkupDocBuilder()

Method Detail

documentTitle

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

documentTitleWithAttributes

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

sectionTitleLevel1

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

sectionTitleLevel2

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

sectionTitleLevel3

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

sectionTitleLevel4

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

textLine

public MarkupDocBuilder textLine(java.lang.String text)

Specified by:

textLine in interface MarkupDocBuilder

paragraph

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

listing

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

delimitedTextLine

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

delimitedTextLineWithoutLineBreaks

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

preserveLineBreaks

protected void preserveLineBreaks(Markup markup)

boldTextLine

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

italicTextLine

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

unorderedList

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

newLine

public MarkupDocBuilder newLine()

Specified by:

newLine in interface MarkupDocBuilder

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

writeToFile

public void writeToFile(java.lang.String directory,
               java.lang.String fileNameWithExtension,
               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

Parameters:

directory - the directory where the generated file should be stored

fileNameWithExtension - the name of the file

charset - the the charset to use for encoding

Throws:

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