org.apache.maven.doxia.siterenderer

Interface DocumentRenderer

All Known Implementing Classes:

DoxiaDocumentRenderer

public interface DocumentRenderer

Renders a page.

Version:

$Id: DocumentRenderer.java 1588724 2014-04-20 08:13:14Z hboutemy $

Author:

Brett Porter

Method Summary

Methods

Modifier and Type	Method and Description
String	getOutputName() The name of the output document.
RenderingContext	getRenderingContext() Return the RenderingContext of the document.
boolean	isOverwrite() Whether to always overwrite the document, or only do so when it is changed.
void	renderDocument(Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext) Render a document.

Method Detail

renderDocument

void renderDocument(Writer writer,
                  Renderer renderer,
                  SiteRenderingContext siteRenderingContext)
                    throws RendererException,
                           FileNotFoundException,
                           UnsupportedEncodingException

Render a document.

Parameters:

writer - the Writer.

renderer - the Renderer.

siteRenderingContext - the SiteRenderingContext.

Throws:

RendererException - if it bombs.

FileNotFoundException - if it bombs.

UnsupportedEncodingException - if it bombs.

getOutputName

String getOutputName()

The name of the output document.

Returns:

the name of the output document.

getRenderingContext

RenderingContext getRenderingContext()

Return the RenderingContext of the document.

Returns:

RenderingContext.

isOverwrite

boolean isOverwrite()

Whether to always overwrite the document, or only do so when it is changed.

Returns:

whether to overwrite