Class SSNMaskSanitizer

java.lang.Object
io.github.rabinarayanpatra.sanitizer.builtin.SSNMaskSanitizer
All Implemented Interfaces:
FieldSanitizer<String>

public class SSNMaskSanitizer extends Object implements FieldSanitizer<String>
Sanitizer that masks a U.S. Social Security Number (SSN), revealing only the last four digits.

Non-digit characters are removed before masking. If the cleaned input does not contain exactly 9 digits, the original input is returned unchanged.

 
 String input = "123-45-6789";
 String masked = new SSNMaskSanitizer().sanitize(input); // "***-**-6789"
 
 
Since:
1.0.0
See Also:
  • Constructor Details

    • SSNMaskSanitizer

      public SSNMaskSanitizer()
      Default constructor.
  • Method Details

    • sanitize

      public @Nullable String sanitize(@Nullable String in)
      Masks a Social Security Number by stripping non-digit characters and preserving only the last four digits.
      Specified by:
      sanitize in interface FieldSanitizer<String>
      Parameters:
      in - the input SSN string
      Returns:
      the masked SSN, or the original input if the cleaned string is not 9 digits; null if input is null