Package org.variantsync.diffdetective.variation.diff.source

Record Class LineGraphFileSource

java.lang.Object
java.lang.Record
org.variantsync.diffdetective.variation.diff.source.LineGraphFileSource
Record Components:
graphHeader - The first line of the VariationDiff in the linegraph file (starting with "t #).
file - The path to the linegraph file.
All Implemented Interfaces:
Source
public record LineGraphFileSource(String graphHeader, Path file) extends Record implements Source
A source for VariationDiffs that were parsed from a linegraph file.

  • Field Details

    • graphHeader

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

    • file

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

  • Constructor Details

    • LineGraphFileSource

      public LineGraphFileSource(String graphHeader, Path file)
      Creates an instance of a LineGraphFileSource record class.
      Parameters:
      graphHeader - the value for the graphHeader record component
      file - the value for the file record component

  • Method Details

    • 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:

    • toString

      public final 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

    • 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.

    • graphHeader

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

    • file

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