Class SiteRenderingContext
- Author:
- Brett Porter
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addSiteDirectory
(File siteDirectory) Deprecated.void
addSiteDirectory
(SiteRenderingContext.SiteDirectory siteDirectory) Add a site directory, expected to have a Doxia Site layout, ie one directory per Doxia parser module containing files with parser extension.void
addSiteLocales
(List<Locale> locales) Adds passed locales to the list of site locales.Getter for the fielddefaultTitle
.Getter for the fieldinputEncoding
.Getter for the fieldlocale
.Getter for the fieldmoduleExcludes
.Getter for the fieldoutputEncoding
.Return the configurator forparsers
.Directory where to save content after Velocity processing (*.vm
), but before parsing it with Doxia.If you want to specify a specific publish date instead of the current date.Root directory, to calculate relative path to every site directories.Getter for the fieldsiteDirectories
.Getter for the fieldsiteLocales
- a list of locales available for this site context.org.apache.maven.doxia.site.SiteModel
Getter for the fieldsiteModel
.org.apache.maven.artifact.Artifact
getSkin()
Getter for the fieldskin
.org.apache.maven.doxia.site.skin.SkinModel
Getter for the fieldskinModel
.Getter for the fieldtemplateClassLoader
.Getter for the fieldtemplateName
.Getter for the fieldtemplateProperties
.boolean
If input documents should be validated before parsing.void
setDefaultTitle
(String defaultTitle) Setter for the fielddefaultTitle
.void
setInputEncoding
(String inputEncoding) Setter for the fieldinputEncoding
.void
Setter for the fieldlocale
.void
setModuleExcludes
(Map<String, String> moduleExcludes) Setter for the fieldmoduleExcludes
.void
setOutputEncoding
(String outputEncoding) Setter for the fieldoutputEncoding
.void
setParserConfigurator
(ParserConfigurator parserConfigurator) Set the configurator to use forparsers
.void
setProcessedContentOutput
(File processedContentOutput) Where to (eventually) save content after Velocity processing (*.vm
), but before parsing it with Doxia?void
setPublishDate
(Date publishDate) Specify a specific publish date instead of the current date.void
setRootDirectory
(File rootDirectory) Set the root directory.void
setSiteModel
(org.apache.maven.doxia.site.SiteModel siteModel) Setter for the fieldsiteModel
.void
setSkin
(org.apache.maven.artifact.Artifact skin) Setter for the fieldskinJarFile
.void
setSkinModel
(org.apache.maven.doxia.site.skin.SkinModel skinModel) Setter for the fieldskinModel
.void
setTemplateClassLoader
(ClassLoader templateClassLoader) Setter for the fieldtemplateClassLoader
.void
setTemplateName
(String templateName) Setter for the fieldtemplateName
.void
setTemplateProperties
(Map<String, ?> templateProperties) Setter for the fieldtemplateProperties
.void
setValidate
(boolean validate) Switch on/off validation.
-
Constructor Details
-
SiteRenderingContext
public SiteRenderingContext()
-
-
Method Details
-
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
Getter for the field
templateName
.- Returns:
- a
String
object.
-
getTemplateClassLoader
Getter for the field
templateClassLoader
.- Returns:
- a
ClassLoader
object.
-
setTemplateClassLoader
Setter for the field
templateClassLoader
.- Parameters:
templateClassLoader
- aClassLoader
object.
-
getTemplateProperties
Getter for the field
templateProperties
.- Returns:
- a
Map
object.
-
setTemplateProperties
Setter for the field
templateProperties
.- Parameters:
templateProperties
- aMap
object.
-
getLocale
Getter for the field
locale
.- Returns:
- a
Locale
object.
-
setLocale
Setter for the field
locale
.- Parameters:
locale
- aLocale
object.
-
getSiteLocales
Getter for the field
siteLocales
- a list of locales available for this site context. -
addSiteLocales
Adds passed locales to the list of site locales.
- Parameters:
locales
- List ofLocale
objects to add to the site locales list.
-
getSiteModel
public org.apache.maven.doxia.site.SiteModel getSiteModel()Getter for the field
siteModel
.- Returns:
- a
SiteModel
object.
-
setSiteModel
public void setSiteModel(org.apache.maven.doxia.site.SiteModel siteModel) Setter for the field
siteModel
.- Parameters:
siteModel
- aSiteModel
object.
-
setDefaultTitle
Setter for the field
defaultTitle
.- Parameters:
defaultTitle
- aString
object.
-
getDefaultTitle
Getter for the field
defaultTitle
.- Returns:
- a
String
object.
-
getSkin
public org.apache.maven.artifact.Artifact getSkin()Getter for the field
skin
.- Returns:
- a
Artifact
object.
-
setSkin
public void setSkin(org.apache.maven.artifact.Artifact skin) Setter for the field
skinJarFile
.- Parameters:
skin
- anArtifact
object.
-
getSkinModel
public org.apache.maven.doxia.site.skin.SkinModel getSkinModel()Getter for the field
skinModel
.- Returns:
- a
SkinModel
object.
-
setSkinModel
public void setSkinModel(org.apache.maven.doxia.site.skin.SkinModel skinModel) Setter for the field
skinModel
.- Parameters:
skinModel
- aSkinModel
object.
-
setTemplateName
Setter for the field
templateName
.- Parameters:
templateName
- aString
object.
-
addSiteDirectory
Deprecated. -
addSiteDirectory
Add a site directory, expected to have a Doxia Site layout, ie one directory per Doxia parser module containing files with parser extension. Typical values aresrc/site
ortarget/generated-site
.- Parameters:
siteDirectory
- aSiteRenderingContext.SiteDirectory
object.- Since:
- 2.0.0
-
getSiteDirectories
Getter for the field
siteDirectories
.- Returns:
- List of site directories.
-
getModuleExcludes
Getter for the field
moduleExcludes
.- Returns:
- a map defining exclude patterns (comma separated) by parser id.
-
setModuleExcludes
Setter for the field
moduleExcludes
.- Parameters:
moduleExcludes
- aMap
object.
-
getInputEncoding
Getter for the field
inputEncoding
.- Returns:
- a
String
object.
-
setInputEncoding
Setter for the field
inputEncoding
.- Parameters:
inputEncoding
- aString
object.
-
getOutputEncoding
Getter for the field
outputEncoding
.- Returns:
- a
String
object.
-
setOutputEncoding
Setter for the field
outputEncoding
.- Parameters:
outputEncoding
- aString
object.
-
getPublishDate
If you want to specify a specific publish date instead of the current date.
- Returns:
- the publish date, can be
null
-
setPublishDate
Specify a specific publish date instead of the current date.
- Parameters:
publishDate
- the publish date
-
getProcessedContentOutput
Directory where to save content after Velocity processing (*.vm
), but before parsing it with Doxia.- Returns:
- not null if the documents are to be saved
- Since:
- 1.7
-
setProcessedContentOutput
Where to (eventually) save content after Velocity processing (*.vm
), but before parsing it with Doxia?- Parameters:
processedContentOutput
- not null if the documents are to be saved- Since:
- 1.7
-
getRootDirectory
Root directory, to calculate relative path to every site directories. Corresponds to thepom.xml
directory for Maven build.- Returns:
- the root directory
- Since:
- 1.8
-
setRootDirectory
Set the root directory.- Parameters:
rootDirectory
- the root directory- Since:
- 1.8
-
getParserConfigurator
Return the configurator forparsers
.- Returns:
- the parser configurator (may be
null
in which case the default configuration is applied) - Since:
- 2.0.0
-
setParserConfigurator
Set the configurator to use forparsers
.- Parameters:
parserConfigurator
- the configurator- Since:
- 2.0.0
-
addSiteDirectory(SiteDirectory)