Package org.ocpsoft.prettytime

Class PrettyTime

java.lang.Object

org.ocpsoft.prettytime.PrettyTime

public class PrettyTime
extends Object

A utility for creating social-networking style timestamps. (e.g. "just now", "moments ago", "3 days ago", "within 2 months")

Usage:

PrettyTime t = new PrettyTime();
String timestamp = t.format(new Date());
//result: moments from now

String timestamp = t.format(new Date(System.currentTimeMillis() + 1000 * 60 * 10));
//result: 10 minutes from now

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor	Description
PrettyTime()	Create a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(String overrideResourceBundle)	Create a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(Instant reference)	Create a new PrettyTime instance that will use the given Instant timestamp to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(Instant reference, String overrideResourceBundle)	Create a new PrettyTime instance that will use the given Instant timestamp to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDate reference)	Create a new PrettyTime instance that will use the given LocalDate and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDate reference, String overrideResourceBundle)	Create a new PrettyTime instance that will use the given LocalDate and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDate reference, ZoneId zoneId)	Create a new PrettyTime instance that will use the given LocalDate and ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDate reference, ZoneId zoneId, String overrideResourceBundle)	Create a new PrettyTime instance that will use the given Instant timestamp to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDateTime reference)	Create a new PrettyTime instance that will use the given LocalDateTime and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDateTime reference, String overrideResourceBundle)	Create a new PrettyTime instance that will use the given LocalDateTime and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDateTime reference, ZoneId zoneId)	Create a new PrettyTime instance that will use the given LocalDateTime and ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(LocalDateTime reference, ZoneId zoneId, String overrideResourceBundle)	Create a new PrettyTime instance that will use the given LocalDateTime and ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(Date reference)	Create a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(Date reference, String overrideResourceBundle)	Create a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.
PrettyTime(Date reference, Locale locale)	Construct a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use the given Locale instead of the system default.
PrettyTime(Date reference, Locale locale, String overrideResourceBundle)	Construct a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use the given Locale instead of the system default.
PrettyTime(Locale locale)	Construct a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison.
PrettyTime(Locale locale, String overrideResourceBundle)	Construct a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison.

Method Summary

