org.foxlabs.util

Class PeriodCounter

java.lang.Object

org.foxlabs.util.PeriodCounter

public class PeriodCounter
extends Object

This class allows to evaluate period string for dates. It supports past and future dates.

Additional locales are supported through SPI interface. The META-INF/services/org.foxlabs.util.PeriodCounter file should be used to list new counters.

Author:

Fox Mulder

Field Summary

Fields

Modifier and Type	Field and Description
static PeriodCounter	ENGLISH PeriodCounter instance for english locale.
protected Locale	locale Locale of this counter.
static PeriodCounter	RUSSIAN PeriodCounter instance for russian locale.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PeriodCounter(Locale locale) Constructs a new PeriodCounter with the specified locale.

Method Summary

Methods

Modifier and Type	Method and Description
String	evaluate(Date date) Evaluates period string for the specified date.
protected String	getDayPeriod(int count, boolean future) Returns period string in days (less than 1 week).
protected String	getHourPeriod(int count, boolean future) Returns period string in hours (less than 1 day).
Locale	getLocale() Returns locale of this counter.
protected String	getMinutePeriod(int count, boolean future) Returns period string in minutes (less than 1 hour).
protected String	getMonthPeriod(int count, boolean future) Returns period string in months (less than 1 year).
protected String	getNowPeriod() Returns period string for now (less than 1 minute).
protected String	getWeekPeriod(int count, boolean future) Returns period string in weeks (less than 1 month).
protected String	getYearPeriod(int count, boolean future) Returns period string in years.
static String	period(Date date) Returns period string for the specified date and default locale.
static String	period(Date date, Locale locale) Returns period string for the specified date and locale.

Methods inherited from class java.lang.Object

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

Field Detail

locale

protected final Locale locale

Locale of this counter.

ENGLISH

public static final PeriodCounter ENGLISH

PeriodCounter instance for english locale.

RUSSIAN

public static final PeriodCounter RUSSIAN

PeriodCounter instance for russian locale.

Constructor Detail

PeriodCounter

protected PeriodCounter(Locale locale)

Constructs a new PeriodCounter with the specified locale.

Parameters:

locale - Locale of this counter.

Method Detail

getLocale

public final Locale getLocale()

Returns locale of this counter.

Returns:

Locale of this counter.

evaluate

public final String evaluate(Date date)

Evaluates period string for the specified date.

Parameters:

date - Date for which period string should be evaluated.

Returns:

Period string for the specified date.

getNowPeriod

protected String getNowPeriod()

Returns period string for now (less than 1 minute).

Returns:

Period string for now.

getMinutePeriod

protected String getMinutePeriod(int count,
                     boolean future)

Returns period string in minutes (less than 1 hour).

Parameters:

count - Number of minutes.

future - Determines if the specified period is past or future.

Returns:

Period string in minutes.

getHourPeriod

protected String getHourPeriod(int count,
                   boolean future)

Returns period string in hours (less than 1 day).

Parameters:

count - Number of hours.

future - Determines if the specified period is past or future.

Returns:

Period string in hours.

getDayPeriod

protected String getDayPeriod(int count,
                  boolean future)

Returns period string in days (less than 1 week).

Parameters:

count - Number of days.

future - Determines if the specified period is past or future.

Returns:

Period string in days.

getWeekPeriod

protected String getWeekPeriod(int count,
                   boolean future)

Returns period string in weeks (less than 1 month).

Parameters:

count - Number of weeks.

future - Determines if the specified period is past or future.

Returns:

Period string in weeks.

getMonthPeriod

protected String getMonthPeriod(int count,
                    boolean future)

Returns period string in months (less than 1 year).

Parameters:

count - Number of months.

future - Determines if the specified period is past or future.

Returns:

Period string in months.

getYearPeriod

protected String getYearPeriod(int count,
                   boolean future)

Returns period string in years.

Parameters:

count - Number of years.

future - Determines if the specified period is past or future.

Returns:

Period string in years.

period

public static String period(Date date)

Returns period string for the specified date and default locale.

Parameters:

date - Date for which period should be returned.

Returns:

Period string for the specified date and default locale.

See Also:

period(Date, Locale)

period

public static String period(Date date,
            Locale locale)

Returns period string for the specified date and locale.

Parameters:

date - Date for which period should be returned.

locale - Desired locale.

Returns:

Period string for the specified date and locale.