Record Class Edge

java.lang.Object
java.lang.Record
com.google.adk.workflow.Edge
Record Components:
from - The node whose completion fires this edge.
to - The node this edge triggers.
routes - The routes that select this edge. An empty list makes the edge unconditional.
@Experimental public record Edge(Node from, Node to, com.google.common.collect.ImmutableList<Route> routes) extends Record
A connection between two nodes in a workflow graph. An edge with no routes fires whenever its source completes; any other edge fires only when one of its routes is selected, as Route describes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Edge(Node from, Node to)
    Creates an unconditional edge.
    Edge(Node from, Node to, Route route)
    Creates an edge selected by a single route.
    Edge(Node from, Node to, com.google.common.collect.ImmutableList<Route> routes)
    Creates an instance of a Edge record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Node
    from()
    Returns the value of the from record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isUnconditional()
    Returns true if this edge fires regardless of the routes its source emits.
    com.google.common.collect.ImmutableList<Route>
    routes()
    Returns the value of the routes record component.
    Node
    to()
    Returns the value of the to record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Edge

      public Edge(Node from, Node to, com.google.common.collect.ImmutableList<Route> routes)
      Creates an instance of a Edge record class.
      Parameters:
      from - the value for the from record component
      to - the value for the to record component
      routes - the value for the routes record component

    • Edge

      public Edge(Node from, Node to)
      Creates an unconditional edge.

    • Edge

      public Edge(Node from, Node to, Route route)
      Creates an edge selected by a single route.

  • Method Details

    • isUnconditional

      public boolean isUnconditional()
      Returns true if this edge fires regardless of the routes its source emits.

    • 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 Node from()
      Returns the value of the from record component.
      Returns:
      the value of the from record component

    • to

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

    • routes

      public com.google.common.collect.ImmutableList<Route> routes()
      Returns the value of the routes record component.
      Returns:
      the value of the routes record component