Modifier and Type	Method	Description
Duration	approximateDuration(Instant then)	Calculate the approximate Duration between the reference Instant and given Instant.
Duration	approximateDuration(LocalDate then)	Calculate the approximate Duration between the reference Instant and given LocalDateTime.
Duration	approximateDuration(LocalDate then, ZoneId zoneId)	Calculate the approximate Duration between the reference Instant and given LocalDate.
Duration	approximateDuration(LocalDateTime then)	Calculate the approximate Duration between the reference Instant and given LocalDateTime.
Duration	approximateDuration(LocalDateTime then, ZoneId zoneId)	Calculate the approximate Duration between the reference Instant and given LocalDateTime.
Duration	approximateDuration(Date then)	Calculate the approximate Duration between the reference Date and given Date.
List<Duration>	calculatePreciseDuration(Instant then)	Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given Instant.
List<Duration>	calculatePreciseDuration(LocalDate then)	Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDate using the system default ZoneId.
List<Duration>	calculatePreciseDuration(LocalDate then, ZoneId zoneId)	Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDate using the given ZoneId.
List<Duration>	calculatePreciseDuration(LocalDateTime then)	Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDateTime using the system default ZoneId.
List<Duration>	calculatePreciseDuration(LocalDateTime then, ZoneId zoneId)	Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDateTime using the given ZoneId.
List<Duration>	calculatePreciseDuration(Date then)	Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given Date.
List<TimeUnit>	clearUnits()	Remove all registered TimeUnit instances.
String	format(Instant then)	Format the given Instant object.
String	format(LocalDate then)	Format the given LocalDate object using the system default ZoneId.
String	format(LocalDate then, ZoneId zoneId)	Format the given LocalDate object using the given ZoneId.
String	format(LocalDateTime then)	Format the given LocalDateTime object using the system default ZoneId.
String	format(LocalDateTime then, ZoneId zoneId)	Format the given LocalDateTime object using the given ZoneId.
String	format(OffsetDateTime then)	Format the given OffsetDateTime object.
String	format(ZonedDateTime then)	Format the given ZonedDateTime object.
String	format(Calendar then)	Format the given Calendar object.
String	format(Date then)	Format the given Date object.
String	format(List<Duration> durations)	Format the given Duration objects, using the TimeFormat specified by the TimeUnit contained within.
String	format(Duration duration)	Format the given Duration object, using the TimeFormat specified by the TimeUnit contained within.
String	formatDuration(Instant then)	Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(LocalDate then)	Format the given LocalDate using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(LocalDate then, ZoneId zoneId)	Format the given LocalDate using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date.
String	formatDuration(LocalDateTime then)	Format the given LocalDateTime using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(LocalDateTime then, ZoneId zoneId)	Format the given LocalDateTime using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date.
String	formatDuration(OffsetDateTime then)	Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(ZonedDateTime then)	Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(Calendar then)	Format the given Calendar and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(Date then)	Format the given Date and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(List<Duration> durations)	Format the given Duration List and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDuration(Duration duration)	Format the given Duration and return a non-relative (not decorated with past or future tense) String for the approximate duration of the difference between the reference Instant and the given Duration.
String	formatDurationUnrounded(Instant then)	Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(LocalDate then)	Format the given LocalDate using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date.
String	formatDurationUnrounded(LocalDate then, ZoneId zoneId)	Format the given LocalDate using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date.
String	formatDurationUnrounded(LocalDateTime then)	Format the given LocalDateTime using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(LocalDateTime then, ZoneId zoneId)	Format the given LocalDateTime using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date.
String	formatDurationUnrounded(OffsetDateTime then)	Format the given OffsetDateTime and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(ZonedDateTime then)	Format the given ZonedDateTime and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(Calendar then)	Format the given Calendar and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(Date then)	Format the given Date and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(List<Duration> durations)	Format the given Duration List and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatDurationUnrounded(Duration duration)	Format the given Duration and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant.
String	formatUnrounded(Instant then)	Format the given Instant object.
String	formatUnrounded(LocalDate then)	Format the given LocalDate object using the system default ZoneId.
String	formatUnrounded(LocalDate then, ZoneId zoneId)	Format the given LocalDate object using the given ZoneId.
String	formatUnrounded(LocalDateTime then)	Format the given LocalDateTime object using the system default ZoneId.
String	formatUnrounded(LocalDateTime then, ZoneId zoneId)	Format the given LocalDateTime object using the given ZoneId.
String	formatUnrounded(OffsetDateTime then)	Format the given OffsetDateTime object.
String	formatUnrounded(ZonedDateTime then)	Format the given ZonedDateTime object.
String	formatUnrounded(Calendar then)	Format the given Calendar object.
String	formatUnrounded(Date then)	Format the given Date object.
String	formatUnrounded(List<Duration> durations)	Format the given Duration objects, using the TimeFormat specified by the TimeUnit contained within.
String	formatUnrounded(Duration duration)	Format the given Duration object, using the TimeFormat specified by the TimeUnit contained within.
TimeFormat	getFormat(TimeUnit unit)	Get the registered TimeFormat for the given TimeUnit or null if none exists.
Locale	getLocale()	Get the currently configured Locale for this PrettyTime object.
Instant	getReference()	Get the current reference Instant, or null if no reference Instant is set.
Date	getReferenceAsLegacyDate()	Get the current reference Instant as a Date, or null if no reference Instant is set.
<UNIT extends TimeUnit> UNIT	getUnit(Class<UNIT> unitType)	Get the registered TimeUnit for the given TimeUnit type or null if none exists.
List<TimeUnit>	getUnits()	Get the unmodifiable List of the current configured TimeUnit instances in calculations.
PrettyTime	registerUnit(TimeUnit unit, TimeFormat format)	Register the given TimeUnit and corresponding TimeFormat instance to be used in calculations.
<UNIT extends TimeUnit> TimeFormat	removeUnit(Class<UNIT> unitType)	Removes the mapping for the given TimeUnit type.
TimeFormat	removeUnit(TimeUnit unit)	Removes the mapping for the given TimeUnit.
PrettyTime	setLocale(Locale locale)	Set the the Locale for this PrettyTime object.
PrettyTime	setReference(Instant timestamp)	Set the reference Instant.
PrettyTime	setReference(LocalDate localDate)	Converts the given LocalDate to the reference Instant using the given ZoneId.
PrettyTime	setReference(LocalDate localDate, ZoneId zoneId)	Converts the given LocalDate to the reference Instant using the given ZoneId.
PrettyTime	setReference(LocalDateTime localDateTime)	Converts the given LocalDateTime to the reference Instant using the system default ZoneId.
PrettyTime	setReference(LocalDateTime localDateTime, ZoneId zoneId)	Converts the given LocalDateTime to the reference Instant using the given ZoneId.
PrettyTime	setReference(Date timestamp)	Converts the given Date to the reference Instant.
PrettyTime	setUnits(ResourcesTimeUnit... units)
PrettyTime	setUnits(TimeFormat format, TimeUnit... units)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PrettyTime

