Package org.ossreviewtoolkit.model

Class VcsInfoCurationData

  • All Implemented Interfaces:
    
public final class VcsInfoCurationData

    Bundles curation data for Version Control System information.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final VcsType getType() The type of the VCS, for example Git, GitRepo, Mercurial, etc.
      final String getUrl() The URL to the VCS repository.
      final String getRevision() The VCS-specific revision (tag, branch, SHA1) that the version of the package maps to.
      final String getPath() The path inside the VCS to take into account, if any.
      final VcsInfoCurationData merge(VcsInfoCurationData other) Merge with other curation data.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getType

         final VcsType getType()

        The type of the VCS, for example Git, GitRepo, Mercurial, etc.

      • getUrl

         final String getUrl()

        The URL to the VCS repository.

      • getRevision

         final String getRevision()

        The VCS-specific revision (tag, branch, SHA1) that the version of the package maps to.

      • getPath

         final String getPath()

        The path inside the VCS to take into account, if any. The actual meaning depends on the VCS type. For example, for Git only this subdirectory of the repository should be cloned, or for Git Repo it is interpreted as the path to the manifest file.