Package org.apache.maven.doxia.site
Class SiteModel
java.lang.Object
org.apache.maven.doxia.site.SiteModel
- All Implemented Interfaces:
Serializable
,Cloneable
The
<site>
element is the root of
the site decoration descriptor.- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPoweredBy
(Logo logo) Method addPoweredBy.clone()
Method clone.boolean
Method equals.Get banner logo on the masthead of the site to the left.Get banner logo on the masthead of the site to the right.getBody()
Get the main site content.Get whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).Get custom configuration for use with customized Velocity templates.getCustomChild
(String path) getCustomValue
(String path) getCustomValue
(String path, String defaultValue) getEdit()
Get the base url to edit Doxia document sources.long
Get timestamp of the last modification of this site model.getMenuRef
(String key) getMenus()
Get the modelEncoding field.getName()
Get the full name of the project site.Method getPoweredBy.getSkin()
Get the artifact containing the skin for the site.int
hashCode()
Method hashCode.boolean
boolean
boolean
boolean
boolean
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
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
Set custom configuration for use with customized Velocity templates.void
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
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
Set the artifact containing the skin for the site.void
setVersion
(Version version) Set modify the version published display properties.toString()
Method toString.
-
Field Details
-
MERGE
- See Also:
-
OVERRIDE
- See Also:
-
-
Constructor Details
-
SiteModel
public SiteModel()
-
-
Method Details
-
addPoweredBy
Method addPoweredBy.- Parameters:
logo
- a logo object.
-
clone
Method clone. -
equals
Method equals. -
getBannerLeft
Get banner logo on the masthead of the site to the left.- Returns:
- Banner
-
getBannerRight
Get banner logo on the masthead of the site to the right.- Returns:
- Banner
-
getBody
Get the main site content.- Returns:
- Body
-
getCombineSelf
Get whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).- Returns:
- String
-
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
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
Get the modelEncoding field.- Returns:
- String
-
getName
Get the full name of the project site.- Returns:
- String
-
getPoweredBy
Method getPoweredBy.- Returns:
- List
-
getSkin
Get the artifact containing the skin for the site.- Returns:
- Skin
-
hashCode
public int hashCode()Method hashCode. -
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
Method removePoweredBy.- Parameters:
logo
- a logo object.
-
setBannerLeft
Set banner logo on the masthead of the site to the left.- Parameters:
bannerLeft
- a bannerLeft object.
-
setBannerRight
Set banner logo on the masthead of the site to the right.- Parameters:
bannerRight
- a bannerRight object.
-
setBody
Set the main site content.- Parameters:
body
- a body object.
-
setCombineSelf
Set whether to inherit configuration from a parent project site descriptor (merge
) or not (override
).- Parameters:
combineSelf
- a combineSelf object.
-
setCustom
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
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
Set the modelEncoding field.- Parameters:
modelEncoding
- a modelEncoding object.
-
setName
Set the full name of the project site.- Parameters:
name
- a name object.
-
setPoweredBy
Set powered by logos list.- Parameters:
poweredBy
- a poweredBy object.
-
setPublishDate
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
Set the artifact containing the skin for the site.- Parameters:
skin
- a skin object.
-
setVersion
Set modify the version published display properties.- Parameters:
version
- a version object.
-
toString
Method toString. -
isMergeParent
public boolean isMergeParent() -
getPublishDate
-
isDefaultPublishDate
public boolean isDefaultPublishDate() -
getVersion
-
isDefaultVersion
public boolean isDefaultVersion() -
getMenuRef
- Parameters:
key
- not null- Returns:
- the menu ref defined by the given key.
-
removeMenuRef
- Parameters:
key
- not null
-
getMenus
- Returns:
- the menus list or EMPTY_LIST.
-
isLink
- Since:
- 1.7
- See Also:
-
getCustomChild
- Since:
- 1.8
- See Also:
-
getCustomValue
- Since:
- 1.8
- See Also:
-
getCustomValue
- Since:
- 1.8
- See Also:
-