Package org.ctan.markup.markdown

Class MarkdownWriter

java.lang.Object

java.io.Writer

org.ctan.markup.markdown.MarkdownWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class MarkdownWriter
extends Writer

This class provides a writer which allows to link in deferred defined contents.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
MarkdownWriter(Writer out)	This is the constructor for MarkdownWriter.

Method Summary

Modifier and Type	Method	Description
void	close()
void	defineReference(String key, String url, String text)	This method stores a definition for a reference and flushes the output as much as possible.
void	flush()
String[]	getReference(String key)	The method getReference provides means to retrieve a reference.
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	writeEscaped(int c)	This method writes a character to out and escapes HTML entities.
void	writeReference(String key)	This method places a reference on the output.
void	writeReferenceText(String key)	This method places a reference text on the output.

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

MarkdownWriter

public MarkdownWriter(Writer out)

This is the constructor for MarkdownWriter.

Parameters:

out - the target writer

Method Details

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

See Also:

• Writer.close()

defineReference

public void defineReference(String key,
 String url,
 String text)
                     throws IOException

This method stores a definition for a reference and flushes the output as much as possible.

Parameters:

key - the key

url - the URL

text - the text

Throws:

IOException - in case of an I/O error

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

See Also:

• Writer.flush()

getReference

public String[] getReference(String key)

The method getReference provides means to retrieve a reference.

Parameters:

key - the key

Returns:

the value of the reference or null for none

write

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

Specified by:

write in class Writer

Throws:

IOException

See Also:

• Writer.write(char[], int, int)

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

See Also:

• BufferedWriter.write(int)

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

See Also:

• Writer.write(java.lang.String)

writeEscaped

public void writeEscaped(int c)
                  throws IOException

This method writes a character to out and escapes HTML entities.

Parameters:

c - the character code

Throws:

IOException - in case of an I/O error

writeReference

public void writeReference(String key)
                    throws IOException

This method places a reference on the output.

Parameters:

key - the key

Throws:

IOException - in case of an I/O error

writeReferenceText

public void writeReferenceText(String key)
                        throws IOException

This method places a reference text on the output.

Parameters:

key - the key

Throws:

IOException - in case of an I/O error