|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.logging.AbstractLogEnabled
org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
public class DefaultSiteRenderer
DefaultSiteRenderer class.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.siterenderer.Renderer |
---|
ROLE |
Constructor Summary | |
---|---|
DefaultSiteRenderer()
|
Method Summary | |
---|---|
protected void |
copyDirectory(java.io.File source,
java.io.File destination)
Copy the directory |
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. |
Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled |
---|
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultSiteRenderer()
Method Detail |
---|
public void render(java.util.Collection documents, SiteRenderingContext siteRenderingContext, java.io.File outputDirectory) throws RendererException, java.io.IOException
render
in interface Renderer
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.public java.util.Map locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws java.io.IOException, RendererException
locateDocumentFiles
in interface Renderer
java.io.IOException
- if it bombs.
RendererException
- if it bombs.public void renderDocument(java.io.Writer writer, org.apache.maven.doxia.sink.render.RenderingContext renderingContext, SiteRenderingContext context) throws RendererException, java.io.FileNotFoundException, java.io.UnsupportedEncodingException
renderDocument
in interface Renderer
RendererException
- if it bombs.
java.io.FileNotFoundException
- if it bombs.
java.io.UnsupportedEncodingException
- if it bombs.public void generateDocument(java.io.Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException
generateDocument
in interface Renderer
writer
- the Writer to use.sink
- the Sink to receive the events.siteRenderingContext
- the SiteRenderingContext to use.
RendererException
- if it bombs.public SiteRenderingContext createContextForSkin(java.io.File skinFile, java.util.Map attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) throws java.io.IOException
createContextForSkin
in interface Renderer
java.io.IOException
- if it bombs.public 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
createContextForTemplate
in interface Renderer
java.net.MalformedURLException
- if it bombs.public void copyResources(SiteRenderingContext siteRenderingContext, java.io.File resourcesDirectory, java.io.File outputDirectory) throws java.io.IOException
copyResources
in interface Renderer
java.io.IOException
- if it bombs.protected void copyDirectory(java.io.File source, java.io.File destination) throws java.io.IOException
source
- source file to be copieddestination
- destination file
java.io.IOException
- if any
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |