Package org.variantsync.diffdetective.variation.diff.view

Record Class ViewSource

java.lang.Object
java.lang.Record
org.variantsync.diffdetective.variation.diff.view.ViewSource
Record Components:
target - The original variation tree/diff on which the view was created.
relevance - The relevance predicate that was used to create the view.
All Implemented Interfaces:
Source
public record ViewSource(Source target, Relevance relevance, String method) extends Record implements Source
A Source that remembers that a variation tree or diff represents a view on another variation tree or diff.

  • Field Details

    • target

      private final Source target
      The field for the target record component.

    • relevance

      private final Relevance relevance
      The field for the relevance record component.

    • method

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

  • Constructor Details

    • ViewSource

      public ViewSource(Source target, Relevance relevance, String method)
      Creates an instance of a ViewSource record class.
      Parameters:
      target - the value for the target record component
      relevance - the value for the relevance record component
      method - the value for the method 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

    • getSources

      public List<Source> getSources()
      Description copied from interface: Source
      Returns a list of sources that influenced this source. Noteworthy processing steps and incorporation of multiple sources are implemented as a tree of sources. This functions returns the children of this source.

      By default, the first child source is treated specially in Source.getRootSource().

      Specified by:
      getSources in interface Source
      Returns:
      an empty list by default

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

    • target

      public Source target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component

    • relevance

      public Relevance relevance()
      Returns the value of the relevance record component.
      Returns:
      the value of the relevance record component

    • method

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