Package org.approvej.scrub

Class Scrubbers

java.lang.Object

org.approvej.scrub.Scrubbers

@NullMarked
public class Scrubbers
extends Object

Collection of static methods to create Scrubber instances.

Method Summary

Modifier and Type	Method	Description
static RegexScrubber	basicIsoDates()	Creates a DateTimeScrubber for basic ISO-8601 dates, like 20190225, or 20190225+02:00.
static RegexScrubber	dateTimeFormat(String dateTimePattern)	Creates DateTimeScrubber to replace date/time strings of the given pattern localized by the default Locale.
static RegexScrubber	dateTimeFormat(String dateTimePattern, Locale locale)	Creates DateTimeScrubber to replace date/time strings of the given pattern localized by the given locale.
static RegexScrubber	isoDates()	Creates a DateTimeScrubber for ISO-8601 dates, like 2019-02-25, or 2019-02-25+02:00.
static RegexScrubber	isoDateTimes()	Creates a DateTimeScrubber for ISO-8601 date/times, like 2019-02-25T12:34:56, 2019-02-25T12:34:56.123456789, 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
static RegexScrubber	isoDateTimes(Locale locale)	Creates a DateTimeScrubber for ISO-8601 date/times, like 2019-02-25T12:34:56, 2019-02-25T12:34:56.123456789, 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
static RegexScrubber	isoInstants()	Creates a DateTimeScrubber for ISO-8601 instants, like 2019-02-25T12:34:56.123456789+02:00, or 2019-02-25T12:34:56.123456789Z.
static RegexScrubber	isoLocalDates()	Creates a DateTimeScrubber for ISO-8601 local dates, like 2019-02-25.
static RegexScrubber	isoLocalDateTimes()	Creates a DateTimeScrubber for ISO-8601 local date/times, like 12:34:56, 12:34:56+02:00, 12:34:56.123456789, or 12:34:56.123456789+02:00.
static RegexScrubber	isoLocalTimes()	Creates a DateTimeScrubber for ISO-8601 local times, like 12:34:56, or 12:34:56.123456789.
static RegexScrubber	isoOffsetDates()	Creates a DateTimeScrubber for ISO-8601 offset dates, like 2019-02-25+02:00.
static RegexScrubber	isoOffsetDateTimes()	Creates a DateTimeScrubber for ISO-8601 offset date/times, like 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00.
static RegexScrubber	isoOffsetTimes()	Creates a DateTimeScrubber for ISO-8601 offset times, like 12:34:56+02:00, or 12:34:56.123456789+02:00.
static RegexScrubber	isoOrdinalDates()	Creates a DateTimeScrubber for ISO-8601 ordinal dates, like 2019-86, or 2019-86+02:00:00.
static RegexScrubber	isoTimes()	Creates a DateTimeScrubber for ISO-8601 times, like 12:34:56, 12:34:56+02:00, 12:34:56.123456789, or 12:34:56.123456789+02:00.
static RegexScrubber	isoWeekDates()	Creates a DateTimeScrubber for ISO-8601 week dates, like 2019-W09-1, or 2019-W09-1+02:00:00.
static RegexScrubber	isoZonedDateTimes()	Creates a DateTimeScrubber for ISO-8601 zoned date/times, like 2019-02-25T12:34:56+02:00, 2019-02-25T12:34:56.123456789+02:00, 2019-02-25T12:34:56+02:00[Europe/Berlin], or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
static RegexScrubber	isoZonedDateTimes(Locale locale)	Creates a DateTimeScrubber for ISO-8601 zoned date/times, like 2019-02-25T12:34:56+02:00, 2019-02-25T12:34:56.123456789+02:00, 2019-02-25T12:34:56+02:00[Europe/Berlin], or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
static RelativeDateScrubber	relativeDates(DateTimeFormatter dateFormatPattern)	Creates a Scrubber to replace date strings of the given pattern with relative descriptions, like [today], [yesterday], [2 days from now] , [21 days ago].
static RegexScrubber	rfc1123DateTimes()	Creates a DateTimeScrubber for RFC-1123 date/times, like Mon, 35 Feb 2019 12:34:56 GMT.
static RegexScrubber	stringsMatching(String pattern)	Creates a RegexScrubber with the given pattern.
static RegexScrubber	stringsMatching(Pattern pattern)	Creates a RegexScrubber with the given pattern.
static RegexScrubber	uuids()	RegexScrubber for UUIDs.

