Class DoxiaDocumentRenderer
- java.lang.Object
-
- org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer
-
- All Implemented Interfaces:
DocumentRenderer
public class DoxiaDocumentRenderer extends java.lang.Object implements DocumentRenderer
Renderer for a document that has a source file to be parsed by Doxia. Details about the source file are inDocumentRenderingContext
, which is expected to have a non-null parserId and extension.- Author:
- Brett Porter
-
-
Constructor Summary
Constructors Constructor Description DoxiaDocumentRenderer(DocumentRenderingContext docRenderingContext)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getOutputName()
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(java.io.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 Detail
-
DoxiaDocumentRenderer
public DoxiaDocumentRenderer(DocumentRenderingContext docRenderingContext)
Constructor.- Parameters:
docRenderingContext
- the document's rendering context to use.
-
-
Method Detail
-
renderDocument
public void renderDocument(java.io.Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext) throws java.io.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:
java.io.IOException
- if it bombs.RendererException
- if it bombs.
-
getOutputName
public java.lang.String getOutputName()
- Specified by:
getOutputName
in interfaceDocumentRenderer
-
getRenderingContext
public DocumentRenderingContext 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
-
-