Record Class Graph.Edge<V,E>

java.lang.Object
java.lang.Record
rgu.transport.algorithms.collections.Graph.Edge<V,E>
Type Parameters:
V - the vertex type
E - the edge type
Record Components:
from - the vertex the edge comes from, not null
to - the vertex the edge goes to, not null
value - the value of the edge, not null
Enclosing interface:
Graph<V,E>
public static record Graph.Edge<V,E>(V from, V to, E value) extends Record
Record type representing an edge with its end points.
Author:
Lee A. Christie

  • Constructor Summary

    Constructors
    Constructor
    Description
    Edge(V from, V to, E value)
    Canonical constructor with null-checks.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    V
    from()
    Returns the value of the from record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    V
    to()
    Returns the value of the to record component.
    final String
    toString()
    Returns a string representation of this record class.
    E
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Edge

      public Edge(V from, V to, E value)
      Canonical constructor with null-checks.
      Parameters:
      from - the vertex the edge comes from, not null
      to - the vertex the edge goes to, not null
      value - the value of the edge, not null

  • Method Details

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

    • from

      public V from()
      Returns the value of the from record component.
      Returns:
      the value of the from record component

    • to

      public V to()
      Returns the value of the to record component.
      Returns:
      the value of the to record component

    • value

      public E value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component