org.apache.maven.doxia.docrenderer
Interface DocRenderer

All Known Subinterfaces:
PdfRenderer, RtfRenderer
All Known Implementing Classes:
AbstractITextRender, DefaultPdfRenderer, DefaultRtfRenderer

public interface DocRenderer

Base renderer interface for the document

Version:
$Id: DocRenderer.java 496703 2007-01-16 14:27:31Z vsiveton $
Author:
Vincent Siveton

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 java.lang.String getOutputExtension()
          Get the output extension supported
 void render(java.io.File siteDirectory, java.io.File outputDirectory)
          Render all files from a site directory to an output directory
 void render(java.io.File siteDirectory, java.io.File outputDirectory, java.io.File documentDescriptor)
          Render a document depending a context and a document descriptor
 

Field Detail

ROLE

static final java.lang.String ROLE
Method Detail

render

void render(java.io.File siteDirectory,
            java.io.File outputDirectory)
            throws DocRendererException,
                   java.io.IOException
Render all files from a site directory to an output directory

Parameters:
siteDirectory - the input directory contains files to be generated
outputDirectory - the output directory where files are generated
Throws:
DocRendererException - if any
java.io.IOException - if any

render

void render(java.io.File siteDirectory,
            java.io.File outputDirectory,
            java.io.File documentDescriptor)
            throws DocRendererException,
                   java.io.IOException
Render a document depending a context and a document descriptor

Parameters:
siteDirectory - the input directory contains files to be generated
outputDirectory - the output directory where file are generated
documentDescriptor - the document descriptor
Throws:
DocRendererException - if any
java.io.IOException - if any

getOutputExtension

java.lang.String getOutputExtension()
Get the output extension supported

Returns:
the ouput extension supported


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.