Class Scm

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, InputLocationTracker

    public class Scm
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    The <scm> element contains informations required to the SCM (Source Control Management) of the project.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Scm()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Scm clone()
      Method clone.
      java.lang.String getChildScmConnectionInheritAppendPath()
      Get when children inherit from scm connection, 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 getChildScmDeveloperConnectionInheritAppendPath()
      Get when children inherit from scm developer connection, 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 getChildScmUrlInheritAppendPath()
      Get when children inherit from scm 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 getConnection()
      Get the source control management system URL that describes the repository and how to connect to the repository.
      java.lang.String getDeveloperConnection()
      Get just like connection, but for developers, i.e.
      InputLocation getLocation​(java.lang.Object key)
      Gets the location of the specified field in the input source.
      java.lang.String getTag()
      Get the tag of current code.
      java.lang.String getUrl()
      Get the URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
      boolean isChildScmConnectionInheritAppendPath()  
      boolean isChildScmDeveloperConnectionInheritAppendPath()  
      boolean isChildScmUrlInheritAppendPath()  
      void setChildScmConnectionInheritAppendPath​(boolean childScmConnectionInheritAppendPath)  
      void setChildScmConnectionInheritAppendPath​(java.lang.String childScmConnectionInheritAppendPath)
      Set when children inherit from scm connection, 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 setChildScmDeveloperConnectionInheritAppendPath​(boolean childScmDeveloperConnectionInheritAppendPath)  
      void setChildScmDeveloperConnectionInheritAppendPath​(java.lang.String childScmDeveloperConnectionInheritAppendPath)
      Set when children inherit from scm developer connection, 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 setChildScmUrlInheritAppendPath​(boolean childScmUrlInheritAppendPath)  
      void setChildScmUrlInheritAppendPath​(java.lang.String childScmUrlInheritAppendPath)
      Set when children inherit from scm 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 setConnection​(java.lang.String connection)
      Set the source control management system URL that describes the repository and how to connect to the repository.
      void setDeveloperConnection​(java.lang.String developerConnection)
      Set just like connection, but for developers, i.e.
      void setLocation​(java.lang.Object key, InputLocation location)
      Sets the location of the specified field.
      void setOtherLocation​(java.lang.Object key, InputLocation location)  
      void setTag​(java.lang.String tag)
      Set the tag of current code.
      void setUrl​(java.lang.String url)
      Set the URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Scm

        public Scm()
    • Method Detail

      • clone

        public Scm clone()
        Method clone.
        Overrides:
        clone in class java.lang.Object
        Returns:
        Scm
      • getChildScmConnectionInheritAppendPath

        public java.lang.String getChildScmConnectionInheritAppendPath()
        Get when children inherit from scm connection, 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
      • getChildScmDeveloperConnectionInheritAppendPath

        public java.lang.String getChildScmDeveloperConnectionInheritAppendPath()
        Get when children inherit from scm developer connection, 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
      • getChildScmUrlInheritAppendPath

        public java.lang.String getChildScmUrlInheritAppendPath()
        Get when children inherit from scm 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
      • getConnection

        public java.lang.String getConnection()
        Get the source control management system URL that describes the repository and how to connect to the repository. For more information, see the URL format and list of supported SCMs. This connection is read-only.
        Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's child.scm.connection.inherit.append.path="false"
        Returns:
        String
      • getDeveloperConnection

        public java.lang.String getDeveloperConnection()
        Get just like connection, but for developers, i.e. this scm connection will not be read only.
        Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's child.scm.developerConnection.inherit.append.path="false"
        Returns:
        String
      • setOtherLocation

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

        public java.lang.String getTag()
        Get the tag of current code. By default, it's set to HEAD during development.
        Returns:
        String
      • getUrl

        public java.lang.String getUrl()
        Get the URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
        Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's child.scm.url.inherit.append.path="false"
        Returns:
        String
      • setChildScmConnectionInheritAppendPath

        public void setChildScmConnectionInheritAppendPath​(java.lang.String childScmConnectionInheritAppendPath)
        Set when children inherit from scm connection, 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:
        childScmConnectionInheritAppendPath - a childScmConnectionInheritAppendPath object.
      • setChildScmDeveloperConnectionInheritAppendPath

        public void setChildScmDeveloperConnectionInheritAppendPath​(java.lang.String childScmDeveloperConnectionInheritAppendPath)
        Set when children inherit from scm developer connection, 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:
        childScmDeveloperConnectionInheritAppendPath - a childScmDeveloperConnectionInheritAppendPath object.
      • setChildScmUrlInheritAppendPath

        public void setChildScmUrlInheritAppendPath​(java.lang.String childScmUrlInheritAppendPath)
        Set when children inherit from scm 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:
        childScmUrlInheritAppendPath - a childScmUrlInheritAppendPath object.
      • setConnection

        public void setConnection​(java.lang.String connection)
        Set the source control management system URL that describes the repository and how to connect to the repository. For more information, see the URL format and list of supported SCMs. This connection is read-only.
        Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's child.scm.connection.inherit.append.path="false"
        Parameters:
        connection - a connection object.
      • setDeveloperConnection

        public void setDeveloperConnection​(java.lang.String developerConnection)
        Set just like connection, but for developers, i.e. this scm connection will not be read only.
        Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's child.scm.developerConnection.inherit.append.path="false"
        Parameters:
        developerConnection - a developerConnection object.
      • setTag

        public void setTag​(java.lang.String tag)
        Set the tag of current code. By default, it's set to HEAD during development.
        Parameters:
        tag - a tag object.
      • setUrl

        public void setUrl​(java.lang.String url)
        Set the URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
        Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's child.scm.url.inherit.append.path="false"
        Parameters:
        url - a url object.
      • isChildScmConnectionInheritAppendPath

        public boolean isChildScmConnectionInheritAppendPath()
      • setChildScmConnectionInheritAppendPath

        public void setChildScmConnectionInheritAppendPath​(boolean childScmConnectionInheritAppendPath)
      • isChildScmDeveloperConnectionInheritAppendPath

        public boolean isChildScmDeveloperConnectionInheritAppendPath()
      • setChildScmDeveloperConnectionInheritAppendPath

        public void setChildScmDeveloperConnectionInheritAppendPath​(boolean childScmDeveloperConnectionInheritAppendPath)
      • isChildScmUrlInheritAppendPath

        public boolean isChildScmUrlInheritAppendPath()
      • setChildScmUrlInheritAppendPath

        public void setChildScmUrlInheritAppendPath​(boolean childScmUrlInheritAppendPath)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()