public PrettyTime()

Create a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting.

PrettyTime

public PrettyTime(String overrideResourceBundle)

Create a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. Will use String as an optional override to the default resource bundles.

PrettyTime

public PrettyTime(Date reference)

Create a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given Date is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison.

PrettyTime

public PrettyTime(Date reference,
 String overrideResourceBundle)

Create a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given Date is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison. Will use String as an optional override to the default resource bundles.

PrettyTime

public PrettyTime(Instant reference)

Create a new PrettyTime instance that will use the given Instant timestamp to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given Instant is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison.

PrettyTime

public PrettyTime(Instant reference,
 String overrideResourceBundle)

Create a new PrettyTime instance that will use the given Instant timestamp to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given Instant is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison. Will use String as an optional override to the default resource bundles.

See Also:

• PrettyTime(Instant)

PrettyTime

public PrettyTime(LocalDateTime reference)

Create a new PrettyTime instance that will use the given LocalDateTime and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDateTime is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison.

PrettyTime

public PrettyTime(LocalDateTime reference,
 String overrideResourceBundle)

Create a new PrettyTime instance that will use the given LocalDateTime and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDateTime is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison. Will use String as an optional override to the default resource bundles.

See Also:

• PrettyTime(Instant)

PrettyTime

public PrettyTime(LocalDateTime reference,
 ZoneId zoneId)

Create a new PrettyTime instance that will use the given LocalDateTime and ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDateTime is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison.

PrettyTime

public PrettyTime(LocalDateTime reference,
 ZoneId zoneId,
 String overrideResourceBundle)

Create a new PrettyTime instance that will use the given LocalDateTime and ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDateTime is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison. Will use String as an optional override to the default resource bundles.

See Also:

• PrettyTime(Instant)

PrettyTime

public PrettyTime(LocalDate reference)

Create a new PrettyTime instance that will use the given LocalDate and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDate is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison.

PrettyTime

public PrettyTime(LocalDate reference,
 String overrideResourceBundle)

Create a new PrettyTime instance that will use the given LocalDate and the system default ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDate is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison. Will use String as an optional override to the default resource bundles.

See Also:

• PrettyTime(Instant)

PrettyTime

public PrettyTime(LocalDate reference,
 ZoneId zoneId)

Create a new PrettyTime instance that will use the given LocalDate and ZoneId to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given LocalDate is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison.

PrettyTime

public PrettyTime(LocalDate reference,
 ZoneId zoneId,
 String overrideResourceBundle)

Create a new PrettyTime instance that will use the given Instant timestamp to represent the reference point for Instant comparison, and will use Locale.getDefault() as the selected Locale for language and dialect formatting. If the given Instant is null, this instance will always use the current value of System.currentTimeMillis() to represent the reference point for Instant comparison. Will use String as an optional override to the default resource bundles.

