Package org.apache.maven.model

Class Site

java.lang.Object

org.apache.maven.model.Site

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class Site
extends Object
implements Serializable, Cloneable, InputLocationTracker

Contains the information needed for deploying websites.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Site()

Method Summary

Modifier and Type	Method	Description
Site	clone()	Method clone.
String	getChildSiteUrlInheritAppendPath()	Get when children inherit from distribution management site url, append path or not? Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean Default value is: true Since: Maven 3.6.1.
String	getId()	Get a unique identifier for a deployment location.
InputLocation	getLocation(Object key)	Gets the location of the specified field in the input source.
String	getName()	Get human readable name of the deployment location.
String	getUrl()	Get the url of the location where website is deployed, in the form protocol://hostname/path.
boolean	isChildSiteUrlInheritAppendPath()
void	setChildSiteUrlInheritAppendPath(boolean childSiteUrlInheritAppendPath)
void	setChildSiteUrlInheritAppendPath(String childSiteUrlInheritAppendPath)	Set when children inherit from distribution management site url, append path or not? Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean Default value is: true Since: Maven 3.6.1.
void	setId(String id)	Set a unique identifier for a deployment location.
void	setLocation(Object key, InputLocation location)	Sets the location of the specified field.
void	setName(String name)	Set human readable name of the deployment location.
void	setOtherLocation(Object key, InputLocation location)
void	setUrl(String url)	Set the url of the location where website is deployed, in the form protocol://hostname/path.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Site

public Site()

Method Detail

clone

public Site clone()

Method clone.

Overrides:

clone in class Object

Returns:

Site

getChildSiteUrlInheritAppendPath

public String getChildSiteUrlInheritAppendPath()

Get when children inherit from distribution management site url, append path or not? Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean
Default value is: true
Since: Maven 3.6.1.

Returns:

String

getId

public String getId()

Get a unique identifier for a deployment location. This is used to match the site to configuration in the settings.xml file, for example.

Returns:

String

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key - a key object.

Returns:

InputLocation

getName

public String getName()

Get human readable name of the deployment location.

Returns:

String

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key - a key object.

location - a location object.

setOtherLocation

public void setOtherLocation(Object key,
                             InputLocation location)

Parameters:

key - a key object.

location - a location object.

getUrl

public String getUrl()

Get the url of the location where website is deployed, in the form protocol://hostname/path.
Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site's child.site.url.inherit.append.path="false"

Returns:

String

setChildSiteUrlInheritAppendPath

public void setChildSiteUrlInheritAppendPath(String childSiteUrlInheritAppendPath)

Set when children inherit from distribution management site url, append path or not? Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean
Default value is: true
Since: Maven 3.6.1.

Parameters:

childSiteUrlInheritAppendPath - a childSiteUrlInheritAppendPath object.

setId

public void setId(String id)

Set a unique identifier for a deployment location. This is used to match the site to configuration in the settings.xml file, for example.

Parameters:

id - a id object.

setName

public void setName(String name)

Set human readable name of the deployment location.

Parameters:

name - a name object.

setUrl

public void setUrl(String url)

Set the url of the location where website is deployed, in the form protocol://hostname/path.
Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site's child.site.url.inherit.append.path="false"

Parameters:

url - a url object.

isChildSiteUrlInheritAppendPath

public boolean isChildSiteUrlInheritAppendPath()

setChildSiteUrlInheritAppendPath

public void setChildSiteUrlInheritAppendPath(boolean childSiteUrlInheritAppendPath)