Package org.variantsync.diffdetective.variation.tree.source

Record Class GitSource

java.lang.Object
java.lang.Record
org.variantsync.diffdetective.variation.tree.source.GitSource
All Implemented Interfaces:
Source
public record GitSource(Repository repository, String commitHash, Path path) extends Record implements Source
A file at a specific commit in a Git repository.

The parameters of this record should be suitably chosen, so that the following commands can be executed in a shell to obtain the referenced source code: git clone "${repository.getRemoteURI()}" repository cd repository git switch -d "$commitHash" cat "$path"

  • Field Details

    • repository

      private final Repository repository
      The field for the repository record component.

    • commitHash

      private final String commitHash
      The field for the commitHash record component.

    • path

      private final Path path
      The field for the path record component.

  • Constructor Details

    • GitSource

      public GitSource(Repository repository, String commitHash, Path path)
      Creates an instance of a GitSource record class.
      Parameters:
      repository - the value for the repository record component
      commitHash - the value for the commitHash record component
      path - the value for the path record component

  • Method Details

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • getSourceExplanation

      public String getSourceExplanation()
      Description copied from interface: Source
      Returns a short, one line explanation or identifier of this source. The result is used by Source.shallowExplanation() and is formatted together with Source.getSourceArguments() like "sourceExplanation(argument1, argument2)".
      Specified by:
      getSourceExplanation in interface Source

    • getSourceArguments

      public List<Object> getSourceArguments()
      Description copied from interface: Source
      Returns a list of arguments required to understand this source. Each argument in the result list should represent a string without newlines and will be formatted together with Source.getSourceExplanation() like "sourceExplanation(argument1, argument2)" by Source.shallowExplanation(). This method is only intended to access the arguments for printing. In case access to the well-typed object is required, use Source.<T>findFirst(org.variantsync.diffdetective.util.Source,java.lang.Class<T>) or Source.<T>findAll(org.variantsync.diffdetective.util.Source,java.lang.Class<T>) and use the accessors of the underlying type.

      For ease of implementing Source, the return value is a list of Objects instead of a list of Strings to allow code like List.of(arg0, arg1, arg2) instead of List.of(arg0.toString(), arg1.toString(), arg2.toString()). Users of this function should assume nothing from the returned objects except that Object.toString() is well behaved.

      Specified by:
      getSourceArguments in interface Source
      Returns:
      an empty list by default
      See Also:

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • repository

      public Repository repository()
      Returns the value of the repository record component.
      Returns:
      the value of the repository record component

    • commitHash

      public String commitHash()
      Returns the value of the commitHash record component.
      Returns:
      the value of the commitHash record component

    • path

      public Path path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component