See Also:

• PrettyTime(Instant)

PrettyTime

public PrettyTime(Locale locale)

Construct a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison. This instance will use the given Locale instead of the system default. If the provided Locale is null, Locale.getDefault() will be used.

PrettyTime

public PrettyTime(Locale locale,
 String overrideResourceBundle)

Construct a new PrettyTime instance that will always use the current value of System.currentTimeMillis() to represent the reference point for Date comparison. This instance will use the given Locale instead of the system default. If the provided Locale is null, Locale.getDefault() will be used. Will use String as an optional override to the default resource bundles.

PrettyTime

public PrettyTime(Date reference,
 Locale locale)

Construct a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use the given Locale instead of the system default.

If the provided Locale is null, Locale.getDefault() will be used instead.
If the given Date is null, this instance will always use current value of System.currentTimeMillis() will be used to represent the reference point for Date comparison.

See PrettyTime#setReference(Date timestamp).

PrettyTime

public PrettyTime(Date reference,
 Locale locale,
 String overrideResourceBundle)

Construct a new PrettyTime instance that will use the given Date timestamp to represent the reference point for Date comparison, and will use the given Locale instead of the system default.

If the provided Locale is null, Locale.getDefault() will be used instead.
If the given Date is null, this instance will always use current value of System.currentTimeMillis() will be used to represent the reference point for Date comparison. Will use String as an optional override to the default resource bundles.

See PrettyTime#setReference(Date timestamp).

Method Details

approximateDuration

public Duration approximateDuration(Date then)

Calculate the approximate Duration between the reference Date and given Date. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

See Also:

• getReference()

approximateDuration

public Duration approximateDuration(Instant then)

Calculate the approximate Duration between the reference Instant and given Instant. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

See Also:

• getReference()

approximateDuration

public Duration approximateDuration(LocalDate then)

Calculate the approximate Duration between the reference Instant and given LocalDateTime. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

See Also:

• getReference()

approximateDuration

public Duration approximateDuration(LocalDate then,
 ZoneId zoneId)

Calculate the approximate Duration between the reference Instant and given LocalDate. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - The LocalDate to be compared against the reference timestamp, or now if no reference timestamp was provided

zoneId - The ZoneId to be used, not null

See Also:

• getReference()

approximateDuration

public Duration approximateDuration(LocalDateTime then)

Calculate the approximate Duration between the reference Instant and given LocalDateTime. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - The LocalDate to be compared against the reference timestamp, or now if no reference timestamp was provided

See Also:

• getReference()

approximateDuration

public Duration approximateDuration(LocalDateTime then,
 ZoneId zoneId)

Calculate the approximate Duration between the reference Instant and given LocalDateTime. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - The LocalDate to be compared against the reference timestamp, or now if no reference timestamp was provided

zoneId - The ZoneId to be used, not null

See Also:

• getReference()

calculatePreciseDuration

public List<Duration> calculatePreciseDuration(Date then)

Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given Date. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

Note: Precision may be lost if no supplied TimeUnit is granular enough to represent the remainder of time (in milliseconds).

Parameters:

then - The Date to be compared against the reference timestamp, or now if no reference timestamp was provided

Returns:

A sorted List of Duration objects, from largest to smallest. Each element in the list represents the approximate duration (number of times) that TimeUnit to fit into the previous element's delta. The first element is the largest TimeUnit to fit within the total difference between compared dates.

calculatePreciseDuration

public List<Duration> calculatePreciseDuration(Instant then)

Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given Instant. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Note: Precision may be lost if no supplied TimeUnit is granular enough to represent the remainder of time (in milliseconds).

Parameters:

then - The Instant to be compared against the reference timestamp, or now if no reference timestamp was provided

Returns:

A sorted List of Duration objects, from largest to smallest. Each element in the list represents the approximate duration (number of times) that TimeUnit to fit into the previous element's delta. The first element is the largest TimeUnit to fit within the total difference between compared dates.

