|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.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(File source,
File destination)
Copy the directory |
void |
copyResources(SiteRenderingContext siteRenderingContext,
File resourcesDirectory,
File outputDirectory)
Copy resource files. |
SiteRenderingContext |
createContextForSkin(File skinFile,
Map<String,?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
Locale locale)
Return a SiteRenderingContext. |
SiteRenderingContext |
createContextForTemplate(File templateFile,
File skinFile,
Map<String,?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
Locale locale)
Return a SiteRenderingContext. |
void |
generateDocument(Writer writer,
SiteRendererSink sink,
SiteRenderingContext siteRenderingContext)
Generate a document. |
Map<String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext)
Return the document files in a Map. |
void |
render(Collection<DocumentRenderer> documents,
SiteRenderingContext siteRenderingContext,
File outputDirectory)
Render a collection of documents. |
void |
renderDocument(Writer writer,
org.apache.maven.doxia.sink.render.RenderingContext renderingContext,
SiteRenderingContext siteContext)
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(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) throws RendererException, 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.
IOException
- if it bombs.public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws IOException, RendererException
locateDocumentFiles
in interface Renderer
IOException
- if it bombs.
RendererException
- if it bombs.public void renderDocument(Writer writer, org.apache.maven.doxia.sink.render.RenderingContext renderingContext, SiteRenderingContext siteContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
renderDocument
in interface Renderer
writer
- the writer to render the document to.renderingContext
- the document's rendering contextsiteContext
- the site's rendering context
RendererException
- if it bombs.
FileNotFoundException
- if it bombs.
UnsupportedEncodingException
- if it bombs.public void generateDocument(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(File skinFile, Map<String,?> attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) throws IOException
createContextForSkin
in interface Renderer
IOException
- if it bombs.public SiteRenderingContext createContextForTemplate(File templateFile, File skinFile, Map<String,?> attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) throws MalformedURLException
createContextForTemplate
in interface Renderer
MalformedURLException
- if it bombs.public void copyResources(SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory) throws IOException
copyResources
in interface Renderer
IOException
- if it bombs.protected void copyDirectory(File source, File destination) throws IOException
source
- source file to be copieddestination
- destination file
IOException
- if any
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |