Package com.tnsai.server.hooks

Record Class HookAction

java.lang.Object

java.lang.Record

com.tnsai.server.hooks.HookAction

Record Components:

type - action type (command or log)

command - shell command to execute (for COMMAND type)

message - log message (for LOG type); supports ${tool} placeholder

public record HookAction(HookActionType type, String command, String message)
extends Record

Action to execute when a hook fires.

Constructor Summary

Constructors

Constructor	Description
HookAction(HookActionType type, String command, String message)	Creates an instance of a HookAction record class.

Method Summary

Modifier and Type	Method	Description
String	command()	Returns the value of the command record component.
static HookAction	command(String command)	Convenience factory for command actions.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static HookAction	log(String message)	Convenience factory for log actions.
String	message()	Returns the value of the message record component.
final String	toString()	Returns a string representation of this record class.
HookActionType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

HookAction

public HookAction(HookActionType type,
 String command,
 String message)

Creates an instance of a HookAction record class.

Parameters:

type - the value for the type record component

command - the value for the command record component

message - the value for the message record component

Method Details

command

public static HookAction command(String command)

Convenience factory for command actions.

log

public static HookAction log(String message)

Convenience factory for log actions.

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.

type

public HookActionType type()

Returns the value of the type record component.

Returns:

the value of the type record component

command

public String command()

Returns the value of the command record component.

Returns:

the value of the command record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component