calculatePreciseDuration

public List<Duration> calculatePreciseDuration(LocalDateTime then)

Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDateTime using the system default ZoneId. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Note: Precision may be lost if no supplied TimeUnit is granular enough to represent the remainder of time (in milliseconds).

Parameters:

then - The LocalDateTime to be compared against the reference timestamp, or now if no reference timestamp was provided

Returns:

A sorted List of Duration objects, from largest to smallest. Each element in the list represents the approximate duration (number of times) that TimeUnit to fit into the previous element's delta. The first element is the largest TimeUnit to fit within the total difference between compared dates.

calculatePreciseDuration

public List<Duration> calculatePreciseDuration(LocalDateTime then,
 ZoneId zoneId)

Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDateTime using the given ZoneId. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Note: Precision may be lost if no supplied TimeUnit is granular enough to represent the remainder of time (in milliseconds).

Parameters:

then - The LocalDateTime to be compared against the reference timestamp, or now if no reference timestamp was provided

zoneId - The ZoneId to be used, not null

Returns:

A sorted List of Duration objects, from largest to smallest. Each element in the list represents the approximate duration (number of times) that TimeUnit to fit into the previous element's delta. The first element is the largest TimeUnit to fit within the total difference between compared dates.

calculatePreciseDuration

public List<Duration> calculatePreciseDuration(LocalDate then)

Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDate using the system default ZoneId. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Note: Precision may be lost if no supplied TimeUnit is granular enough to represent the remainder of time (in milliseconds).

Parameters:

then - The LocalDate to be compared against the reference timestamp, or now if no reference timestamp was provided

Returns:

A sorted List of Duration objects, from largest to smallest. Each element in the list represents the approximate duration (number of times) that TimeUnit to fit into the previous element's delta. The first element is the largest TimeUnit to fit within the total difference between compared dates.

calculatePreciseDuration

public List<Duration> calculatePreciseDuration(LocalDate then,
 ZoneId zoneId)

Calculate to the precision of the smallest provided TimeUnit, the exact Duration represented by the difference between the reference Instant and the given LocalDate using the given ZoneId. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Note: Precision may be lost if no supplied TimeUnit is granular enough to represent the remainder of time (in milliseconds).

Parameters:

then - The LocalDate to be compared against the reference timestamp, or now if no reference timestamp was provided

zoneId - The ZoneId to be used, not null

Returns:

A sorted List of Duration objects, from largest to smallest. Each element in the list represents the approximate duration (number of times) that TimeUnit to fit into the previous element's delta. The first element is the largest TimeUnit to fit within the total difference between compared dates.

format

public String format(Date then)

Format the given Date object. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Date to be formatted

Returns:

A formatted string representing then

format

public String format(Calendar then)

Format the given Calendar object. If the given Calendar is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Calendar whose date is to be formatted

Returns:

A formatted string representing then

format

public String format(Duration duration)

Format the given Duration object, using the TimeFormat specified by the TimeUnit contained within. If the given Duration is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

duration - the Duration to be formatted

Returns:

A formatted string representing duration

format

public String format(List<Duration> durations)

Format the given Duration objects, using the TimeFormat specified by the TimeUnit contained within. Rounding rules are ignored for all but the last Duration element. If the given Duration List is null or empty, the current value of System.currentTimeMillis() will be used instead.

Parameters:

durations - the Durations to be formatted

Returns:

A list of formatted strings representing durations

format

public String format(Instant then)

Format the given Instant object. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Instant to be formatted

Returns:

A formatted string representing then

format

public String format(ZonedDateTime then)

Format the given ZonedDateTime object. If the given ZonedDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the ZonedDateTime to be formatted

Returns:

A formatted string representing then

format

public String format(OffsetDateTime then)

Format the given OffsetDateTime object. If the given OffsetDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the OffsetDateTime to be formatted

Returns:

A formatted string representing then

format

public String format(LocalDateTime then,
 ZoneId zoneId)

