to.lova.humanize.time

Class HumanizeTime

java.lang.Object

to.lova.humanize.time.HumanizeTime

All Implemented Interfaces:

com.vityuk.ginger.LocaleResolver

public class HumanizeTime
extends Object
implements com.vityuk.ginger.LocaleResolver

Class to produce humanized messages about time.

Author:

Giovanni Lovato

Constructor Summary

Constructors

Constructor and Description
HumanizeTime() Constructs an instance of HumanizeTime relative to the time of construction.
HumanizeTime(Temporal temporal) Constructs an instance of HumanizeTime.
HumanizeTime(Temporal temporal, Locale locale) Constructs an instance of HumanizeTime with a specified Locale.
HumanizeTime(Temporal temporal, com.vityuk.ginger.LocaleResolver localeResolver) Constructs an instance of HumanizeTime with a LocaleResolver which may be expressed by a lambda, e.g.

Method Summary

Modifier and Type	Method and Description
String	from(Temporal temporal) Returns a humanized message for the relative time between temporal and the reference temporal, i.e.
String	fromNow() Returns a humanized message for the relative time between now and the reference temporal, i.e.
static String	fromNow(Temporal temporal) Returns a humanized message for the relative time between now and temporal.
static String	fromNow(Temporal temporal, Locale locale) Returns a humanized message for the relative time between now and temporal.
static String	fromNow(Temporal temporal, com.vityuk.ginger.LocaleResolver localeResolver) Returns a humanized message for the relative time between now and temporal.
Locale	getLocale()

Methods inherited from class java.lang.Object

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

Constructor Detail

HumanizeTime

public HumanizeTime()

Constructs an instance of HumanizeTime relative to the time of construction.

HumanizeTime

public HumanizeTime(Temporal temporal)

Constructs an instance of HumanizeTime.

Parameters:

temporal - the reference time

HumanizeTime

public HumanizeTime(Temporal temporal,
                    Locale locale)

Constructs an instance of HumanizeTime with a specified Locale.

Parameters:

temporal - the reference time

locale - the locale used to localize the message

HumanizeTime

public HumanizeTime(Temporal temporal,
                    com.vityuk.ginger.LocaleResolver localeResolver)

Constructs an instance of HumanizeTime with a LocaleResolver which may be expressed by a lambda, e.g. new HumanizeTime(temporal, () -> Locale.ENGLISH.

Parameters:

temporal - the reference time

localeResolver - the resolver for the locale used to localize the message

Method Detail

fromNow

public static String fromNow(Temporal temporal)

Returns a humanized message for the relative time between now and temporal.

Parameters:

temporal - the reference time

Returns:

the humanized time

fromNow

public static String fromNow(Temporal temporal,
                             Locale locale)

Returns a humanized message for the relative time between now and temporal.

Parameters:

temporal - the reference time

locale - the locale used to localize the message

Returns:

the humanized time

fromNow

public static String fromNow(Temporal temporal,
                             com.vityuk.ginger.LocaleResolver localeResolver)

Returns a humanized message for the relative time between now and temporal.

Parameters:

temporal - the reference time

localeResolver - the resolver for the locale used to localize the message

Returns:

the humanized time

fromNow

public String fromNow()

Returns a humanized message for the relative time between now and the reference temporal, i.e. the one used to construct this instance of HumanizeTime).

Returns:

the humanized time

from

public String from(Temporal temporal)

Returns a humanized message for the relative time between temporal and the reference temporal, i.e. the one used to construct this instance of HumanizeTime.

Parameters:

temporal - the reference time

Returns:

the humanized tme

getLocale

public Locale getLocale()

Specified by:

getLocale in interface com.vityuk.ginger.LocaleResolver