Package com.tnsai.hooks.events

Record Class AgentStop

java.lang.Object

java.lang.Record

com.tnsai.hooks.events.AgentStop

Record Components:

eventId - ULID-shaped correlation id

timestamp - when shutdown was initiated

context - surrounding hook context

reason - why the agent is stopping

cause - associated throwable when reason is StopReason.CRASHED; empty otherwise

All Implemented Interfaces:

AgentHookEvent, HookEvent

public record AgentStop(String eventId, Instant timestamp, HookContext context, StopReason reason, Optional<Throwable> cause)
extends Record
implements AgentHookEvent

Fires when an agent is shutting down (issue #60). Use for flush-and-close: drain telemetry batches, close MCP connections, persist session state.

reason is always populated; cause is present only when reason is StopReason.CRASHED. Other reasons carry an empty Optional.

Orchestrator (follow-up) fires this from a shutdown hook AND the normal stop path, with a guard so each agent instance only emits one.

Since:

0.5.0 (issue #60)

Constructor Summary

Constructors

Constructor	Description
AgentStop(String eventId, Instant timestamp, HookContext context, StopReason reason, Optional<Throwable> cause)	Creates an instance of a AgentStop record class.

Method Summary

Modifier and Type	Method	Description
Optional<Throwable>	cause()	Returns the value of the cause record component.
HookContext	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	eventId()	Returns the value of the eventId record component.
String	eventType()	Short stable string identifier of the event kind, e.g.
final int	hashCode()	Returns a hash code value for this object.
StopReason	reason()	Returns the value of the reason record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AgentStop

public AgentStop(String eventId,
 Instant timestamp,
 HookContext context,
 StopReason reason,
 Optional<Throwable> cause)

Creates an instance of a AgentStop record class.

Parameters:

eventId - the value for the eventId record component

timestamp - the value for the timestamp record component

context - the value for the context record component

reason - the value for the reason record component

cause - the value for the cause record component

Method Details

eventType

public String eventType()

Description copied from interface: HookEvent

Short stable string identifier of the event kind, e.g. "PreToolUse". Default implementation derives it from the concrete record's simple class name; concrete records may override if a different naming is desirable.

Specified by:

eventType in interface HookEvent

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.

eventId

public String eventId()

Returns the value of the eventId record component.

Specified by:

eventId in interface HookEvent

Returns:

the value of the eventId record component

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface HookEvent

Returns:

the value of the timestamp record component

context

public HookContext context()

Returns the value of the context record component.

Specified by:

context in interface HookEvent

Returns:

the value of the context record component

reason

public StopReason reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

cause

public Optional<Throwable> cause()

Returns the value of the cause record component.

Returns:

the value of the cause record component