Package com.tnsai.hooks

Record Class HookResult.Block<E extends HookEvent>

java.lang.Object
java.lang.Record
com.tnsai.hooks.HookResult.Block<E>
Record Components:
reason - human-readable explanation; surfaces in audit logs and may be shown to the agent / end user
severity - operator-facing severity tier
All Implemented Interfaces:
HookResult<E>
Enclosing interface:
HookResult<E extends HookEvent>
public static record HookResult.Block<E extends HookEvent>(String reason, Severity severity) extends Record implements HookResult<E>
Refuse the operation. The dispatcher stops chain execution and the underlying operation is told to abort with this reason.

  • Constructor Details

    • Block

      public Block(String reason, Severity severity)
      Creates an instance of a Block record class.
      Parameters:
      reason - the value for the reason record component
      severity - the value for the severity 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.

    • reason

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

    • severity

      public Severity severity()
      Returns the value of the severity record component.
      Returns:
      the value of the severity record component