Package org.apache.maven.model
Class Site
java.lang.Object
org.apache.maven.model.Site
- All Implemented Interfaces:
Serializable
,Cloneable
,InputLocationTracker
Contains the information needed for deploying websites.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
When children inherit from distribution management site url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
Since: Maven 3.6.1 .private InputLocation
Field childSiteUrlInheritAppendPathLocation.private String
A unique identifier for a deployment location.private InputLocation
Field idLocation.private InputLocation
Field location.private Map<Object,
InputLocation> Field locations.private String
Human readable name of the deployment location.private InputLocation
Field nameLocation.private String
The url of the location where website is deployed, in the formprotocol://hostname/path
.private InputLocation
Field urlLocation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Method clone.Get when children inherit from distribution management site url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
Since: Maven 3.6.1.getId()
Get a unique identifier for a deployment location.getLocation
(Object key) Gets the location of the specified field in the input source.getName()
Get human readable name of the deployment location.private InputLocation
getOtherLocation
(Object key) getUrl()
Get the url of the location where website is deployed, in the formprotocol://hostname/path
.boolean
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 isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
Since: Maven 3.6.1.void
Set a unique identifier for a deployment location.void
setLocation
(Object key, InputLocation location) Sets the location of the specified field.void
Set human readable name of the deployment location.void
setOtherLocation
(Object key, InputLocation location) void
Set the url of the location where website is deployed, in the formprotocol://hostname/path
.
-
Field Details
-
id
A unique identifier for a deployment location. This is used to match the site to configuration in thesettings.xml
file, for example. -
name
Human readable name of the deployment location. -
url
The url of the location where website is deployed, in the formprotocol://hostname/path
.
Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site'schild.site.url.inherit.append.path="false"
-
childSiteUrlInheritAppendPath
When children inherit from distribution management site url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
Since: Maven 3.6.1 . -
locations
Field locations. -
location
Field location. -
idLocation
Field idLocation. -
nameLocation
Field nameLocation. -
urlLocation
Field urlLocation. -
childSiteUrlInheritAppendPathLocation
Field childSiteUrlInheritAppendPathLocation.
-
-
Constructor Details
-
Site
public Site()
-
-
Method Details
-
clone
Method clone. -
getChildSiteUrlInheritAppendPath
Get when children inherit from distribution management site url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
Since: Maven 3.6.1.- Returns:
- String
-
getId
Get a unique identifier for a deployment location. This is used to match the site to configuration in thesettings.xml
file, for example.- Returns:
- String
-
getLocation
Description copied from interface:InputLocationTracker
Gets the location of the specified field in the input source.- Specified by:
getLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getName
Get human readable name of the deployment location.- Returns:
- String
-
setLocation
Description copied from interface:InputLocationTracker
Sets the location of the specified field.- Specified by:
setLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.location
- a location object.
-
setOtherLocation
- Parameters:
key
- a key object.location
- a location object.
-
getOtherLocation
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getUrl
Get the url of the location where website is deployed, in the formprotocol://hostname/path
.
Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site'schild.site.url.inherit.append.path="false"
- Returns:
- String
-
setChildSiteUrlInheritAppendPath
Set when children inherit from distribution management site url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
Since: Maven 3.6.1.- Parameters:
childSiteUrlInheritAppendPath
- a childSiteUrlInheritAppendPath object.
-
setId
Set a unique identifier for a deployment location. This is used to match the site to configuration in thesettings.xml
file, for example.- Parameters:
id
- a id object.
-
setName
Set human readable name of the deployment location.- Parameters:
name
- a name object.
-
setUrl
Set the url of the location where website is deployed, in the formprotocol://hostname/path
.
Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site'schild.site.url.inherit.append.path="false"
- Parameters:
url
- a url object.
-
isChildSiteUrlInheritAppendPath
public boolean isChildSiteUrlInheritAppendPath() -
setChildSiteUrlInheritAppendPath
public void setChildSiteUrlInheritAppendPath(boolean childSiteUrlInheritAppendPath)
-