SiteModel (Doxia Sitetools :: Site Model 2.0.0 API)

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:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String MERGE

static String OVERRIDE

Fields
Modifier and Type	Field and Description
`static String`	`MERGE`
`static String`	`OVERRIDE`

Constructor Summary

Constructors
Constructor and Description

SiteModel()

Constructors
Constructor and Description
`SiteModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoweredBy(Logo logo)` Method addPoweredBy.
`SiteModel`	`clone()` Method clone.
`boolean`	`equals(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.
`String`	`getCombineSelf()` Get whether to inherit configuration from a parent project site descriptor (`merge`) or not (`override`).
`Object`	`getCustom()` Get custom configuration for use with customized Velocity templates.
`Object`	`getCustomChild(String path)`
`String`	`getCustomValue(String path)`
`String`	`getCustomValue(String path, String defaultValue)`
`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(String key)`
`List<Menu>`	`getMenus()`
`String`	`getModelEncoding()` Get the modelEncoding field.
`String`	`getName()` Get the full name of the project site.
`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(String href)`
`boolean`	`isMergeParent()`
`boolean`	`isRequireParent()` Get whether this "site.xml" should inherit from a parent "site.xml".
`void`	`removeMenuRef(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(String combineSelf)` Set whether to inherit configuration from a parent project site descriptor (`merge`) or not (`override`).
`void`	`setCustom(Object custom)` Set custom configuration for use with customized Velocity templates.
`void`	`setEdit(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`	`setModelEncoding(String modelEncoding)` Set the modelEncoding field.
`void`	`setName(String name)` Set the full name of the project site.
`void`	`setPoweredBy(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.
`String`	`toString()` Method toString.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MERGE
```
public static final String MERGE
```
    See Also:
    
    Constant Field Values
  - OVERRIDE
```
public static final String OVERRIDE
```
    See Also:
    
    Constant Field Values
- 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 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
  - 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.
  - 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:
    
    SiteUtils.isLink(java.lang.String)
  - getCustomChild
```
public Object getCustomChild(String path)
```
    Since:
    
    1.8
    
    See Also:
    
    SiteUtils.getCustomChild(org.codehaus.plexus.util.xml.Xpp3Dom, java.lang.String)
  - getCustomValue
```
public String getCustomValue(String path)
```
    Since:
    
    1.8
    
    See Also:
    
    SiteUtils.getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom, java.lang.String)
  - getCustomValue
```
public String getCustomValue(String path,
                             String defaultValue)
```
    Since:
    
    1.8
    
    See Also:
    
    SiteUtils.getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom, java.lang.String)

Class SiteModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MERGE

OVERRIDE

Constructor Detail

SiteModel

Method Detail

addPoweredBy

clone

equals

getBannerLeft

getBannerRight

getBody

getCombineSelf

getCustom

getEdit

getLastModified

getModelEncoding

getName

getPoweredBy

getSkin

hashCode

isRequireParent

removePoweredBy

setBannerLeft

setBannerRight

setBody

setCombineSelf

setCustom

setEdit

setLastModified

setModelEncoding

setName

setPoweredBy

setPublishDate

setRequireParent

setSkin

setVersion

toString

isMergeParent

getPublishDate

isDefaultPublishDate

getVersion

isDefaultVersion

getMenuRef

removeMenuRef

getMenus

isLink

getCustomChild

getCustomValue

getCustomValue