Format the given LocalDateTime object using the given ZoneId. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

zoneId - the ZoneId to be used, not null

Returns:

A formatted string representing then

format

public String format(LocalDateTime then)

Format the given LocalDateTime object using the system default ZoneId. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

Returns:

A formatted string representing then

format

public String format(LocalDate then,
 ZoneId zoneId)

Format the given LocalDate object using the given ZoneId. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

zoneId - the ZoneId to be used, not null

Returns:

A formatted string representing then

format

public String format(LocalDate then)

Format the given LocalDate object using the system default ZoneId. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(Date then)

Format the given Date object. Rounding rules are ignored. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Date to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(Calendar then)

Format the given Calendar object. This method applies the approximateDuration(Date) method to perform its calculation. Rounding rules are ignored. If the given Calendar is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Calendar whose date is to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(Duration duration)

Format the given Duration object, using the TimeFormat specified by the TimeUnit contained within. Rounding rules are ignored. If the given Duration is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

duration - the Duration to be formatted

Returns:

A formatted string representing duration

formatUnrounded

public String formatUnrounded(List<Duration> durations)

Format the given Duration objects, using the TimeFormat specified by the TimeUnit contained within. Rounding rules are ignored. If the given Duration List is null or empty, the current value of System.currentTimeMillis() will be used instead.

Parameters:

durations - the Durations to be formatted

Returns:

A list of formatted strings representing durations

formatUnrounded

public String formatUnrounded(Instant then)

Format the given Instant object. Rounding rules are ignored. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Instant to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(ZonedDateTime then)

Format the given ZonedDateTime object. Rounding rules are ignored. If the given ZonedDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the ZonedDateTime to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(OffsetDateTime then)

Format the given OffsetDateTime object. Rounding rules are ignored. If the given OffsetDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the OffsetDateTime to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(LocalDateTime then,
 ZoneId zoneId)

Format the given LocalDateTime object using the given ZoneId. Rounding rules are ignored. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

zoneId - the ZoneId to be used, not null

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(LocalDateTime then)

Format the given LocalDateTime object using the system default ZoneId. Rounding rules are ignored. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(LocalDate then,
 ZoneId zoneId)

Format the given LocalDate object using the given ZoneId. Rounding rules are ignored. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

zoneId - the ZoneId to be used, not null

Returns:

A formatted string representing then

formatUnrounded

public String formatUnrounded(LocalDate then)

Format the given LocalDate object using the system default ZoneId. Rounding rules are ignored. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

Returns:

A formatted string representing then

formatDuration

public String formatDuration(Date then)

Format the given Date and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the date to be formatted

Returns:

A formatted string of the given Date

formatDuration

public String formatDuration(Calendar then)

Format the given Calendar and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given Calendar is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the date to be formatted

Returns:

A formatted string of the given Date

formatDuration

public String formatDuration(Duration duration)

Format the given Duration and return a non-relative (not decorated with past or future tense) String for the approximate duration of the difference between the reference Instant and the given Duration. If the given Duration is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

duration - the duration to be formatted

Returns:

A formatted string of the given Duration

formatDuration

public String formatDuration(List<Duration> durations)

Format the given Duration List and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given Duration is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

durations - the durations to be formatted

Returns:

A formatted string of the given Duration

formatDuration

public String formatDuration(Instant then)

Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Instant to be formatted

Returns:

A formatted string of the given Instant

formatDuration

public String formatDuration(ZonedDateTime then)

Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the ZonedDateTime to be formatted

Returns:

A formatted string of the given Instant

formatDuration

public String formatDuration(OffsetDateTime then)

Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the OffsetDateTime to be formatted

Returns:

A formatted string of the given Instant

formatDuration

public String formatDuration(LocalDateTime then,
 ZoneId zoneId)

Format the given LocalDateTime using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

zoneId - the ZoneId to be used, not null

Returns:

A formatted string of the given LocalDateTime

formatDuration

public String formatDuration(LocalDateTime then)

Format the given LocalDateTime using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

