org.apache.maven.doxia.siterenderer
Class DoxiaDocumentRenderer

java.lang.Object
  org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer

All Implemented Interfaces:

DocumentRenderer

public class DoxiaDocumentRenderer
extends Object
implements DocumentRenderer

Renders a page with Doxia.

Version:

$Id: DoxiaDocumentRenderer.java 746999 2009-02-23 12:56:04Z vsiveton $

Author:

Brett Porter

Constructor Summary

DoxiaDocumentRenderer(RenderingContext renderingContext)
Constructor.

Method Summary

String	getOutputName() The name of the output document.
RenderingContext	getRenderingContext() Return the RenderingContext.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoxiaDocumentRenderer

public DoxiaDocumentRenderer(RenderingContext renderingContext)

Constructor.

Parameters:

renderingContext - the RenderingContext to use.

Method Detail

renderDocument

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

Render a document.

Specified by:

renderDocument in interface DocumentRenderer

Parameters:

writer - the Writer.

renderer - the Renderer.

siteRenderingContext - the SiteRenderingContext.

Throws:

RendererException - if it bombs.

FileNotFoundException - if it bombs.

UnsupportedEncodingException - if it bombs.

getOutputName

public String getOutputName()

The name of the output document.

Specified by:

getOutputName in interface DocumentRenderer

Returns:

the name of the output document.

getRenderingContext

public RenderingContext getRenderingContext()

Return the RenderingContext.

Specified by:

getRenderingContext in interface DocumentRenderer

Returns:

RenderingContext.

isOverwrite

public boolean isOverwrite()

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

Specified by:

isOverwrite in interface DocumentRenderer

Returns:

whether to overwrite