Package org.tealeaf.javamarkdown

Class MarkdownWriter

java.lang.Object

java.io.Writer

org.tealeaf.javamarkdown.MarkdownWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, MarkdownCompiler<MarkdownWriter>

public class MarkdownWriter
extends Writer
implements MarkdownCompiler<MarkdownWriter>

A builder, or writer, that implements methods for appending markdown elements, as well as the ability to directly append markdown elements

Since:

0.0.9

Author:

Thomas Kwashnak

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
MarkdownWriter()	Creates a new MarkdownWriter, using a new StringWriter to handle the writing functionality.
MarkdownWriter(Writer writer)	Creates a new MarkdownBuilder with a preset Writer.

Method Summary

Modifier and Type	Method	Description
MarkdownWriter	appendMarkdownElement(MarkdownElement markdownElement)	Appends a markdown element to the end of the document.
MarkdownWriter	appendString(String string)	Writes a string to the writer
void	close()
void	flush()
char	getLastChar()
Writer	getWriter()	Gets the writer used to handle core functionality
String	toString()
void	write(char[] cbuf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write, write, write

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

append, 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

Constructor Details

MarkdownWriter

public MarkdownWriter()

Creates a new MarkdownWriter, using a new StringWriter to handle the writing functionality.

Since:

0.0.7

MarkdownWriter

public MarkdownWriter(Writer writer)

Creates a new MarkdownBuilder with a preset Writer. The Writer is used as the back-end functionality. Any appending method used will append the proper string to the Writer

Parameters:

writer - Writer to write objects to

Since:

0.0.8

Method Details

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Updates the last written character value for use in appendMarkdownElement(MarkdownElement)

Specified by:

write in class Writer

Throws:

IOException - If an I/O error occurs

Since:

0.0.7

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException - If an I/O error occurs

Since:

0.0.7

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException - If an I/O error occurs

Since:

0.0.7

appendString

public MarkdownWriter appendString(String string)

Writes a string to the writer

This method allows the forcing of writing a String that would otherwise be using Writer.append(CharSequence), which returns a Writer instead of a MarkdownWriter.

Specified by:

appendString in interface MarkdownCompiler<MarkdownWriter>

Parameters:

string - String to print to the writer

Returns:

A reference to this Writer

Since:

0.0.9

appendMarkdownElement

public MarkdownWriter appendMarkdownElement(MarkdownElement markdownElement)

Description copied from interface: MarkdownCompiler

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<MarkdownWriter>

Parameters:

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

Returns:

An instance of the MarkdownCompiler used

Since:

0.0.9

See Also:

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

getWriter

public Writer getWriter()

Gets the writer used to handle core functionality

Returns:

The writer used for functionality

Since:

0.0.9

getLastChar

public char getLastChar()

toString

public String toString()

Overrides:

toString in class Object