Package com.tnsai.hooks

Record Class HookResult.Modify<E extends HookEvent>

java.lang.Object
java.lang.Record
com.tnsai.hooks.HookResult.Modify<E>
Record Components:
newEvent - replacement event; must be the same concrete type as the original (the dispatcher does not cast across types)
rationale - why the hook modified — surfaces in the audit log
All Implemented Interfaces:
HookResult<E>
Enclosing interface:
HookResult<E extends HookEvent>
public static record HookResult.Modify<E extends HookEvent>(E extends HookEvent newEvent, String rationale) extends Record implements HookResult<E>
Replace the event for the rest of the chain. Subsequent hooks see newEvent; the operation, when it eventually runs, uses the modified event's payload (e.g. rewritten tool input).

  • Constructor Details

    • Modify

      public Modify(E newEvent, String rationale)
      Creates an instance of a Modify record class.
      Parameters:
      newEvent - the value for the newEvent record component
      rationale - the value for the rationale record component

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

    • newEvent

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

    • rationale

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