Record Class RedactionResult

java.lang.Object

java.lang.Record

com.shaft.pilot.security.RedactionResult

Record Components:

redactedText - sanitized primary text

redactedEvidence - sanitized evidence

appliedRules - names of rules that changed content

removedFields - field or attribute names removed without original values

safeSummary - safe summary suitable for audit logs

public record RedactionResult(String redactedText, List<EvidenceReference> redactedEvidence, Set<String> appliedRules, Set<String> removedFields, String safeSummary)
extends Record

Redacted request content and a safe summary.

Constructor Summary

Constructors

Constructor	Description
RedactionResult(String redactedText, List<EvidenceReference> redactedEvidence, Set<String> appliedRules, Set<String> removedFields, String safeSummary)	Creates an immutable redaction result.

Method Summary

Modifier and Type	Method	Description
Set<String>	appliedRules()	Returns the value of the appliedRules record component.
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.
List<EvidenceReference>	redactedEvidence()	Returns the value of the redactedEvidence record component.
String	redactedText()	Returns the value of the redactedText record component.
Set<String>	removedFields()	Returns the value of the removedFields record component.
String	safeSummary()	Returns the value of the safeSummary record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RedactionResult

public RedactionResult(String redactedText,
 List<EvidenceReference> redactedEvidence,
 Set<String> appliedRules,
 Set<String> removedFields,
 String safeSummary)

Creates an immutable redaction result.

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.

redactedText

public String redactedText()

Returns the value of the redactedText record component.

Returns:

the value of the redactedText record component

redactedEvidence

public List<EvidenceReference> redactedEvidence()

Returns the value of the redactedEvidence record component.

Returns:

the value of the redactedEvidence record component

appliedRules

public Set<String> appliedRules()

Returns the value of the appliedRules record component.

Returns:

the value of the appliedRules record component

removedFields

public Set<String> removedFields()

Returns the value of the removedFields record component.

Returns:

the value of the removedFields record component

safeSummary

public String safeSummary()

Returns the value of the safeSummary record component.

Returns:

the value of the safeSummary record component