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

Renderer for a document that has a source file to be parsed by Doxia. Details about the source file are in DocumentRenderingContext, which is expected to have a non-null parserId and extension.

Author:

Brett Porter

Constructor Summary

Constructors

Constructor and Description
DoxiaDocumentRenderer(DocumentRenderingContext docRenderingContext) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getOutputName() The name of the output document.
DocumentRenderingContext	getRenderingContext() Return the rendering context of the document.
boolean	isExternalReport() Whether this document is an external report, independent from the site templating.
boolean	isOverwrite() Whether to always overwrite the document, or only do so when it is changed.
void	renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext) Render a document in a site.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoxiaDocumentRenderer

public DoxiaDocumentRenderer(DocumentRenderingContext docRenderingContext)

Constructor.

Parameters:

docRenderingContext - the document's rendering context to use.

Method Detail

renderDocument

public void renderDocument(Writer writer,
                           SiteRenderer siteRenderer,
                           SiteRenderingContext siteRenderingContext)
                    throws RendererException,
                           FileNotFoundException,
                           UnsupportedEncodingException

Render a document in a site.

Specified by:

renderDocument in interface DocumentRenderer

Parameters:

writer - the Writer for the document output.

siteRenderer - the site renderer to merge document content to.

siteRenderingContext - the site rendering context.

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 DocumentRenderingContext getRenderingContext()

Return the rendering context of the document.

Specified by:

getRenderingContext in interface DocumentRenderer

Returns:

DocumentRenderingContext.

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

isExternalReport

public boolean isExternalReport()

Description copied from interface: DocumentRenderer

Whether this document is an external report, independent from the site templating.

Specified by:

isExternalReport in interface DocumentRenderer

Returns:

true if report is external, otherwise false