Methods inherited from class java.lang.Object

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

Method Details

stringsMatching

public static RegexScrubber stringsMatching(Pattern pattern)

Creates a RegexScrubber with the given pattern.

Parameters:

pattern - the Pattern matching the strings to be scrubbed

Returns:

a RegexScrubber with the given pattern

stringsMatching

public static RegexScrubber stringsMatching(String pattern)

Creates a RegexScrubber with the given pattern.

Parameters:

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

Returns:

a RegexScrubber with the given pattern

See Also:

• Pattern.compile(String)

dateTimeFormat

public static RegexScrubber dateTimeFormat(String dateTimePattern,
 Locale locale)

Creates DateTimeScrubber to replace date/time strings of the given pattern localized by the given locale.

Parameters:

dateTimePattern - a pattern as defined by DateTimeFormatter

locale - the Locale to localize the date/time pattern (influences names of months or weekdays for example)

Returns:

a DateTimeScrubber for the given date/time pattern

See Also:

• DateTimeFormatter

dateTimeFormat

public static RegexScrubber dateTimeFormat(String dateTimePattern)

Creates DateTimeScrubber to replace date/time strings of the given pattern localized by the default Locale.

Parameters:

dateTimePattern - a pattern as defined by DateTimeFormatter

Returns:

a DateTimeScrubber for the given date/time pattern

See Also:

• DateTimeFormatter
• Locale.getDefault()

isoLocalDates

public static RegexScrubber isoLocalDates()

Creates a DateTimeScrubber for ISO-8601 local dates, like 2019-02-25.

Returns:

a DateTimeScrubber for ISO-8601 local dates

See Also:

• DateTimeFormatter.ISO_LOCAL_DATE

isoOffsetDates

public static RegexScrubber isoOffsetDates()

Creates a DateTimeScrubber for ISO-8601 offset dates, like 2019-02-25+02:00.

Returns:

a DateTimeScrubber for ISO-8601 offset dates

See Also:

• DateTimeFormatter.ISO_OFFSET_DATE

isoDates

public static RegexScrubber isoDates()

Creates a DateTimeScrubber for ISO-8601 dates, like 2019-02-25, or 2019-02-25+02:00.

Returns:

a DateTimeScrubber for ISO-8601 dates

See Also:

• DateTimeFormatter.ISO_DATE

isoLocalTimes

public static RegexScrubber isoLocalTimes()

Creates a DateTimeScrubber for ISO-8601 local times, like 12:34:56, or 12:34:56.123456789.

Returns:

a DateTimeScrubber for ISO-8601 local times

See Also:

• DateTimeFormatter.ISO_LOCAL_TIME

isoOffsetTimes

public static RegexScrubber isoOffsetTimes()

Creates a DateTimeScrubber for ISO-8601 offset times, like 12:34:56+02:00, or 12:34:56.123456789+02:00.

Returns:

a DateTimeScrubber for ISO-8601 offset times

See Also:

• DateTimeFormatter.ISO_OFFSET_TIME

isoTimes

public static RegexScrubber isoTimes()

Creates a DateTimeScrubber for ISO-8601 times, like 12:34:56, 12:34:56+02:00, 12:34:56.123456789, or 12:34:56.123456789+02:00.

Returns:

a DateTimeScrubber for ISO-8601 times

See Also:

• DateTimeFormatter.ISO_TIME

isoLocalDateTimes

public static RegexScrubber isoLocalDateTimes()

Creates a DateTimeScrubber for ISO-8601 local date/times, like 12:34:56, 12:34:56+02:00, 12:34:56.123456789, or 12:34:56.123456789+02:00.

Returns:

a DateTimeScrubber for ISO-8601 local date/times

See Also:

• DateTimeFormatter.ISO_LOCAL_DATE_TIME

isoOffsetDateTimes

public static RegexScrubber isoOffsetDateTimes()

Creates a DateTimeScrubber for ISO-8601 offset date/times, like 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00.

Returns:

a DateTimeScrubber for ISO-8601 offset date/times

See Also:

