Package org.apache.maven.doxia.siterenderer

Class SiteRenderingContext

  • public class SiteRenderingContext
extends java.lang.Object
    Context for a site rendering.

    • Field Detail

      • inputEncoding

        private java.lang.String inputEncoding

      • outputEncoding

        private java.lang.String outputEncoding

      • templateName

        private java.lang.String templateName

      • templateClassLoader

        private java.lang.ClassLoader templateClassLoader

      • templateProperties

        private java.util.Map<java.lang.String,​?> templateProperties

      • locale

        private java.util.Locale locale

      • siteLocales

        private java.util.List<java.util.Locale> siteLocales

      • defaultWindowTitle

        private java.lang.String defaultWindowTitle

      • skin

        private org.apache.maven.artifact.Artifact skin

      • usingDefaultTemplate

        private boolean usingDefaultTemplate

      • rootDirectory

        private java.io.File rootDirectory

      • siteDirectories

        private java.util.List<java.io.File> siteDirectories

      • moduleExcludes

        private java.util.Map<java.lang.String,​java.lang.String> moduleExcludes

      • validate

        private boolean validate

      • publishDate

        private java.util.Date publishDate

      • processedContentOutput

        private java.io.File processedContentOutput

    • 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 java.lang.String getTemplateName()

        Getter for the field templateName.

        Returns:
        a String object.

      • getTemplateClassLoader

        public java.lang.ClassLoader getTemplateClassLoader()

        Getter for the field templateClassLoader.

        Returns:
        a ClassLoader object.

      • setTemplateClassLoader

        public void setTemplateClassLoader​(java.lang.ClassLoader templateClassLoader)

        Setter for the field templateClassLoader.

        Parameters:
        templateClassLoader - a ClassLoader object.

      • getTemplateProperties

        public java.util.Map<java.lang.String,​?> getTemplateProperties()

        Getter for the field templateProperties.

        Returns:
        a Map object.

      • setTemplateProperties

        public void setTemplateProperties​(java.util.Map<java.lang.String,​?> templateProperties)

        Setter for the field templateProperties.

        Parameters:
        templateProperties - a Map object.

      • getLocale

        public java.util.Locale getLocale()

        Getter for the field locale.

        Returns:
        a Locale object.

      • setLocale

        public void setLocale​(java.util.Locale locale)

        Setter for the field locale.

        Parameters:
        locale - a Locale object.

      • getSiteLocales

        public java.util.List<java.util.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​(java.util.List<java.util.Locale> locales)

        Adds passed locales to the list of site locales.

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

      • setDecoration

        public void setDecoration​(DecorationModel decoration)

        Setter for the field decoration.

        Parameters:
        decoration - a DecorationModel object.

      • setDefaultWindowTitle

        public void setDefaultWindowTitle​(java.lang.String defaultWindowTitle)

        Setter for the field defaultWindowTitle.

        Parameters:
        defaultWindowTitle - a String object.

      • getDefaultWindowTitle

        public java.lang.String getDefaultWindowTitle()

        Getter for the field defaultWindowTitle.

        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 - an Artifact object.

      • getSkinModel

        public SkinModel getSkinModel()

        Getter for the field skinModel.

        Returns:
        a SkinModel object.

      • setSkinModel

        public void setSkinModel​(SkinModel skinModel)

        Setter for the field skinModel.

        Parameters:
        skinModel - a SkinModel object.

      • setTemplateName

        public void setTemplateName​(java.lang.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​(java.io.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. Typical values are src/site or target/generated-site.
        Parameters:
        siteDirectory - a File object.

      • addModuleDirectory

        public void addModuleDirectory​(java.io.File moduleBasedir,
                               java.lang.String moduleParserId)
        Add a extra-module source directory: used for Maven 1.x ${basedir}/xdocs layout, which contains xdoc and fml.
        Parameters:
        moduleBasedir - The base directory for module's source files.
        moduleParserId - module's Doxia parser id.

      • getSiteDirectories

        public java.util.List<java.io.File> getSiteDirectories()

        Getter for the field siteDirectories.

        Returns:
        List of site directories files.

      • getModules

        public java.util.List<ExtraDoxiaModuleReference> getModules()

        Getter for the field modules.

        Returns:
        a List object.

      • getModuleExcludes

        public java.util.Map<java.lang.String,​java.lang.String> getModuleExcludes()

        Getter for the field moduleExcludes.

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

      • setModuleExcludes

        public void setModuleExcludes​(java.util.Map<java.lang.String,​java.lang.String> moduleExcludes)

        Setter for the field moduleExcludes.

        Parameters:
        moduleExcludes - a Map object.

      • getInputEncoding

        public java.lang.String getInputEncoding()

        Getter for the field inputEncoding.

        Returns:
        a String object.

      • setInputEncoding

        public void setInputEncoding​(java.lang.String inputEncoding)

        Setter for the field inputEncoding.

        Parameters:
        inputEncoding - a String object.

      • getOutputEncoding

        public java.lang.String getOutputEncoding()

        Getter for the field outputEncoding.

        Returns:
        a String object.

      • setOutputEncoding

        public void setOutputEncoding​(java.lang.String outputEncoding)

        Setter for the field outputEncoding.

        Parameters:
        outputEncoding - a String object.

      • getPublishDate

        public java.util.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​(java.util.Date publishDate)

        Specify a specific publish date instead of the current date.

        Parameters:
        publishDate - the publish date

      • getProcessedContentOutput

        public java.io.File 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

        public void setProcessedContentOutput​(java.io.File processedContentOutput)
        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

        public java.io.File getRootDirectory()
        Root directory, to calculate relative path to every site directories. Corresponds to the pom.xml directory for Maven build.
        Returns:
        the root directory
        Since:
        1.8

      • setRootDirectory

        public void setRootDirectory​(java.io.File rootDirectory)
        Set the root directory.
        Parameters:
        rootDirectory -
        Since:
        1.8