org.apache.maven.doxia.siterenderer

Interface DocumentRenderer

All Known Implementing Classes:

DoxiaDocumentRenderer

public interface DocumentRenderer

Renders a page in a site, whatever the source is: a Doxia source file, a report or anything else.

Author:

Brett Porter

See Also:

document rendering context

Method Summary

Modifier and Type	Method and Description
String	getOutputName() Deprecated. Method name does not properly reflect its purpose. Implement and use getOutputPath() instead.
default String	getOutputPath() The output path of the 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.

Method Detail

renderDocument

void renderDocument(Writer writer,
                    SiteRenderer siteRenderer,
                    SiteRenderingContext siteRenderingContext)
             throws IOException,
                    RendererException

Render a document in a site.

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.

IOException - if it bombs.

getOutputPath

default String getOutputPath()

The output path of the document.

Note: This method won't be default anymore when getOutputName() is removed. You are advised to implement it as soon as possible.

Returns:

the name of the output document.

Since:

2.0.0

getOutputName

@Deprecated
String getOutputName()

Deprecated. Method name does not properly reflect its purpose. Implement and use getOutputPath() instead.

getRenderingContext

DocumentRenderingContext getRenderingContext()

Return the rendering context of the document.

Returns:

DocumentRenderingContext.

isOverwrite

boolean isOverwrite()

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

Returns:

whether to overwrite

isExternalReport

boolean isExternalReport()

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

Returns:

true if report is external, otherwise false

Since:

1.7