com.github.kevinsawicki.timeago

Class TimeAgo

java.lang.Object

com.github.kevinsawicki.timeago.TimeAgo

public class TimeAgo
extends Object

Time ago class that converts long millisecond and Date objects to time ago/from now String objects.

This class uses the messages from Messages by default but those can be changed after creation through one of the setter methods for a specified time string.

Constructor Summary

Constructors

Constructor and Description
TimeAgo()

Method Summary

Modifier and Type	Method and Description
String	getDay()
String	getDays()
String	getHour()
String	getHours()
String	getMinute()
String	getMinutes()
String	getMonth()
String	getMonths()
String	getPrefixAgo()
String	getPrefixFromNow()
String	getSeconds()
String	getSuffixAgo()
String	getSuffixFromNow()
String	getYear()
String	getYears()
String	join(String prefix, String time, String suffix) Join time string with prefix and suffix.
TimeAgo	setDay(String day)
TimeAgo	setDays(String days)
TimeAgo	setHour(String hour)
TimeAgo	setHours(String hours)
TimeAgo	setMinute(String minute)
TimeAgo	setMinutes(String minutes)
TimeAgo	setMonth(String month)
TimeAgo	setMonths(String months)
TimeAgo	setPrefixAgo(String prefixAgo)
TimeAgo	setPrefixFromNow(String prefixFromNow)
TimeAgo	setSeconds(String seconds)
TimeAgo	setSuffixAgo(String suffixAgo)
TimeAgo	setSuffixFromNow(String suffixFromNow)
TimeAgo	setYear(String year)
TimeAgo	setYears(String years)
String	time(long distanceMillis, boolean allowFuture) Get time string for milliseconds distance
String	timeAgo(Date date) Get time ago that date occurred
String	timeAgo(long millis) Get time ago that milliseconds date occurred
String	timeUntil(Date date) Get time until specified date
String	timeUntil(long millis) Get time until specified milliseconds date

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeAgo

public TimeAgo()

Method Detail

timeUntil

public String timeUntil(Date date)

Get time until specified date

Parameters:

date -

Returns:

time string

timeAgo

public String timeAgo(Date date)

Get time ago that date occurred

Parameters:

date -

Returns:

time string

timeUntil

public String timeUntil(long millis)

Get time until specified milliseconds date

Parameters:

millis -

Returns:

time string

timeAgo

public String timeAgo(long millis)

Get time ago that milliseconds date occurred

Parameters:

millis -

Returns:

time string

time

public String time(long distanceMillis,
                   boolean allowFuture)

Get time string for milliseconds distance

Parameters:

distanceMillis -

allowFuture -

Returns:

time string

join

public String join(String prefix,
                   String time,
                   String suffix)

Join time string with prefix and suffix. The prefix and suffix are only joined with the time if they are non-null and non-empty

Parameters:

prefix -

time -

suffix -

Returns:

non-null joined string

getPrefixAgo

public String getPrefixAgo()

Returns:

prefixAgo

setPrefixAgo

public TimeAgo setPrefixAgo(String prefixAgo)

Parameters:

prefixAgo - prefixAgo value

Returns:

this instance

getPrefixFromNow

public String getPrefixFromNow()

Returns:

prefixFromNow

setPrefixFromNow

public TimeAgo setPrefixFromNow(String prefixFromNow)

Parameters:

prefixFromNow - prefixFromNow value

Returns:

this instance

getSuffixAgo

public String getSuffixAgo()

Returns:

suffixAgo

setSuffixAgo

public TimeAgo setSuffixAgo(String suffixAgo)

Parameters:

suffixAgo - suffixAgo value

Returns:

this instance

getSuffixFromNow

public String getSuffixFromNow()

Returns:

suffixFromNow

setSuffixFromNow

public TimeAgo setSuffixFromNow(String suffixFromNow)

Parameters:

suffixFromNow - suffixFromNow value

Returns:

this instance

getSeconds

public String getSeconds()

Returns:

seconds

setSeconds

public TimeAgo setSeconds(String seconds)

Parameters:

seconds - seconds value

Returns:

this instance

getMinute

public String getMinute()

Returns:

minute

setMinute

public TimeAgo setMinute(String minute)

Parameters:

minute - minute value

Returns:

this instance

getMinutes

public String getMinutes()

Returns:

minutes

setMinutes

public TimeAgo setMinutes(String minutes)

Parameters:

minutes - minutes value

Returns:

this instance

getHour

public String getHour()

Returns:

hour

setHour

public TimeAgo setHour(String hour)

Parameters:

hour - hour value

Returns:

this instance

getHours

public String getHours()

Returns:

hours

setHours

public TimeAgo setHours(String hours)

Parameters:

hours - hours value

Returns:

this instance

getDay

public String getDay()

Returns:

day

setDay

public TimeAgo setDay(String day)

Parameters:

day - day value

Returns:

this instance

getDays

public String getDays()

Returns:

days

setDays

public TimeAgo setDays(String days)

Parameters:

days - days value

Returns:

this instance

getMonth

public String getMonth()

Returns:

month

setMonth

public TimeAgo setMonth(String month)

Parameters:

month - month value

Returns:

this instance

getMonths

public String getMonths()

Returns:

months

setMonths

public TimeAgo setMonths(String months)

Parameters:

months - months value

Returns:

this instance

getYear

public String getYear()

Returns:

year

setYear

public TimeAgo setYear(String year)

Parameters:

year - year value

Returns:

this instance

getYears

public String getYears()

Returns:

years

setYears

public TimeAgo setYears(String years)

Parameters:

years - years value

Returns:

this instance