Returns:

A formatted string of the given LocalDateTime

formatDuration

public String formatDuration(LocalDate then,
 ZoneId zoneId)

Format the given LocalDate using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

zoneId - the ZoneId to be used, not null

Returns:

A formatted string of the given LocalDate

formatDuration

public String formatDuration(LocalDate then)

Format the given LocalDate using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

Returns:

A formatted string of the given LocalDate

formatDurationUnrounded

public String formatDurationUnrounded(Date then)

Format the given Date and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the date to be formatted

Returns:

A formatted string of the given Date

formatDurationUnrounded

public String formatDurationUnrounded(Calendar then)

Format the given Calendar and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given Calendar is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the date to be formatted

Returns:

A formatted string of the given Date

formatDurationUnrounded

public String formatDurationUnrounded(Duration duration)

Format the given Duration and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given Duration is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

duration - the duration to be formatted

Returns:

A formatted string of the given Duration

formatDurationUnrounded

public String formatDurationUnrounded(List<Duration> durations)

Format the given Duration List and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given Duration is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

durations - the durations to be formatted

Returns:

A formatted string of the given Duration

formatDurationUnrounded

public String formatDurationUnrounded(Instant then)

Format the given Instant and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given Instant is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the Instant to be formatted

Returns:

A formatted string of the given Instant

formatDurationUnrounded

public String formatDurationUnrounded(ZonedDateTime then)

Format the given ZonedDateTime and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given Date is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the ZonedDateTime to be formatted

Returns:

A formatted string of the given ZonedDateTime

formatDurationUnrounded

public String formatDurationUnrounded(OffsetDateTime then)

Format the given OffsetDateTime and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given OffsetDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the OffsetDateTime to be formatted

Returns:

A formatted string of the given OffsetDateTime

formatDurationUnrounded

public String formatDurationUnrounded(LocalDateTime then,
 ZoneId zoneId)

Format the given LocalDateTime using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date. Rounding rules are ignored. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

Returns:

A formatted string of the given LocalDateTime

formatDurationUnrounded

public String formatDurationUnrounded(LocalDateTime then)

Format the given LocalDateTime using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Instant. Rounding rules are ignored. If the given LocalDateTime is null, the current value of System.currentTimeMillis() will be used instead.

Parameters:

then - the LocalDateTime to be formatted

Returns:

A formatted string of the given LocalDateTime

formatDurationUnrounded

public String formatDurationUnrounded(LocalDate then,
 ZoneId zoneId)

Format the given LocalDate using the given ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date. Rounding rules are ignored. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

Returns:

A formatted string of the given LocalDate

formatDurationUnrounded

public String formatDurationUnrounded(LocalDate then)

Format the given LocalDate using the system default ZoneId and return a non-relative (not decorated with past or future tense) String for the approximate duration of its difference between the reference Date. Rounding rules are ignored. If the given LocalDate is null, the current value of System.currentTimeMillis() will be used instead.

This assumes that the time of the given date is midnight.

Parameters:

then - the LocalDate to be formatted

Returns:

A formatted string of the given LocalDate

getFormat

public TimeFormat getFormat(TimeUnit unit)

Get the registered TimeFormat for the given TimeUnit or null if none exists.

getReference

public Instant getReference()

Get the current reference Instant, or null if no reference Instant is set. See PrettyTime.setReference(Date timestamp)

See Also:

• setReference(Instant)

getReferenceAsLegacyDate

public Date getReferenceAsLegacyDate()

Get the current reference Instant as a Date, or null if no reference Instant is set.

See Also:

• getReference()
• setReference(Date)

setReference

public PrettyTime setReference(Date timestamp)

Converts the given Date to the reference Instant. If null, PrettyTime will always use the current value of System.currentTimeMillis() as the reference Instant.

If the Date formatted is before the reference Instant, the format command will produce a String that is in the past tense. If the Instant formatted is after the reference Instant, the format command will produce a String that is in the future tense.

See Also:

• setReference(Instant)

setReference

