Class DoxiaDocumentRenderer
java.lang.Object
org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
- All Implemented Interfaces:
DocumentRenderer
Renderer for a document that has a source file to be parsed by Doxia.
Details about the source file are in
RenderingContext
, which is expected to have
a non-null parserId and extension.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe name of the output document.Return the RenderingContext of the document.boolean
Whether this document is an external report, independent from the site templating.boolean
Whether to always overwrite the document, or only do so when it is changed.void
renderDocument
(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) Render a document in a site.
-
Field Details
-
renderingContext
-
-
Constructor Details
-
DoxiaDocumentRenderer
Constructor.- Parameters:
renderingContext
- the document's RenderingContext to use.
-
-
Method Details
-
renderDocument
public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException Render a document in a site.- Specified by:
renderDocument
in interfaceDocumentRenderer
- 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
The name of the output document.- Specified by:
getOutputName
in interfaceDocumentRenderer
- Returns:
- the name of the output document.
-
getRenderingContext
Return the RenderingContext of the document.- Specified by:
getRenderingContext
in interfaceDocumentRenderer
- Returns:
- RenderingContext.
-
isOverwrite
public boolean isOverwrite()Whether to always overwrite the document, or only do so when it is changed.- Specified by:
isOverwrite
in interfaceDocumentRenderer
- 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 interfaceDocumentRenderer
- Returns:
true
if report is external, otherwisefalse
-