org.apache.maven.doxia.siterenderer
Interface DocumentRenderer

All Known Implementing Classes:
DoxiaDocumentRenderer

public interface DocumentRenderer

Renders a page.

Author:
Brett Porter

Method Summary
 java.lang.String getOutputName()
           
 org.apache.maven.doxia.module.xhtml.decoration.render.RenderingContext getRenderingContext()
           
 boolean isOverwrite()
          Whether to always overwrite the document, or only do so when it is changed.
 void renderDocument(java.io.Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext)
           
 

Method Detail

renderDocument

void renderDocument(java.io.Writer writer,
                    Renderer renderer,
                    SiteRenderingContext siteRenderingContext)
                    throws RendererException,
                           java.io.FileNotFoundException,
                           java.io.UnsupportedEncodingException
Throws:
RendererException
java.io.FileNotFoundException
java.io.UnsupportedEncodingException

getOutputName

java.lang.String getOutputName()

getRenderingContext

org.apache.maven.doxia.module.xhtml.decoration.render.RenderingContext getRenderingContext()

isOverwrite

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

Returns:
whether to overwrite