Package com.tnsai.quality.redaction

Record Class RedactionResult

java.lang.Object
java.lang.Record
com.tnsai.quality.redaction.RedactionResult
public record RedactionResult(String text, List<RedactionFinding> findings) extends Record
Output of a Redactor.scrubString(java.lang.String, com.tnsai.quality.redaction.RedactionContext) call (issue #80): the redacted text plus the RedactionFindings the redactor matched.

Returning findings as part of the result (rather than via a thread-local "lastFindings" lookup) keeps redactors stateless and thread-safe — the same redactor instance can be shared across the whole framework.

Since:
0.5.0 (issue #80)

  • Constructor Details

    • RedactionResult

      public RedactionResult(String text, List<RedactionFinding> findings)
      Creates an instance of a RedactionResult record class.
      Parameters:
      text - the value for the text record component
      findings - the value for the findings record component

  • Method Details

    • hadFindings

      public boolean hadFindings()
      true when the redactor matched at least one pattern.

    • unchanged

      public static RedactionResult unchanged(String text)
      Convenience: result for a clean input that produced no findings.

    • 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.

    • text

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

    • findings

      public List<RedactionFinding> findings()
      Returns the value of the findings record component.
      Returns:
      the value of the findings record component