Package org.tealeaf.javamarkdown

Class MarkdownBuffer

java.lang.Object

org.tealeaf.javamarkdown.MarkdownBuffer

All Implemented Interfaces:

MarkdownCompiler<MarkdownBuffer>

public class MarkdownBuffer
extends Object
implements MarkdownCompiler<MarkdownBuffer>

A MarkdownCompiler that first takes all objects passed in and compiles it to an array, only rendering them when requested.

Since:

0.0.14

Author:

Thomas Kwashnak

Field Summary

Fields

Modifier and Type	Field	Description
protected final LinkedList<Object>	items

Constructor Summary

Constructors

Constructor	Description
MarkdownBuffer()

Method Summary

Modifier and Type	Method	Description
MarkdownBuffer	append(Object object)	Appends any given object to the end of the document.
MarkdownBuffer	appendMarkdownBuffer(MarkdownBuffer markdownBuffer)	Unpacks another markdown buffer and appends each item to the end of the list
MarkdownBuffer	appendMarkdownElement(MarkdownElement element)	Appends a markdown element to the end of the document.
MarkdownBuffer	appendString(String string)	Appends a string to the end of the document.
String	toString()
<T extends Writer> T	toWriter(T writer)	Attempts to render and write all objects to a Writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tealeaf.javamarkdown.MarkdownCompiler

appendBold, appendBulletList, appendBulletList, appendBulletList, appendBulletList, appendBulletList, appendBulletList, appendCode, appendCodeBlock, appendCodeBlock, appendHeader, appendHeader, appendImage, appendImage, appendItalic, appendLink, appendLink, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendNumberedList, appendStrikethrough, appendTable, appendTable

Field Details

items

protected final LinkedList<Object> items

Constructor Details

MarkdownBuffer

public MarkdownBuffer()

Method Details

appendString

public MarkdownBuffer appendString(String string)

Appends a string to the end of the document.

Specified by:

appendString in interface MarkdownCompiler<MarkdownBuffer>

Parameters:

string - String to append to the end of the document

Returns:

An instance of the MarkdownCompiler used

Since:

0.0.14

append

public MarkdownBuffer append(Object object)

Appends any given object to the end of the document. Checks what type of object was passed and uses the correct method accordingly

• If the object provided extends the MarkdownElement class, then this method will use MarkdownCompiler.appendMarkdownElement(MarkdownElement) to handle adding the element to the document.
• Otherwise, this method will use MarkdownCompiler.appendString(String) and pass the Object.toString() result as the string.

If another MarkdownBuffer object is passed, this buffer will use appendMarkdownBuffer(MarkdownBuffer) to append its contents

Specified by:

append in interface MarkdownCompiler<MarkdownBuffer>

Parameters:

object - Content to add to the end of the document

Returns:

An instance of the MarkdownCompiler used

Since:

0.0.15

See Also:

• MarkdownCompiler.appendString(String)
• MarkdownCompiler.appendMarkdownElement(MarkdownElement)

appendMarkdownElement

public MarkdownBuffer appendMarkdownElement(MarkdownElement element)

Appends a markdown element to the end of the document. Adjusts and manages new lines depending on the requirements set by the Markdown Element

Specified by:

appendMarkdownElement in interface MarkdownCompiler<MarkdownBuffer>

Parameters:

element - Markdown Element to add to the end of the document

Returns:

An instance of the MarkdownCompiler used

Since:

0.0.14

See Also:

• MarkdownElement.requiresNewlineBefore()
• MarkdownElement.requiresNewlineAfter()

appendMarkdownBuffer

public MarkdownBuffer appendMarkdownBuffer(MarkdownBuffer markdownBuffer)

Unpacks another markdown buffer and appends each item to the end of the list

Parameters:

markdownBuffer - MarkdownBuffer to unpack

Returns:

A reference to the final Markdown Buffer

Since:

0.0.15

toString

public String toString()

Overrides:

toString in class Object

Since:

0.0.14

toWriter

public <T extends Writer> T toWriter(T writer)

Attempts to render and write all objects to a Writer.

Type Parameters:

T - The writer's original type, which should extend the Writer class

Parameters:

writer - The writer itself

Returns:

The writer after attempting to write the objects to the writer

Since:

0.0.14