org.apache.maven.doxia.siterenderer

Interface Renderer

Known Implementing Classes:
DefaultSiteRenderer

public interface Renderer

Version:
$Id:Renderer.java 348612 2005-11-24 12:54:19 +1100 (Thu, 24 Nov 2005) brett $
Author:

Field Summary

static String
ROLE

Method Summary

SiteRendererSink
createSink(File moduleBaseDir, String document)
void
generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteContext)
void
render(File siteDirectory, File outputDirectory, String module, String moduleExtension, String moduleParserId, SiteRenderingContext context, String outputEncoding)
void
render(File siteDirectory, File outputDirectory, SiteRenderingContext context)
void
render(File siteDirectory, File outputDirectory, SiteRenderingContext context, String outputEncoding)

Field Details

ROLE

public static final String ROLE

Method Details

createSink

public SiteRendererSink createSink(File moduleBaseDir,
                                   String document)
            throws RendererException,
                   IOException

generateDocument

public void generateDocument(Writer writer,
                             SiteRendererSink sink,
                             SiteRenderingContext siteContext)
            throws RendererException

render

public void render(File siteDirectory,
                   File outputDirectory,
                   String module,
                   String moduleExtension,
                   String moduleParserId,
                   SiteRenderingContext context,
                   String outputEncoding)
            throws RendererException,
                   IOException

render

public void render(File siteDirectory,
                   File outputDirectory,
                   SiteRenderingContext context)
            throws RendererException,
                   IOException

render

public void render(File siteDirectory,
                   File outputDirectory,
                   SiteRenderingContext context,
                   String outputEncoding)
            throws RendererException,
                   IOException