Package com.tnsai.coordination.supervisor

Record Class Guardrail.GuardrailResult

java.lang.Object

java.lang.Record

com.tnsai.coordination.supervisor.Guardrail.GuardrailResult

Record Components:

allowed - whether the action is permitted

reason - explanation for the decision

severity - severity level of the decision

Enclosing interface:

Guardrail

public static record Guardrail.GuardrailResult(boolean allowed, String reason, Guardrail.GuardrailSeverity severity)
extends Record

Result of a guardrail check.

Constructor Summary

Constructors

Constructor	Description
GuardrailResult(boolean allowed, String reason, Guardrail.GuardrailSeverity severity)	Creates a GuardrailResult with validation.

Method Summary

Modifier and Type	Method	Description
static Guardrail.GuardrailResult	allow()	Creates an allowed result.
boolean	allowed()	Returns the value of the allowed record component.
static Guardrail.GuardrailResult	blocked(String reason)	Creates a blocked result.
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.
String	reason()	Returns the value of the reason record component.
Guardrail.GuardrailSeverity	severity()	Returns the value of the severity record component.
final String	toString()	Returns a string representation of this record class.
static Guardrail.GuardrailResult	warning(String reason)	Creates a warning result (allowed but with warning).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GuardrailResult

public GuardrailResult(boolean allowed,
 String reason,
 Guardrail.GuardrailSeverity severity)

Creates a GuardrailResult with validation.

Method Details

allow

public static Guardrail.GuardrailResult allow()

Creates an allowed result.

Returns:

allowed result with INFO severity

blocked

public static Guardrail.GuardrailResult blocked(String reason)

Creates a blocked result.

Parameters:

reason - why the action was blocked

Returns:

blocked result with BLOCK severity

warning

public static Guardrail.GuardrailResult warning(String reason)

Creates a warning result (allowed but with warning).

Parameters:

reason - warning message

Returns:

allowed result with WARNING severity

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

allowed

public boolean allowed()

Returns the value of the allowed record component.

Returns:

the value of the allowed record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

severity

public Guardrail.GuardrailSeverity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component