Package org.apache.maven.doxia.site

Class SiteModel

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

  • Field Details

  • Constructor Details

    • SiteModel

      public SiteModel()

  • Method Details

    • addPoweredBy

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

    • clone

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

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class 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 String getCombineSelf()
      Get whether to inherit configuration from a parent project site descriptor (merge) or not (override).
      Returns:
      String

    • getCustom

      public 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 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 String getModelEncoding()
      Get the modelEncoding field.
      Returns:
      String

    • getName

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

    • getPoweredBy

      public 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 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(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(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(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(String modelEncoding)
      Set the modelEncoding field.
      Parameters:
      modelEncoding - a modelEncoding object.

    • setName

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

    • setPoweredBy

      public void setPoweredBy(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 String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String

    • isMergeParent

      public boolean isMergeParent()

    • getPublishDate

      public PublishDate getPublishDate()

    • isDefaultPublishDate

      public boolean isDefaultPublishDate()

    • getVersion

      public Version getVersion()

    • isDefaultVersion

      public boolean isDefaultVersion()

    • getMenuRef

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

    • removeMenuRef

      public void removeMenuRef(String key)
      Parameters:
      key - not null

    • getMenus

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

    • isLink

      public boolean isLink(String href)
      Since:
      1.7
      See Also:

    • getCustomChild

      public Object getCustomChild(String path)
      Since:
      1.8
      See Also:

    • getCustomValue

      public String getCustomValue(String path)
      Since:
      1.8
      See Also:

    • getCustomValue

      public String getCustomValue(String path, String defaultValue)
      Since:
      1.8
      See Also: