org.apache.maven.doxia.siterenderer
public interface Renderer
Renderer interface.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ROLE
Plexus lookup role.
|
Modifier and Type | Method and Description |
---|---|
void |
copyResources(SiteRenderingContext siteRenderingContext,
java.io.File resourcesDirectory,
java.io.File outputDirectory)
Copy resource files.
|
SiteRenderingContext |
createContextForSkin(java.io.File skinFile,
java.util.Map attributes,
DecorationModel decoration,
java.lang.String defaultWindowTitle,
java.util.Locale locale)
Return a SiteRenderingContext.
|
SiteRenderingContext |
createContextForTemplate(java.io.File templateFile,
java.io.File skinFile,
java.util.Map attributes,
DecorationModel decoration,
java.lang.String defaultWindowTitle,
java.util.Locale locale)
Return a SiteRenderingContext.
|
void |
generateDocument(java.io.Writer writer,
SiteRendererSink sink,
SiteRenderingContext siteRenderingContext)
Generate a document.
|
java.util.Map |
locateDocumentFiles(SiteRenderingContext siteRenderingContext)
Return the document files in a Map.
|
void |
render(java.util.Collection documents,
SiteRenderingContext siteRenderingContext,
java.io.File outputDirectory)
Render a collection of documents.
|
void |
renderDocument(java.io.Writer writer,
org.apache.maven.doxia.sink.render.RenderingContext renderingContext,
SiteRenderingContext context)
Render a document.
|
void render(java.util.Collection documents, SiteRenderingContext siteRenderingContext, java.io.File outputDirectory) throws RendererException, java.io.IOException
documents
- the documents to render.siteRenderingContext
- the SiteRenderingContext to use.outputDirectory
- the output directory to write results.RendererException
- if it bombs.java.io.IOException
- if it bombs.void generateDocument(java.io.Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException
writer
- the Writer to use.sink
- the Sink to receive the events.siteRenderingContext
- the SiteRenderingContext to use.RendererException
- if it bombs.SiteRenderingContext createContextForSkin(java.io.File skinFile, java.util.Map attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) throws java.io.IOException
skinFile
- attributes
- decoration
- defaultWindowTitle
- locale
- java.io.IOException
- if it bombs.SiteRenderingContext createContextForTemplate(java.io.File templateFile, java.io.File skinFile, java.util.Map attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) throws java.net.MalformedURLException
templateFile
- skinFile
- attributes
- decoration
- defaultWindowTitle
- locale
- java.net.MalformedURLException
- if it bombs.void copyResources(SiteRenderingContext siteRenderingContext, java.io.File resourcesDirectory, java.io.File outputDirectory) throws java.io.IOException
siteRenderingContext
- resourcesDirectory
- outputDirectory
- java.io.IOException
- if it bombs.java.util.Map locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws java.io.IOException, RendererException
siteRenderingContext
- java.io.IOException
- if it bombs.RendererException
- if it bombs.void renderDocument(java.io.Writer writer, org.apache.maven.doxia.sink.render.RenderingContext renderingContext, SiteRenderingContext context) throws RendererException, java.io.FileNotFoundException, java.io.UnsupportedEncodingException
writer
- renderingContext
- context
- RendererException
- if it bombs.java.io.FileNotFoundException
- if it bombs.java.io.UnsupportedEncodingException
- if it bombs.Copyright © 2005-2014. All Rights Reserved.