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
DocumentRenderingContext
, which is expected to have
a non-null parserId and extension.- Author:
- Brett Porter
-
Constructor Summary
ConstructorsConstructorDescriptionDoxiaDocumentRenderer
(DocumentRenderingContext docRenderingContext) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionReturn the rendering context 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, 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
Methods inherited from interface org.apache.maven.doxia.siterenderer.DocumentRenderer
getOutputPath
-
Constructor Details
-
DoxiaDocumentRenderer
Constructor.- Parameters:
docRenderingContext
- the document's rendering context to use.
-
-
Method Details
-
renderDocument
public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext) throws IOException, RendererException 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:
IOException
- if it bombs.RendererException
- if it bombs.
-
getOutputName
- Specified by:
getOutputName
in interfaceDocumentRenderer
-
getRenderingContext
Return the rendering context of the document.- Specified by:
getRenderingContext
in interfaceDocumentRenderer
- Returns:
- DocumentRenderingContext.
-
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
-