Record Class FormalTreeGraph<L extends Label>

java.lang.Object
java.lang.Record
org.variantsync.diffdetective.variation.tree.graph.FormalTreeGraph<L>
Record Components:
nodes - The set of all nodes in a VariationDiff.
edges - The set of all edges in a VariationDiff.

public record FormalTreeGraph<L extends Label>(Set<VariationTreeNode<L extends Label>> nodes, Set<FormalTreeGraph.Edge<L extends Label>> edges) extends Record
A view on a VariationTree that shows the VariationTree as a list of nodes and edges. The view invalidates as soon as the viewed VariationTree is altered as the view will not update itself.
Author:
Paul Bittner
  • Field Details

  • Constructor Details

    • FormalTreeGraph

      public FormalTreeGraph(Set<VariationTreeNode<L>> nodes, Set<FormalTreeGraph.Edge<L>> edges)
      Creates an instance of a FormalTreeGraph record class.
      Parameters:
      nodes - the value for the nodes record component
      edges - the value for the edges record component
  • Method Details

    • fromTree

      public static <L extends Label> FormalTreeGraph<L> fromTree(VariationTree<L> t)
      Creates a GraphView for a given VariationTree. The produced view reflects the state of the given VariationTree as is. This means, the view is invalid as soon as the given VariationTree gets modified elsewhere.
      Parameters:
      t - The VariationTree to view as a list of nodes and edges.
      Returns:
      the graph view
    • equals

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

      public 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
    • 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
    • nodes

      public Set<VariationTreeNode<L>> nodes()
      Returns the value of the nodes record component.
      Returns:
      the value of the nodes record component
    • edges

      public Set<FormalTreeGraph.Edge<L>> edges()
      Returns the value of the edges record component.
      Returns:
      the value of the edges record component