Package org.approvej.scrub

Class RegexScrubber

java.lang.Object

org.approvej.scrub.RegexScrubber

All Implemented Interfaces:

Function<String,String>, UnaryOperator<String>, Scrubber<String>

Direct Known Subclasses:

DateScrubber, InstantScrubber

@NullMarked
public class RegexScrubber
extends Object
implements Scrubber<String>

Scrubs a String by replacing all occurrences of a pattern by applying the given replacement Function for each finding.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegexScrubber.RegexScrubberBuilder	Builder for creating a RegexScrubber.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<Integer,String>	NUMBERED_REPLACEMENT	Replaces each match with "[scrubbed #]" where '#' is the number of the distinct found string.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RegexScrubber(Pattern pattern, Function<Integer,String> replacement)	Creates a RegexScrubber.RegexScrubberBuilder with the given pattern and replacement Function.

Method Summary

Modifier and Type	Method	Description
String	apply(String unscrubbedValue)
static RegexScrubber.RegexScrubberBuilder	stringsMatching(String pattern)	Creates a RegexScrubber.RegexScrubberBuilder with the given pattern.
static RegexScrubber.RegexScrubberBuilder	stringsMatching(Pattern pattern)	Creates a RegexScrubber.RegexScrubberBuilder with the given pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

NUMBERED_REPLACEMENT

public static final Function<Integer,String> NUMBERED_REPLACEMENT

Replaces each match with "[scrubbed #]" where '#' is the number of the distinct found string.

E.g. Hello World! with a pattern of [aeiou] will result in "H[scrubbed 1]ll[scrubbed 2] W[scrubbed 2]rld!"

Constructor Details

RegexScrubber

protected RegexScrubber(Pattern pattern,
 Function<Integer,String> replacement)

Creates a RegexScrubber.RegexScrubberBuilder with the given pattern and replacement Function.

Parameters:

pattern - the pattern matching the string to be scrubbed as String

replacement - a function that receives the finding index and returns the replacement string

See Also:

• Pattern.compile(String)

Method Details

stringsMatching

public static RegexScrubber.RegexScrubberBuilder stringsMatching(Pattern pattern)

Creates a RegexScrubber.RegexScrubberBuilder with the given pattern.

Parameters:

pattern - the Pattern matching the strings to be scrubbed

Returns:

a RegexScrubber.RegexScrubberBuilder with the given pattern

stringsMatching

public static RegexScrubber.RegexScrubberBuilder stringsMatching(String pattern)

Creates a RegexScrubber.RegexScrubberBuilder with the given pattern.

Parameters:

pattern - the pattern matching the string to be scrubbed as String

Returns:

a RegexScrubber.RegexScrubberBuilder with the given pattern

See Also:

• Pattern.compile(String)

apply

public String apply(String unscrubbedValue)

Specified by:

apply in interface Function<String,String>