Package com.tnsai.quality.security

Record Class SecretFilter.ScrubResult

java.lang.Object
java.lang.Record
com.tnsai.quality.security.SecretFilter.ScrubResult
Record Components:
scrubbedText - the redacted text
detections - map of pattern name to count of matches
Enclosing class:
SecretFilter
public static record SecretFilter.ScrubResult(String scrubbedText, Map<String,Integer> detections) extends Record
Result of a scrub operation with metadata.

  • Constructor Details

    • ScrubResult

      public ScrubResult(String scrubbedText, Map<String,Integer> detections)
      Creates an instance of a ScrubResult record class.
      Parameters:
      scrubbedText - the value for the scrubbedText record component
      detections - the value for the detections record component

  • Method Details

    • hasDetections

      public boolean hasDetections()
      Returns true if any secrets were detected and scrubbed.
      Returns:
      true if secrets found

    • totalRedactions

      public int totalRedactions()
      Returns total number of redactions made.
      Returns:
      total redaction count

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

    • scrubbedText

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

    • detections

      public Map<String,Integer> detections()
      Returns the value of the detections record component.
      Returns:
      the value of the detections record component