public PrettyTime setReference(Instant timestamp)

Set the reference Instant. If null, PrettyTime will always use the current value of System.currentTimeMillis() as the reference Instant.

If the Instant formatted is before the reference Instant, the format command will produce a String that is in the past tense. If the Instant formatted is after the reference Instant, the format command will produce a String that is in the future tense.

setReference

public PrettyTime setReference(LocalDateTime localDateTime)

Converts the given LocalDateTime to the reference Instant using the system default ZoneId. If null, PrettyTime will always use the current value of System.currentTimeMillis() as the reference Instant.

If the Instant formatted is before the reference Instant, the format command will produce a String that is in the past tense. If the Instant formatted is after the reference Instant, the format command will produce a String that is in the future tense.

See Also:

• setReference(Instant)

setReference

public PrettyTime setReference(LocalDateTime localDateTime,
 ZoneId zoneId)

Converts the given LocalDateTime to the reference Instant using the given ZoneId. If null, PrettyTime will always use the current value of System.currentTimeMillis() as the reference Instant.

If the Instant formatted is before the reference Instant, the format command will produce a String that is in the past tense. If the Instant formatted is after the reference Instant, the format command will produce a String that is in the future tense.

See Also:

• setReference(Instant)

setReference

public PrettyTime setReference(LocalDate localDate)

Converts the given LocalDate to the reference Instant using the given ZoneId. If null, PrettyTime will always use the current value of System.currentTimeMillis() as the reference Instant.

If the Instant formatted is before the reference Instant, the format command will produce a String that is in the past tense. If the Instant formatted is after the reference Instant, the format command will produce a String that is in the future tense.

See Also:

• setReference(Instant)

setReference

public PrettyTime setReference(LocalDate localDate,
 ZoneId zoneId)

Converts the given LocalDate to the reference Instant using the given ZoneId. If null, PrettyTime will always use the current value of System.currentTimeMillis() as the reference Instant.

If the Instant formatted is before the reference Instant, the format command will produce a String that is in the past tense. If the Instant formatted is after the reference Instant, the format command will produce a String that is in the future tense.

See Also:

• setReference(Instant)

getUnits

public List<TimeUnit> getUnits()

Get the unmodifiable List of the current configured TimeUnit instances in calculations.

getUnit

public <UNIT extends TimeUnit> UNIT getUnit(Class<UNIT> unitType)

Get the registered TimeUnit for the given TimeUnit type or null if none exists.

registerUnit

public PrettyTime registerUnit(TimeUnit unit,
 TimeFormat format)

Register the given TimeUnit and corresponding TimeFormat instance to be used in calculations. If an entry already exists for the given TimeUnit, its TimeFormat will be overwritten with the given TimeFormat. (TimeUnit and TimeFormat must not be null.)

setUnits

public PrettyTime setUnits(ResourcesTimeUnit... units)

setUnits

public PrettyTime setUnits(TimeFormat format,
 TimeUnit... units)

removeUnit

public <UNIT extends TimeUnit> TimeFormat removeUnit(Class<UNIT> unitType)

Removes the mapping for the given TimeUnit type. This effectively de-registers the TimeUnit so it will not be used in formatting. Returns the TimeFormat that was removed, or null if no unit of the given type was registered.

removeUnit

public TimeFormat removeUnit(TimeUnit unit)

Removes the mapping for the given TimeUnit. This effectively de-registers the TimeUnit so it will not be used in formatting. Returns the TimeFormat that was removed, or null if no such unit was registered.

getLocale

public Locale getLocale()

Get the currently configured Locale for this PrettyTime object.

setLocale

public PrettyTime setLocale(Locale locale)

Set the the Locale for this PrettyTime object. This may be an expensive operation, since this operation calls LocaleAware.setLocale(Locale) for each TimeUnit in getUnits().

toString

public String toString()

Overrides:

toString in class Object

clearUnits

public List<TimeUnit> clearUnits()

Remove all registered TimeUnit instances. Returns all TimeUnit instances that were removed.