Package org.ossreviewtoolkit.model

Class VcsInfo

  • All Implemented Interfaces:
    
public final class VcsInfo

    Bundles general 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.
      final VcsInfo merge(VcsInfo other) Merge two sources of VCS information by mixing and matching fields to get as complete information as possible.
      final VcsInfo normalize() Return this VcsInfo in normalized form by applying normalizeVcsUrl to the url.
      final VcsInfoCurationData toCuration() Return a VcsInfoCurationData with the properties from this VcsInfo.

      • 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 the VCS supports checking out only a subdirectory, only this path is checked out.

      • merge

         final VcsInfo merge(VcsInfo other)

        Merge two sources of VCS information by mixing and matching fields to get as complete information as possible. If in question, information in this instance has precedence over information in the other instance.