Package com.tnsai.quality.redaction

Record Class RedactionPattern

java.lang.Object

java.lang.Record

com.tnsai.quality.redaction.RedactionPattern

Record Components:

name - stable identifier ("email", "credit_card")

regex - compiled pattern

severity - how serious a match is

validator - optional secondary check on the matched substring; return true to accept the match

public record RedactionPattern(String name, Pattern regex, Severity severity, Predicate<String> validator)
extends Record

One named pattern in a redactor's catalog (issue #80).

Pairs a compiled Pattern with a stable name, severity tier, and an optional validator for patterns that have a structural check beyond the regex (Luhn check on credit cards, TC Kimlik checksum). When the validator is present and returns false for a regex match, the match is suppressed — keeps false positives down on numeric patterns that are easy to false-match.

Since:

0.5.0 (issue #80)

Constructor Summary

Constructors

Constructor	Description
RedactionPattern(String name, Pattern regex, Severity severity, Predicate<String> validator)	Creates an instance of a RedactionPattern record class.

Method Summary

Modifier and Type	Method	Description
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	name()	Returns the value of the name record component.
static RedactionPattern	of(String name, String regex, Severity severity)	Convenience: pattern without a structural validator.
static RedactionPattern	of(String name, String regex, Severity severity, Predicate<String> validator)	Convenience: pattern with a custom validator.
Pattern	regex()	Returns the value of the regex record component.
Severity	severity()	Returns the value of the severity record component.
final String	toString()	Returns a string representation of this record class.
Predicate<String>	validator()	Returns the value of the validator record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RedactionPattern

public RedactionPattern(String name,
 Pattern regex,
 Severity severity,
 Predicate<String> validator)

Creates an instance of a RedactionPattern record class.

Parameters:

name - the value for the name record component

regex - the value for the regex record component

severity - the value for the severity record component

validator - the value for the validator record component

Method Details

of

public static RedactionPattern of(String name,
 String regex,
 Severity severity)

Convenience: pattern without a structural validator.

of

public static RedactionPattern of(String name,
 String regex,
 Severity severity,
 Predicate<String> validator)

Convenience: pattern with a custom validator.

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

regex

public Pattern regex()

Returns the value of the regex record component.

Returns:

the value of the regex record component

severity

public Severity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

validator

public Predicate<String> validator()

Returns the value of the validator record component.

Returns:

the value of the validator record component