Package org.apache.maven.model

Class Site

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    public class Site
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    Contains the information needed for deploying websites.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Site()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Site clone()
      Method clone.
      java.lang.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.
      java.lang.String getId()
      Get a unique identifier for a deployment location.
      InputLocation getLocation​(java.lang.Object key)
      Gets the location of the specified field in the input source.
      java.lang.String getName()
      Get human readable name of the deployment location.
      java.lang.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​(java.lang.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​(java.lang.String id)
      Set a unique identifier for a deployment location.
      void setLocation​(java.lang.Object key, InputLocation location)
      Sets the location of the specified field.
      void setName​(java.lang.String name)
      Set human readable name of the deployment location.
      void setOtherLocation​(java.lang.Object key, InputLocation location)  
      void setUrl​(java.lang.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 java.lang.Object
        Returns:
        Site

      • getChildSiteUrlInheritAppendPath

        public java.lang.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 java.lang.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

      • getName

        public java.lang.String getName()
        Get human readable name of the deployment location.
        Returns:
        String

      • setOtherLocation

        public void setOtherLocation​(java.lang.Object key,
                             InputLocation location)
        Parameters:
        key - a key object.
        location - a location object.

      • getUrl

        public java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String name)
        Set human readable name of the deployment location.
        Parameters:
        name - a name object.

      • setUrl

        public void setUrl​(java.lang.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)