Class RenderUtils

java.lang.Object

io.github.kelsoncm.fwf.renders.RenderUtils

public final class RenderUtils
extends Object

Utility class to export layout specifications of a FileDescriptor into Markdown, ReStructuredText (RST), and HTML tables.

Method Summary

Modifier and Type	Method	Description
static void	renderAsHtml(FileDescriptor fileDescriptor, Writer out)	Renders the layout specification of a FileDescriptor as HTML tables into a Writer.
static void	renderAsMarkdown(FileDescriptor fileDescriptor, Writer out)	Renders the layout specification of a FileDescriptor as Markdown tables into a Writer.
static void	renderAsRst(FileDescriptor fileDescriptor, Writer out)	Renders the layout specification of a FileDescriptor as ReStructuredText (RST) tables into a Writer.

Methods inherited from class Object

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

Method Details

renderAsMarkdown

public static void renderAsMarkdown(FileDescriptor fileDescriptor,
 Writer out)
                             throws IOException

Renders the layout specification of a FileDescriptor as Markdown tables into a Writer.

Parameters:

fileDescriptor - the layout descriptor to render

out - destination writer

Throws:

IOException - if an I/O error occurs

renderAsRst

public static void renderAsRst(FileDescriptor fileDescriptor,
 Writer out)
                        throws IOException

Renders the layout specification of a FileDescriptor as ReStructuredText (RST) tables into a Writer.

Parameters:

fileDescriptor - the layout descriptor to render

out - destination writer

Throws:

IOException - if an I/O error occurs

renderAsHtml

public static void renderAsHtml(FileDescriptor fileDescriptor,
 Writer out)
                         throws IOException

Renders the layout specification of a FileDescriptor as HTML tables into a Writer.

Parameters:

fileDescriptor - the layout descriptor to render

out - destination writer

Throws:

IOException - if an I/O error occurs