Package dev.agenor.core.dialogue

Record Class CommitmentEvent

java.lang.Object
java.lang.Record
dev.agenor.core.dialogue.CommitmentEvent
Record Components:
timestamp - when the transition occurred
fromState - the previous state
toState - the new state
triggeredBy - the agent or message that triggered the transition
description - optional description of the transition
public record CommitmentEvent(Instant timestamp, CommitmentState fromState, CommitmentState toState, String triggeredBy, String description) extends Record
Records a state transition in a commitment's lifecycle.
Since:
0.5.0

  • Constructor Details

    • CommitmentEvent

      public CommitmentEvent(Instant timestamp, CommitmentState fromState, CommitmentState toState, String triggeredBy, String description)
      Creates an instance of a CommitmentEvent record class.
      Parameters:
      timestamp - the value for the timestamp record component
      fromState - the value for the fromState record component
      toState - the value for the toState record component
      triggeredBy - the value for the triggeredBy record component
      description - the value for the description record component

  • Method Details

    • created

      public static CommitmentEvent created(String triggeredBy, String description)
      Creates an event for the initial commitment creation.

    • activated

      public static CommitmentEvent activated(String triggeredBy)
      Creates an activation event.

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

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • fromState

      public CommitmentState fromState()
      Returns the value of the fromState record component.
      Returns:
      the value of the fromState record component

    • toState

      public CommitmentState toState()
      Returns the value of the toState record component.
      Returns:
      the value of the toState record component

    • triggeredBy

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

    • description

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