public class SiteRenderingContext extends Object
Constructor and Description |
---|
SiteRenderingContext() |
Modifier and Type | Method and Description |
---|---|
void |
addSiteDirectory(File 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.
|
String |
getDefaultTitle()
Getter for the field
defaultTitle . |
String |
getInputEncoding()
Getter for the field
inputEncoding . |
Locale |
getLocale()
Getter for the field
locale . |
Map<String,String> |
getModuleExcludes()
Getter for the field
moduleExcludes . |
String |
getOutputEncoding()
Getter for the field
outputEncoding . |
File |
getProcessedContentOutput()
Directory where to save content after Velocity processing (
*.vm ), but before parsing it with Doxia. |
Date |
getPublishDate()
If you want to specify a specific publish date instead of the current date.
|
File |
getRootDirectory()
Root directory, to calculate relative path to every site directories.
|
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. |
SiteModel |
getSiteModel()
Getter for the field
siteModel . |
org.apache.maven.artifact.Artifact |
getSkin()
Getter for the field
skin . |
SkinModel |
getSkinModel()
Getter for the field
skinModel . |
ClassLoader |
getTemplateClassLoader()
Getter for the field
templateClassLoader . |
String |
getTemplateName()
Getter for the field
templateName . |
Map<String,?> |
getTemplateProperties()
Getter for the field
templateProperties . |
boolean |
isValidate()
If input documents should be validated before parsing.
|
void |
setDefaultTitle(String defaultTitle)
Setter for the field
defaultTitle . |
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 |
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(SiteModel siteModel)
Setter for the field
siteModel . |
void |
setSkin(org.apache.maven.artifact.Artifact skin)
Setter for the field
skinJarFile . |
void |
setSkinModel(SkinModel skinModel)
Setter for the field
skinModel . |
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 |
setValidate(boolean validate)
Switch on/off validation.
|
public boolean isValidate()
public void setValidate(boolean validate)
validate
- true to switch on validation.public String getTemplateName()
Getter for the field templateName
.
String
object.public ClassLoader getTemplateClassLoader()
Getter for the field templateClassLoader
.
ClassLoader
object.public void setTemplateClassLoader(ClassLoader templateClassLoader)
Setter for the field templateClassLoader
.
templateClassLoader
- a ClassLoader
object.public Map<String,?> getTemplateProperties()
Getter for the field templateProperties
.
Map
object.public void setTemplateProperties(Map<String,?> templateProperties)
Setter for the field templateProperties
.
templateProperties
- a Map
object.public void setLocale(Locale locale)
Setter for the field locale
.
locale
- a Locale
object.public List<Locale> getSiteLocales()
Getter for the field siteLocales
-
a list of locales available for this site context.
public void addSiteLocales(List<Locale> locales)
Adds passed locales to the list of site locales.
locales
- List of Locale
objects to add to the site locales list.public SiteModel getSiteModel()
Getter for the field siteModel
.
SiteModel
object.public void setSiteModel(SiteModel siteModel)
Setter for the field siteModel
.
siteModel
- a SiteModel
object.public void setDefaultTitle(String defaultTitle)
Setter for the field defaultTitle
.
defaultTitle
- a String
object.public String getDefaultTitle()
Getter for the field defaultTitle
.
String
object.public org.apache.maven.artifact.Artifact getSkin()
Getter for the field skin
.
Artifact
object.public void setSkin(org.apache.maven.artifact.Artifact skin)
Setter for the field skinJarFile
.
skin
- an Artifact
object.public SkinModel getSkinModel()
Getter for the field skinModel
.
SkinModel
object.public void setSkinModel(SkinModel skinModel)
Setter for the field skinModel
.
skinModel
- a SkinModel
object.public void setTemplateName(String templateName)
Setter for the field templateName
.
templateName
- a String
object.public void addSiteDirectory(File siteDirectory)
src/site
or target/generated-site
.siteDirectory
- a File
object.public List<File> getSiteDirectories()
Getter for the field siteDirectories
.
public Map<String,String> getModuleExcludes()
Getter for the field moduleExcludes
.
public void setModuleExcludes(Map<String,String> moduleExcludes)
Setter for the field moduleExcludes
.
moduleExcludes
- a Map
object.public String getInputEncoding()
Getter for the field inputEncoding
.
String
object.public void setInputEncoding(String inputEncoding)
Setter for the field inputEncoding
.
inputEncoding
- a String
object.public String getOutputEncoding()
Getter for the field outputEncoding
.
String
object.public void setOutputEncoding(String outputEncoding)
Setter for the field outputEncoding
.
outputEncoding
- a String
object.public Date getPublishDate()
If you want to specify a specific publish date instead of the current date.
null
public void setPublishDate(Date publishDate)
Specify a specific publish date instead of the current date.
publishDate
- the publish datepublic File getProcessedContentOutput()
*.vm
), but before parsing it with Doxia.public void setProcessedContentOutput(File processedContentOutput)
*.vm
), but before parsing it with
Doxia?processedContentOutput
- not null if the documents are to be savedpublic File getRootDirectory()
pom.xml
directory for Maven build.public void setRootDirectory(File rootDirectory)
rootDirectory
- the root directoryCopyright © 2005–2023 The Apache Software Foundation. All rights reserved.