org.apache.maven.doxia.siterenderer
Class SiteRenderingContext

java.lang.Object
  org.apache.maven.doxia.siterenderer.SiteRenderingContext

public class SiteRenderingContext
extends Object

Context for a site rendering.

Version:

$Id: SiteRenderingContext.java 1222981 2011-12-24 14:30:00Z rfscholte $

Author:

Brett Porter

Constructor Summary

SiteRenderingContext()

Method Summary

void	addModuleDirectory(File moduleBasedir, String moduleParserId) Add a module source directory.
void	addSiteDirectory(File file) addSiteDirectory.
void	addSiteLocales(List<Locale> locales) Adds passed locales to the list of site locales.
DecorationModel	getDecoration() Getter for the field decoration.
String	getDefaultWindowTitle() Getter for the field defaultWindowTitle.
String	getInputEncoding() Getter for the field inputEncoding.
Locale	getLocale() Getter for the field locale.
Map<String,String>	getModuleExcludes() Getter for the field moduleExcludes.
List<org.apache.maven.doxia.siterenderer.ModuleReference>	getModules() Getter for the field modules.
String	getOutputEncoding() Getter for the field outputEncoding.
Date	getPublishDate() If you want to specify a specific publish date instead of the current date.
List<File>	getSiteDirectories() Getter for the field siteDirectories.
List<Locale>	getSiteLocales() Getter for the field siteLocales - a list of locales available for this site context.
File	getSkinJarFile() Getter for the field skinJarFile.
ClassLoader	getTemplateClassLoader() Getter for the field templateClassLoader.
String	getTemplateName() Getter for the field templateName.
Map<String,?>	getTemplateProperties() Getter for the field templateProperties.
boolean	isUsingDefaultTemplate() isUsingDefaultTemplate.
boolean	isValidate() If input documents should be validated before parsing.
void	setDecoration(DecorationModel decoration) Setter for the field decoration.
void	setDefaultWindowTitle(String defaultWindowTitle) Setter for the field defaultWindowTitle.
void	setInputEncoding(String inputEncoding) Setter for the field inputEncoding.
void	setLocale(Locale locale) Setter for the field locale.
void	setModuleExcludes(Map<String,String> moduleExcludes) Setter for the field moduleExcludes.
void	setOutputEncoding(String outputEncoding) Setter for the field outputEncoding.
void	setPublishDate(Date publishDate) Specify a specific publish date instead of the current date.
void	setSkinJarFile(File skinJarFile) Setter for the field skinJarFile.
void	setTemplateClassLoader(ClassLoader templateClassLoader) Setter for the field templateClassLoader.
void	setTemplateName(String templateName) Setter for the field templateName.
void	setTemplateProperties(Map<String,?> templateProperties) Setter for the field templateProperties.
void	setUsingDefaultTemplate(boolean usingDefaultTemplate) Setter for the field usingDefaultTemplate.
void	setValidate(boolean validate) Switch on/off validation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteRenderingContext

public SiteRenderingContext()

Method Detail

isValidate

public boolean isValidate()

If input documents should be validated before parsing. By default no validation is performed.

Returns:

true if validation is switched on.

Since:

1.1.3

setValidate

public void setValidate(boolean validate)

Switch on/off validation.

Parameters:

validate - true to switch on validation.

Since:

1.1.3

getTemplateName

public String getTemplateName()

Getter for the field templateName.

Returns:

a String object.

getTemplateClassLoader

public ClassLoader getTemplateClassLoader()

Getter for the field templateClassLoader.

Returns:

a ClassLoader object.

setTemplateClassLoader

public void setTemplateClassLoader(ClassLoader templateClassLoader)

Setter for the field templateClassLoader.

Parameters:

templateClassLoader - a ClassLoader object.

getTemplateProperties

public Map<String,?> getTemplateProperties()

Getter for the field templateProperties.

Returns:

a Map object.

setTemplateProperties

public void setTemplateProperties(Map<String,?> templateProperties)

Setter for the field templateProperties.

Parameters:

templateProperties - a Map object.

getLocale

public Locale getLocale()

Getter for the field locale.

Returns:

a Locale object.

setLocale

public void setLocale(Locale locale)

Setter for the field locale.

Parameters:

locale - a Locale object.

getSiteLocales

public List<Locale> getSiteLocales()

Getter for the field siteLocales - a list of locales available for this site context.

Returns:

a List object with Locale objects.

addSiteLocales

public void addSiteLocales(List<Locale> locales)

Adds passed locales to the list of site locales.

Parameters:

locales - List of Locale objects to add to the site locales list.

getDecoration

public DecorationModel getDecoration()

Getter for the field decoration.

Returns:

a DecorationModel object.

setDecoration

public void setDecoration(DecorationModel decoration)

Setter for the field decoration.

Parameters:

decoration - a DecorationModel object.

setDefaultWindowTitle

public void setDefaultWindowTitle(String defaultWindowTitle)

Setter for the field defaultWindowTitle.

Parameters:

defaultWindowTitle - a String object.

getDefaultWindowTitle

public String getDefaultWindowTitle()

Getter for the field defaultWindowTitle.

Returns:

a String object.

getSkinJarFile

public File getSkinJarFile()

Getter for the field skinJarFile.

Returns:

a File object.

setSkinJarFile

public void setSkinJarFile(File skinJarFile)

Setter for the field skinJarFile.

Parameters:

skinJarFile - a File object.

setTemplateName

public void setTemplateName(String templateName)

Setter for the field templateName.

Parameters:

templateName - a String object.

setUsingDefaultTemplate

public void setUsingDefaultTemplate(boolean usingDefaultTemplate)

Setter for the field usingDefaultTemplate.

Parameters:

usingDefaultTemplate - a boolean.

isUsingDefaultTemplate

public boolean isUsingDefaultTemplate()

isUsingDefaultTemplate.

Returns:

a boolean.

addSiteDirectory

public void addSiteDirectory(File file)

addSiteDirectory.

Parameters:

file - a File object.

addModuleDirectory

public void addModuleDirectory(File moduleBasedir,
                               String moduleParserId)

Add a module source directory.

Parameters:

moduleBasedir - The base directory for module's source files.

moduleParserId - a String object.

getSiteDirectories

public List<File> getSiteDirectories()

Getter for the field siteDirectories.

Returns:

List of site directories files.

getModules

public List<org.apache.maven.doxia.siterenderer.ModuleReference> getModules()

Getter for the field modules.

Returns:

a List object.

getModuleExcludes

public Map<String,String> getModuleExcludes()

Getter for the field moduleExcludes.

Returns:

a map defining exclude patterns (comma separated) by parser id.

setModuleExcludes

public void setModuleExcludes(Map<String,String> moduleExcludes)

Setter for the field moduleExcludes.

Parameters:

moduleExcludes - a Map object.

getInputEncoding

public String getInputEncoding()

Getter for the field inputEncoding.

Returns:

a String object.

setInputEncoding

public void setInputEncoding(String inputEncoding)

Setter for the field inputEncoding.

Parameters:

inputEncoding - a String object.

getOutputEncoding

public String getOutputEncoding()

Getter for the field outputEncoding.

Returns:

a String object.

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Setter for the field outputEncoding.

Parameters:

outputEncoding - a String object.

getPublishDate

public Date getPublishDate()

If you want to specify a specific publish date instead of the current date.

Returns:

the publish date, can be null

setPublishDate

public void setPublishDate(Date publishDate)

Specify a specific publish date instead of the current date.

Parameters:

publishDate - the publish date