Package io.github.rabinarayanpatra.sanitizer.builtin

Class SafeFilenameSanitizer

java.lang.Object
io.github.rabinarayanpatra.sanitizer.builtin.SafeFilenameSanitizer
All Implemented Interfaces:
FieldSanitizer<String>
public class SafeFilenameSanitizer extends Object implements FieldSanitizer<String>
Sanitizer that replaces characters not allowed in most filenames with underscores.

This includes characters like \ / : * ? " < > |, which are restricted on Windows and other common filesystems. Useful for safely storing user-generated filenames or exporting reports. 

 
 String input = "user:data/report|2025?.pdf";
 String safe = new SafeFilenameSanitizer().sanitize(input); // "user_data_report_2025_.pdf"
Since:
1.0.0
See Also:

  • Constructor Details

    • SafeFilenameSanitizer

      public SafeFilenameSanitizer()
      Default constructor.

  • Method Details

    • sanitize

      public @Nullable String sanitize(@Nullable String in)
      Replaces filesystem-reserved characters with underscores in the input string.
      Specified by:
      sanitize in interface FieldSanitizer<String>
      Parameters:
      in - the proposed filename string
      Returns:
      a sanitized filename-safe string, or null if input is null