DoxiaDocumentRenderer (Doxia :: Sitetools 1.7.4 API)

java.lang.Object
- org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer

All Implemented Interfaces:

DocumentRenderer
```
public class DoxiaDocumentRenderer
extends Object
implements 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.

Version:

$Id: DoxiaDocumentRenderer.java 1720924 2015-12-19 13:44:56Z hboutemy $

Author:

Brett Porter

Constructor Summary

Constructors
Constructor and Description

DoxiaDocumentRenderer(RenderingContext renderingContext)
Constructor.

Constructors
Constructor and Description
`DoxiaDocumentRenderer(RenderingContext renderingContext)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getOutputName()` The name of the output document.
`RenderingContext`	`getRenderingContext()` Return the RenderingContext of the document.
`boolean`	`isExternalReport()` Whether this document is an external report.
`boolean`	`isOverwrite()` Whether to always overwrite the document, or only do so when it is changed.
`void`	`renderDocument(Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext)` Render a document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DoxiaDocumentRenderer
```
public DoxiaDocumentRenderer(RenderingContext renderingContext)
```
    Constructor.
    
    Parameters:
    renderingContext - the document's RenderingContext to use.
- Method Detail
  - renderDocument
```
public void renderDocument(Writer writer,
                  Renderer renderer,
                  SiteRenderingContext siteRenderingContext)
                    throws RendererException,
                           FileNotFoundException,
                           UnsupportedEncodingException
```
    Render a document.
    
    Specified by:
    
    renderDocument in interface DocumentRenderer
    
    Parameters:
    writer - the Writer.
    renderer - the Renderer.
    siteRenderingContext - the SiteRenderingContext.
    
    Throws:
    
    RendererException - if it bombs.
    
    FileNotFoundException - if it bombs.
    
    UnsupportedEncodingException - if it bombs.
  - getOutputName
```
public String getOutputName()
```
    The name of the output document.
    
    Specified by:
    
    getOutputName in interface DocumentRenderer
    
    Returns:
    the name of the output document.
  - getRenderingContext
```
public RenderingContext getRenderingContext()
```
    Return the RenderingContext of the document.
    
    Specified by:
    
    getRenderingContext in interface DocumentRenderer
    
    Returns:
    RenderingContext.
  - isOverwrite
```
public boolean isOverwrite()
```
    Whether to always overwrite the document, or only do so when it is changed.
    
    Specified by:
    
    isOverwrite in interface DocumentRenderer
    
    Returns:
    whether to overwrite
  - isExternalReport
```
public boolean isExternalReport()
```
    Description copied from interface: DocumentRenderer
    
    Whether this document is an external report.
    
    Specified by:
    
    isExternalReport in interface DocumentRenderer
    
    Returns:
    true if report is external, otherwise false

Class DoxiaDocumentRenderer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DoxiaDocumentRenderer

Method Detail

renderDocument

getOutputName

getRenderingContext

isOverwrite

isExternalReport