Package org.apache.maven.doxia.site

Class SiteModel

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class SiteModel
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
    The <site> element is the root of the site decoration descriptor.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MERGE  
      static java.lang.String OVERRIDE  

    • Constructor Summary

      Constructors 
      Constructor Description
      SiteModel()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addPoweredBy​(Logo logo)
      Method addPoweredBy.
      SiteModel clone()
      Method clone.
      boolean equals​(java.lang.Object other)
      Method equals.
      Banner getBannerLeft()
      Get banner logo on the masthead of the site to the left.
      Banner getBannerRight()
      Get banner logo on the masthead of the site to the right.
      Body getBody()
      Get the main site content.
      java.lang.String getCombineSelf()
      Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
      java.lang.Object getCustom()
      Get custom configuration for use with customized Velocity templates.
      java.lang.Object getCustomChild​(java.lang.String path)  
      java.lang.String getCustomValue​(java.lang.String path)  
      java.lang.String getCustomValue​(java.lang.String path, java.lang.String defaultValue)  
      java.lang.String getEdit()
      Get the base url to edit Doxia document sources.
      long getLastModified()
      Get timestamp of the last modification of this site model.
      Menu getMenuRef​(java.lang.String key)  
      java.util.List<Menu> getMenus()  
      MermaidConfiguration getMermaid()
      Get the configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
      java.lang.String getModelEncoding()
      Get the modelEncoding field.
      java.lang.String getName()
      Get the full name of the project site.
      java.util.List<Logo> getPoweredBy()
      Method getPoweredBy.
      PublishDate getPublishDate()  
      Skin getSkin()
      Get the artifact containing the skin for the site.
      Version getVersion()  
      int hashCode()
      Method hashCode.
      boolean isDefaultPublishDate()  
      boolean isDefaultVersion()  
      boolean isLink​(java.lang.String href)  
      boolean isMergeParent()  
      boolean isRequireParent()
      Get whether this "site.xml" should inherit from a parent "site.xml".
      void removeMenuRef​(java.lang.String key)  
      void removePoweredBy​(Logo logo)
      Method removePoweredBy.
      void setBannerLeft​(Banner bannerLeft)
      Set banner logo on the masthead of the site to the left.
      void setBannerRight​(Banner bannerRight)
      Set banner logo on the masthead of the site to the right.
      void setBody​(Body body)
      Set the main site content.
      void setCombineSelf​(java.lang.String combineSelf)
      Set whether to inherit configuration from a parent project site descriptor (merge) or not (override).
      void setCustom​(java.lang.Object custom)
      Set custom configuration for use with customized Velocity templates.
      void setEdit​(java.lang.String edit)
      Set the base url to edit Doxia document sources.
      void setLastModified​(long lastModified)
      Set timestamp of the last modification of this site model.
      void setMermaid​(MermaidConfiguration mermaid)
      Set the configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
      void setModelEncoding​(java.lang.String modelEncoding)
      Set the modelEncoding field.
      void setName​(java.lang.String name)
      Set the full name of the project site.
      void setPoweredBy​(java.util.List<Logo> poweredBy)
      Set powered by logos list.
      void setPublishDate​(PublishDate publishDate)
      Set modify the date published display properties.
      void setRequireParent​(boolean requireParent)
      Set whether this "site.xml" should inherit from a parent "site.xml".
      void setSkin​(Skin skin)
      Set the artifact containing the skin for the site.
      void setVersion​(Version version)
      Set modify the version published display properties.
      java.lang.String toString()
      Method toString.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SiteModel

        public SiteModel()

    • Method Detail

      • addPoweredBy

        public void addPoweredBy​(Logo logo)
        Method addPoweredBy.
        Parameters:
        logo - a logo object.

      • clone

        public SiteModel clone()
        Method clone.
        Overrides:
        clone in class java.lang.Object
        Returns:
        SiteModel

      • equals

        public boolean equals​(java.lang.Object other)
        Method equals.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - a other object.
        Returns:
        boolean

      • getBannerLeft

        public Banner getBannerLeft()
        Get banner logo on the masthead of the site to the left.
        Returns:
        Banner

      • getBannerRight

        public Banner getBannerRight()
        Get banner logo on the masthead of the site to the right.
        Returns:
        Banner

      • getBody

        public Body getBody()
        Get the main site content.
        Returns:
        Body

      • getCombineSelf

        public java.lang.String getCombineSelf()
        Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
        Returns:
        String

      • getCustom

        public java.lang.Object getCustom()
        Get custom configuration for use with customized Velocity templates. Data from this field are accessible in Velocity template from $site.custom variable as DOM content. Example: $site.custom.getChild( 'customElement' ).getValue()
        Returns:
        Object

      • getEdit

        public java.lang.String getEdit()
        Get the base url to edit Doxia document sources. In general, ${project.scm.url} value should do the job.
        Returns:
        String

      • getLastModified

        public long getLastModified()
        Get timestamp of the last modification of this site model.
        Returns:
        long

      • getMermaid

        public MermaidConfiguration getMermaid()
        Get the configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side. If the element does not exist, no Mermaid specific scripts will be included in the generated site. If it exists but the "config" field is not set, a default configuration will be used.
        Returns:
        MermaidConfiguration

      • getModelEncoding

        public java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String

      • getName

        public java.lang.String getName()
        Get the full name of the project site.
        Returns:
        String

      • getPoweredBy

        public java.util.List<Logo> getPoweredBy()
        Method getPoweredBy.
        Returns:
        List

      • getSkin

        public Skin getSkin()
        Get the artifact containing the skin for the site.
        Returns:
        Skin

      • hashCode

        public int hashCode()
        Method hashCode.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int

      • isRequireParent

        public boolean isRequireParent()
        Get whether this "site.xml" should inherit from a parent "site.xml". If set to "true" it fails the build in case a parent site descriptor cannot be retrieved. It does not necessarily need to be the direct parent but just a site descriptor anywhere in the parent hierarchy.
        Returns:
        boolean

      • removePoweredBy

        public void removePoweredBy​(Logo logo)
        Method removePoweredBy.
        Parameters:
        logo - a logo object.

      • setBannerLeft

        public void setBannerLeft​(Banner bannerLeft)
        Set banner logo on the masthead of the site to the left.
        Parameters:
        bannerLeft - a bannerLeft object.

      • setBannerRight

        public void setBannerRight​(Banner bannerRight)
        Set banner logo on the masthead of the site to the right.
        Parameters:
        bannerRight - a bannerRight object.

      • setBody

        public void setBody​(Body body)
        Set the main site content.
        Parameters:
        body - a body object.

      • setCombineSelf

        public void setCombineSelf​(java.lang.String combineSelf)
        Set whether to inherit configuration from a parent project site descriptor (merge) or not (override).
        Parameters:
        combineSelf - a combineSelf object.

      • setCustom

        public void setCustom​(java.lang.Object custom)
        Set custom configuration for use with customized Velocity templates. Data from this field are accessible in Velocity template from $site.custom variable as DOM content. Example: $site.custom.getChild( 'customElement' ).getValue()
        Parameters:
        custom - a custom object.

      • setEdit

        public void setEdit​(java.lang.String edit)
        Set the base url to edit Doxia document sources. In general, ${project.scm.url} value should do the job.
        Parameters:
        edit - a edit object.

      • setLastModified

        public void setLastModified​(long lastModified)
        Set timestamp of the last modification of this site model.
        Parameters:
        lastModified - a lastModified object.

      • setMermaid

        public void setMermaid​(MermaidConfiguration mermaid)
        Set the configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side. If the element does not exist, no Mermaid specific scripts will be included in the generated site. If it exists but the "config" field is not set, a default configuration will be used.
        Parameters:
        mermaid - a mermaid object.

      • setModelEncoding

        public void setModelEncoding​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding - a modelEncoding object.

      • setName

        public void setName​(java.lang.String name)
        Set the full name of the project site.
        Parameters:
        name - a name object.

      • setPoweredBy

        public void setPoweredBy​(java.util.List<Logo> poweredBy)
        Set powered by logos list.
        Parameters:
        poweredBy - a poweredBy object.

      • setPublishDate

        public void setPublishDate​(PublishDate publishDate)
        Set modify the date published display properties.
        Parameters:
        publishDate - a publishDate object.

      • setRequireParent

        public void setRequireParent​(boolean requireParent)
        Set whether this "site.xml" should inherit from a parent "site.xml". If set to "true" it fails the build in case a parent site descriptor cannot be retrieved. It does not necessarily need to be the direct parent but just a site descriptor anywhere in the parent hierarchy.
        Parameters:
        requireParent - a requireParent object.

      • setSkin

        public void setSkin​(Skin skin)
        Set the artifact containing the skin for the site.
        Parameters:
        skin - a skin object.

      • setVersion

        public void setVersion​(Version version)
        Set modify the version published display properties.
        Parameters:
        version - a version object.

      • toString

        public java.lang.String toString()
        Method toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String

      • isMergeParent

        public boolean isMergeParent()

      • isDefaultPublishDate

        public boolean isDefaultPublishDate()

      • getVersion

        public Version getVersion()

      • isDefaultVersion

        public boolean isDefaultVersion()

      • getMenuRef

        public Menu getMenuRef​(java.lang.String key)
        Parameters:
        key - not null
        Returns:
        the menu ref defined by the given key.

      • removeMenuRef

        public void removeMenuRef​(java.lang.String key)
        Parameters:
        key - not null

      • getMenus

        public java.util.List<Menu> getMenus()
        Returns:
        the menus list or EMPTY_LIST.