• DateTimeFormatter.ISO_OFFSET_DATE_TIME

isoZonedDateTimes

public static RegexScrubber isoZonedDateTimes(Locale locale)

Creates a DateTimeScrubber for ISO-8601 zoned date/times, like 2019-02-25T12:34:56+02:00, 2019-02-25T12:34:56.123456789+02:00, 2019-02-25T12:34:56+02:00[Europe/Berlin], or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].

Parameters:

locale - the Locale to localize the date/time pattern (influences names for zones codes)

Returns:

a DateTimeScrubber for ISO-8601 zoned date/times

See Also:

• DateTimeFormatter.ISO_ZONED_DATE_TIME

isoZonedDateTimes

public static RegexScrubber isoZonedDateTimes()

Creates a DateTimeScrubber for ISO-8601 zoned date/times, like 2019-02-25T12:34:56+02:00, 2019-02-25T12:34:56.123456789+02:00, 2019-02-25T12:34:56+02:00[Europe/Berlin], or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].

Returns:

a DateTimeScrubber for ISO-8601 zoned date/times

See Also:

• isoZonedDateTimes(Locale)

isoDateTimes

public static RegexScrubber isoDateTimes(Locale locale)

Creates a DateTimeScrubber for ISO-8601 date/times, like 2019-02-25T12:34:56, 2019-02-25T12:34:56.123456789, 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].

Parameters:

locale - the Locale to localize the date/time pattern (influences names for zones codes)

Returns:

a DateTimeScrubber for ISO-8601 date/times

See Also:

• DateTimeFormatter.ISO_DATE_TIME

isoDateTimes

public static RegexScrubber isoDateTimes()

Creates a DateTimeScrubber for ISO-8601 date/times, like 2019-02-25T12:34:56, 2019-02-25T12:34:56.123456789, 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].

Returns:

a DateTimeScrubber for ISO-8601 date/times

See Also:

• isoDateTimes(Locale)

isoOrdinalDates

public static RegexScrubber isoOrdinalDates()

Creates a DateTimeScrubber for ISO-8601 ordinal dates, like 2019-86, or 2019-86+02:00:00.

Returns:

a DateTimeScrubber for ISO-8601 ordinal dates

See Also:

• DateTimeFormatter.ISO_ORDINAL_DATE

isoWeekDates

public static RegexScrubber isoWeekDates()

Creates a DateTimeScrubber for ISO-8601 week dates, like 2019-W09-1, or 2019-W09-1+02:00:00.

Returns:

a DateTimeScrubber for ISO-8601 week dates

See Also:

• DateTimeFormatter.ISO_WEEK_DATE

isoInstants

public static RegexScrubber isoInstants()

Creates a DateTimeScrubber for ISO-8601 instants, like 2019-02-25T12:34:56.123456789+02:00, or 2019-02-25T12:34:56.123456789Z.

Returns:

a DateTimeScrubber for ISO-8601 instants

See Also:

• DateTimeFormatter.ISO_INSTANT

basicIsoDates

public static RegexScrubber basicIsoDates()

Creates a DateTimeScrubber for basic ISO-8601 dates, like 20190225, or 20190225+02:00.

Returns:

a DateTimeScrubber for basic ISO-8601 dates

See Also:

• DateTimeFormatter.BASIC_ISO_DATE

rfc1123DateTimes

public static RegexScrubber rfc1123DateTimes()

Creates a DateTimeScrubber for RFC-1123 date/times, like Mon, 35 Feb 2019 12:34:56 GMT. Note that this always uses the Locale.US.

Returns:

a DateTimeScrubber for RFC-1123 date/times

See Also:

• DateTimeFormatter.RFC_1123_DATE_TIME

uuids

public static RegexScrubber uuids()

RegexScrubber for UUIDs.

Returns:

a RegexScrubber that replaces all UUIDs

relativeDates

public static RelativeDateScrubber relativeDates(DateTimeFormatter dateFormatPattern)

Creates a Scrubber to replace date strings of the given pattern with relative descriptions, like [today], [yesterday], [2 days from now] , [21 days ago].

Parameters:

dateFormatPattern - a DateTimeFormatter to parse the dates

Returns:

a new RelativeDateScrubber with the given DateTimeFormatter.