Package org.apache.maven.doxia.docrenderer

## Interface DocumentRenderer

All Known Subinterfaces:
  `PdfRenderer`

All Known Implementing Classes:
  `AbstractDocumentRenderer`, `AbstractPdfRenderer`, `FoPdfRenderer`, `ITextPdfRenderer`

    public interface DocumentRenderer

Base interface for rendering documents from a set of input files.

Since:
  1.1
Version:
  $Id: DocumentRenderer.java 1670514 2015-03-31 23:10:01Z hboutemy $
Author:
  Vincent Siveton, ltheussl

### Field Summary

Fields
`static java.lang.String` `ROLE` Plexus lookup role.

### Method Summary

All Methods Instance Methods Abstract Methods
`java.lang.String` `getOutputExtension()` Get the output extension associated with this DocumentRenderer.
`org.apache.maven.doxia.document.DocumentModel` `readDocumentModel​(java.io.File documentDescriptor)` Read a document model from a file.
`void` `render​(java.io.File baseDirectory, java.io.File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel)` Render a document from the files found in a source directory, depending on a rendering context.
`void` `render​(java.util.Collection<java.lang.String> files, java.io.File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel)` Render a document from a set of files, depending on a rendering context.

### Field Detail

#### ROLE

    static final java.lang.String ROLE

Plexus lookup role.

### Method Detail

#### render

    void render​(java.util.Collection<java.lang.String> files,
                java.io.File outputDirectory,
                org.apache.maven.doxia.document.DocumentModel documentModel)
         throws DocumentRendererException,
                java.io.IOException

Render a document from a set of files, depending on a rendering context.

Parameters:
  `files` - the path name Strings (relative to a common base directory) of files to include in the document generation.
  `outputDirectory` - the output directory where the document should be generated.
  `documentModel` - the document model, containing all the metadata, etc. If the model contains a TOC, only the files found in this TOC are rendered, otherwise all files from the Collection of files will be processed. If the model is null, render all files individually.
Throws:
  `DocumentRendererException` - if any.
  `java.io.IOException` - if any.

#### render

    void render​(java.io.File baseDirectory,
                java.io.File outputDirectory,
                org.apache.maven.doxia.document.DocumentModel documentModel)
         throws DocumentRendererException,
                java.io.IOException

Render a document from the files found in a source directory, depending on a rendering context.

Parameters:
  `baseDirectory` - the directory containing the source files. This should follow the standard Maven convention, ie containing all the site modules.
  `outputDirectory` - the output directory where the document should be generated.
  `documentModel` - the document model, containing all the metadata, etc. If the model contains a TOC, only the files found in this TOC are rendered, otherwise all files found under baseDirectory will be processed. If the model is null, render all files from baseDirectory individually.
Throws:
  `DocumentRendererException` - if any
  `java.io.IOException` - if any // * @deprecated since 1.1.2, use `#render(File, File, DocumentModel, DocumentRendererContext)`

#### readDocumentModel

    org.apache.maven.doxia.document.DocumentModel readDocumentModel​(java.io.File documentDescriptor)
                                                             throws DocumentRendererException,
                                                                    java.io.IOException

Read a document model from a file.

Parameters:
  `documentDescriptor` - a document descriptor file that contains the document model.
Returns:
  the document model, containing all the metadata, etc.
Throws:
  `DocumentRendererException` - if any
  `java.io.IOException` - if any

#### getOutputExtension

    java.lang.String getOutputExtension()

Get the output extension associated with this DocumentRenderer.

Returns:
  the ouput extension.