Package org.approvej.scrub

Interface RelativeDateTimeReplacement

All Superinterfaces:

BiFunction<String,Integer,String>, Replacement<String>

public interface RelativeDateTimeReplacement
extends Replacement<String>

Replaces each match of the given dateTimePattern (as defined by DateTimeFormatter) with a relative description, like [10m ago], [in 2d 1h 3m 33s], [13d ago].

To avoid flaky results, the value is always rounded to a certain Duration (e.g. 1s). This duration can be adjusted via roundedTo(Duration).

Method Summary

Modifier and Type	Method	Description
RelativeDateTimeReplacement	dateTimeFormatter(DateTimeFormatter dateTimeFormatter)	Creates and returns a copy of this with the given DateTimeFormatter.
RelativeDateTimeReplacement	roundedTo(Duration roundingDuration)	Rounds the relative date/time to the given Duration.

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface org.approvej.scrub.Replacement

apply

Method Details

dateTimeFormatter

RelativeDateTimeReplacement dateTimeFormatter(DateTimeFormatter dateTimeFormatter)

Creates and returns a copy of this with the given DateTimeFormatter.

Parameters:

dateTimeFormatter - the DateTimeFormatter to be used

Returns:

a copy of this using the given dateTimeFormatter

roundedTo

RelativeDateTimeReplacement roundedTo(Duration roundingDuration)

Rounds the relative date/time to the given Duration.

Parameters:

roundingDuration - a Duration to round to

Returns:

a copy of this using the given roundingDuration