Skip to content

Most visited

Recently visited

navigation
Added in API level 3

DateUtils

public class DateUtils
extends Object

java.lang.Object
   ↳ android.text.format.DateUtils


This class contains various date-related utilities for creating text for things like elapsed time and date ranges, strings for days of the week and months, and AM/PM text etc.

Summary

Constants

String ABBREV_MONTH_FORMAT

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

String ABBREV_WEEKDAY_FORMAT

long DAY_IN_MILLIS

int FORMAT_12HOUR

int FORMAT_24HOUR

int FORMAT_ABBREV_ALL

int FORMAT_ABBREV_MONTH

int FORMAT_ABBREV_RELATIVE

int FORMAT_ABBREV_TIME

int FORMAT_ABBREV_WEEKDAY

int FORMAT_CAP_AMPM

int FORMAT_CAP_MIDNIGHT

int FORMAT_CAP_NOON

int FORMAT_CAP_NOON_MIDNIGHT

int FORMAT_NO_MIDNIGHT

int FORMAT_NO_MONTH_DAY

int FORMAT_NO_NOON

int FORMAT_NO_NOON_MIDNIGHT

int FORMAT_NO_YEAR

int FORMAT_NUMERIC_DATE

int FORMAT_SHOW_DATE

int FORMAT_SHOW_TIME

int FORMAT_SHOW_WEEKDAY

int FORMAT_SHOW_YEAR

int FORMAT_UTC

This constant was deprecated in API level 9. Use formatDateRange and pass in Time.TIMEZONE_UTC for the timeZone instead.

long HOUR_IN_MILLIS

String HOUR_MINUTE_24

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

int LENGTH_LONG

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

int LENGTH_MEDIUM

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

int LENGTH_SHORT

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

int LENGTH_SHORTER

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

int LENGTH_SHORTEST

This constant was deprecated in API level 17. Use SimpleDateFormat instead.

long MINUTE_IN_MILLIS

String MONTH_DAY_FORMAT

String MONTH_FORMAT

String NUMERIC_MONTH_FORMAT

long SECOND_IN_MILLIS

String WEEKDAY_FORMAT

long WEEK_IN_MILLIS

String YEAR_FORMAT

String YEAR_FORMAT_TWO_DIGITS

long YEAR_IN_MILLIS

This constant is actually the length of 364 days, not of a year!

Fields

public static final int[] sameMonthTable

This field was deprecated in API level 17. Do not use.

public static final int[] sameYearTable

This field was deprecated in API level 17. Do not use.

Public constructors

DateUtils()

Public methods

static Formatter formatDateRange(Context context, Formatter formatter, long startMillis, long endMillis, int flags, String timeZone)

Formats a date or a time range according to the local conventions.

static Formatter formatDateRange(Context context, Formatter formatter, long startMillis, long endMillis, int flags)

Formats a date or a time range according to the local conventions.

static String formatDateRange(Context context, long startMillis, long endMillis, int flags)

Formats a date or a time range according to the local conventions.

static String formatDateTime(Context context, long millis, int flags)

Formats a date or a time according to the local conventions.

static String formatElapsedTime(StringBuilder recycle, long elapsedSeconds)

Formats an elapsed time in a format like "MM:SS" or "H:MM:SS" (using a form suited to the current locale), similar to that used on the call-in-progress screen.

static String formatElapsedTime(long elapsedSeconds)

Formats an elapsed time in the form "MM:SS" or "H:MM:SS" for display on the call-in-progress screen.

static final CharSequence formatSameDayTime(long then, long now, int dateStyle, int timeStyle)

Format a date / time such that if the then is on the same day as now, it shows just the time and if it's a different day, it shows just the date.

static String getAMPMString(int ampm)

This method was deprecated in API level 17. Use SimpleDateFormat instead.

static String getDayOfWeekString(int dayOfWeek, int abbrev)

This method was deprecated in API level 17. Use SimpleDateFormat instead.

static String getMonthString(int month, int abbrev)

This method was deprecated in API level 17. Use SimpleDateFormat instead.

static CharSequence getRelativeDateTimeString(Context c, long time, long minResolution, long transitionResolution, int flags)

Return string describing the elapsed time since startTime formatted like "[relative time/date], [time]".

static CharSequence getRelativeTimeSpanString(Context c, long millis, boolean withPreposition)
static CharSequence getRelativeTimeSpanString(long time, long now, long minResolution, int flags)

Returns a string describing 'time' as a time relative to 'now'.

static CharSequence getRelativeTimeSpanString(long startTime)

Returns a string describing the elapsed time since startTime.

static CharSequence getRelativeTimeSpanString(long time, long now, long minResolution)

Returns a string describing 'time' as a time relative to 'now'.

static CharSequence getRelativeTimeSpanString(Context c, long millis)

Convenience function to return relative time string without preposition.

static boolean isToday(long when)

Inherited methods

From class java.lang.Object

Constants

ABBREV_MONTH_FORMAT

Added in API level 3
String ABBREV_MONTH_FORMAT

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

This is not actually a useful month name in all locales.

Constant Value: "%b"

ABBREV_WEEKDAY_FORMAT

Added in API level 3
String ABBREV_WEEKDAY_FORMAT

Constant Value: "%a"

DAY_IN_MILLIS

Added in API level 3
long DAY_IN_MILLIS

Constant Value: 86400000 (0x0000000005265c00)

FORMAT_12HOUR

Added in API level 3
int FORMAT_12HOUR

Constant Value: 64 (0x00000040)

FORMAT_24HOUR

Added in API level 3
int FORMAT_24HOUR

Constant Value: 128 (0x00000080)

FORMAT_ABBREV_ALL

Added in API level 3
int FORMAT_ABBREV_ALL

Constant Value: 524288 (0x00080000)

FORMAT_ABBREV_MONTH

Added in API level 3
int FORMAT_ABBREV_MONTH

Constant Value: 65536 (0x00010000)

FORMAT_ABBREV_RELATIVE

Added in API level 3
int FORMAT_ABBREV_RELATIVE

Constant Value: 262144 (0x00040000)

FORMAT_ABBREV_TIME

Added in API level 3
int FORMAT_ABBREV_TIME

Constant Value: 16384 (0x00004000)

FORMAT_ABBREV_WEEKDAY

Added in API level 3
int FORMAT_ABBREV_WEEKDAY

Constant Value: 32768 (0x00008000)

FORMAT_CAP_AMPM

Added in API level 3
int FORMAT_CAP_AMPM

Constant Value: 256 (0x00000100)

FORMAT_CAP_MIDNIGHT

Added in API level 3
int FORMAT_CAP_MIDNIGHT

Constant Value: 4096 (0x00001000)

FORMAT_CAP_NOON

Added in API level 3
int FORMAT_CAP_NOON

Constant Value: 1024 (0x00000400)

FORMAT_CAP_NOON_MIDNIGHT

Added in API level 3
int FORMAT_CAP_NOON_MIDNIGHT

Constant Value: 5120 (0x00001400)

FORMAT_NO_MIDNIGHT

Added in API level 3
int FORMAT_NO_MIDNIGHT

Constant Value: 2048 (0x00000800)

FORMAT_NO_MONTH_DAY

Added in API level 3
int FORMAT_NO_MONTH_DAY

Constant Value: 32 (0x00000020)

FORMAT_NO_NOON

Added in API level 3
int FORMAT_NO_NOON

Constant Value: 512 (0x00000200)

FORMAT_NO_NOON_MIDNIGHT

Added in API level 3
int FORMAT_NO_NOON_MIDNIGHT

Constant Value: 2560 (0x00000a00)

FORMAT_NO_YEAR

Added in API level 3
int FORMAT_NO_YEAR

Constant Value: 8 (0x00000008)

FORMAT_NUMERIC_DATE

Added in API level 3
int FORMAT_NUMERIC_DATE

Constant Value: 131072 (0x00020000)

FORMAT_SHOW_DATE

Added in API level 3
int FORMAT_SHOW_DATE

Constant Value: 16 (0x00000010)

FORMAT_SHOW_TIME

Added in API level 3
int FORMAT_SHOW_TIME

Constant Value: 1 (0x00000001)

FORMAT_SHOW_WEEKDAY

Added in API level 3
int FORMAT_SHOW_WEEKDAY

Constant Value: 2 (0x00000002)

FORMAT_SHOW_YEAR

Added in API level 3
int FORMAT_SHOW_YEAR

Constant Value: 4 (0x00000004)

FORMAT_UTC

Added in API level 3
int FORMAT_UTC

This constant was deprecated in API level 9.
Use formatDateRange and pass in Time.TIMEZONE_UTC for the timeZone instead.

Constant Value: 8192 (0x00002000)

HOUR_IN_MILLIS

Added in API level 3
long HOUR_IN_MILLIS

Constant Value: 3600000 (0x000000000036ee80)

HOUR_MINUTE_24

Added in API level 3
String HOUR_MINUTE_24

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

This is not actually the preferred 24-hour date format in all locales.

Constant Value: "%H:%M"

LENGTH_LONG

Added in API level 3
int LENGTH_LONG

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

Request the full spelled-out name. For use with the 'abbrev' parameter of getDayOfWeekString(int, int) and getMonthString(int, int).

Constant Value: 10 (0x0000000a)

LENGTH_MEDIUM

Added in API level 3
int LENGTH_MEDIUM

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

Request an abbreviated version of the name. For use with the 'abbrev' parameter of getDayOfWeekString(int, int) and getMonthString(int, int).

Constant Value: 20 (0x00000014)

LENGTH_SHORT

Added in API level 3
int LENGTH_SHORT

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

Request a shorter abbreviated version of the name. For use with the 'abbrev' parameter of getDayOfWeekString(int, int) and getMonthString(int, int).

Constant Value: 30 (0x0000001e)

LENGTH_SHORTER

Added in API level 3
int LENGTH_SHORTER

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

Request an even shorter abbreviated version of the name. Do not use this. Currently this will always return the same result as LENGTH_SHORT.

Constant Value: 40 (0x00000028)

LENGTH_SHORTEST

Added in API level 3
int LENGTH_SHORTEST

This constant was deprecated in API level 17.
Use SimpleDateFormat instead.

Request an even shorter abbreviated version of the name. For use with the 'abbrev' parameter of getDayOfWeekString(int, int) and getMonthString(int, int).

Constant Value: 50 (0x00000032)

MINUTE_IN_MILLIS

Added in API level 3
long MINUTE_IN_MILLIS

Constant Value: 60000 (0x000000000000ea60)

MONTH_DAY_FORMAT

Added in API level 3
String MONTH_DAY_FORMAT

Constant Value: "%-d"

MONTH_FORMAT

Added in API level 3
String MONTH_FORMAT

Constant Value: "%B"

NUMERIC_MONTH_FORMAT

Added in API level 3
String NUMERIC_MONTH_FORMAT

Constant Value: "%m"

SECOND_IN_MILLIS

Added in API level 3
long SECOND_IN_MILLIS

Constant Value: 1000 (0x00000000000003e8)

WEEKDAY_FORMAT

Added in API level 3
String WEEKDAY_FORMAT

Constant Value: "%A"

WEEK_IN_MILLIS

Added in API level 3
long WEEK_IN_MILLIS

Constant Value: 604800000 (0x00000000240c8400)

YEAR_FORMAT

Added in API level 3
String YEAR_FORMAT

Constant Value: "%Y"

YEAR_FORMAT_TWO_DIGITS

Added in API level 3
String YEAR_FORMAT_TWO_DIGITS

Constant Value: "%g"

YEAR_IN_MILLIS

Added in API level 3
long YEAR_IN_MILLIS

This constant is actually the length of 364 days, not of a year!

Constant Value: 31449600000 (0x00000007528ad000)

Fields

sameMonthTable

Added in API level 3
int[] sameMonthTable

This field was deprecated in API level 17.
Do not use.

sameYearTable

Added in API level 3
int[] sameYearTable

This field was deprecated in API level 17.
Do not use.

Public constructors

DateUtils

Added in API level 3
DateUtils ()

Public methods

formatDateRange

Added in API level 9
Formatter formatDateRange (Context context, 
                Formatter formatter, 
                long startMillis, 
                long endMillis, 
                int flags, 
                String timeZone)

Formats a date or a time range according to the local conventions.

Example output strings (date formats in these examples are shown using the US date format convention but that may change depending on the local settings):

  • 10:15am
  • 3:00pm - 4:00pm
  • 3pm - 4pm
  • 3PM - 4PM
  • 08:00 - 17:00
  • Oct 9
  • Tue, Oct 9
  • October 9, 2007
  • Oct 9 - 10
  • Oct 9 - 10, 2007
  • Oct 28 - Nov 3, 2007
  • Dec 31, 2007 - Jan 1, 2008
  • Oct 9, 8:00am - Oct 10, 5:00pm
  • 12/31/2007 - 01/01/2008

The flags argument is a bitmask of options from the following list:

  • FORMAT_SHOW_TIME
  • FORMAT_SHOW_WEEKDAY
  • FORMAT_SHOW_YEAR
  • FORMAT_SHOW_DATE
  • FORMAT_NO_MONTH_DAY
  • FORMAT_12HOUR
  • FORMAT_24HOUR
  • FORMAT_CAP_AMPM
  • FORMAT_NO_NOON
  • FORMAT_CAP_NOON
  • FORMAT_NO_MIDNIGHT
  • FORMAT_CAP_MIDNIGHT
  • FORMAT_UTC
  • FORMAT_ABBREV_TIME
  • FORMAT_ABBREV_WEEKDAY
  • FORMAT_ABBREV_MONTH
  • FORMAT_ABBREV_ALL
  • FORMAT_NUMERIC_DATE

If FORMAT_SHOW_TIME is set, the time is shown as part of the date range. If the start and end time are the same, then just the start time is shown.

If FORMAT_SHOW_WEEKDAY is set, then the weekday is shown.

If FORMAT_SHOW_YEAR is set, then the year is always shown. If FORMAT_SHOW_YEAR is not set, then the year is shown only if it is different from the current year, or if the start and end dates fall on different years.

Normally the date is shown unless the start and end day are the same. If FORMAT_SHOW_DATE is set, then the date is always shown, even for same day ranges.

If FORMAT_NO_MONTH_DAY is set, then if the date is shown, just the month name will be shown, not the day of the month. For example, "January, 2008" instead of "January 6 - 12, 2008".

If FORMAT_CAP_AMPM is set and 12-hour time is used, then the "AM" and "PM" are capitalized. You should not use this flag because in some locales these terms cannot be capitalized, and in many others it doesn't make sense to do so even though it is possible.

If FORMAT_NO_NOON is set and 12-hour time is used, then "12pm" is shown instead of "noon".

If FORMAT_CAP_NOON is set and 12-hour time is used, then "Noon" is shown instead of "noon". You should probably not use this flag because in many locales it will not make sense to capitalize the term.

If FORMAT_NO_MIDNIGHT is set and 12-hour time is used, then "12am" is shown instead of "midnight".

If FORMAT_CAP_MIDNIGHT is set and 12-hour time is used, then "Midnight" is shown instead of "midnight". You should probably not use this flag because in many locales it will not make sense to capitalize the term.

If FORMAT_12HOUR is set and the time is shown, then the time is shown in the 12-hour time format. You should not normally set this. Instead, let the time format be chosen automatically according to the system settings. If both FORMAT_12HOUR and FORMAT_24HOUR are set, then FORMAT_24HOUR takes precedence.

If FORMAT_24HOUR is set and the time is shown, then the time is shown in the 24-hour time format. You should not normally set this. Instead, let the time format be chosen automatically according to the system settings. If both FORMAT_12HOUR and FORMAT_24HOUR are set, then FORMAT_24HOUR takes precedence.

If FORMAT_UTC is set, then the UTC time zone is used for the start and end milliseconds unless a time zone is specified. If a time zone is specified it will be used regardless of the FORMAT_UTC flag.

If FORMAT_ABBREV_TIME is set and 12-hour time format is used, then the start and end times (if shown) are abbreviated by not showing the minutes if they are zero. For example, instead of "3:00pm" the time would be abbreviated to "3pm".

If FORMAT_ABBREV_WEEKDAY is set, then the weekday (if shown) is abbreviated to a 3-letter string.

If FORMAT_ABBREV_MONTH is set, then the month (if shown) is abbreviated to a 3-letter string.

If FORMAT_ABBREV_ALL is set, then the weekday and the month (if shown) are abbreviated to 3-letter strings.

If FORMAT_NUMERIC_DATE is set, then the date is shown in numeric format instead of using the name of the month. For example, "12/31/2008" instead of "December 31, 2008".

If the end date ends at 12:00am at the beginning of a day, it is formatted as the end of the previous day in two scenarios:

  • For single day events. This results in "8pm - midnight" instead of "Nov 10, 8pm - Nov 11, 12am".
  • When the time is not displayed. This results in "Nov 10 - 11" for an event with a start date of Nov 10 and an end date of Nov 12 at 00:00.

Parameters
context Context: the context is required only if the time is shown
formatter Formatter: the Formatter used for formatting the date range. Note: be sure to call setLength(0) on StringBuilder passed to the Formatter constructor unless you want the results to accumulate.
startMillis long: the start time in UTC milliseconds
endMillis long: the end time in UTC milliseconds
flags int: a bit mask of options
timeZone String: the time zone to compute the string in. Use null for local or if the FORMAT_UTC flag is being used.
Returns
Formatter the formatter with the formatted date/time range appended to the string buffer.

formatDateRange

Added in API level 5
Formatter formatDateRange (Context context, 
                Formatter formatter, 
                long startMillis, 
                long endMillis, 
                int flags)

Formats a date or a time range according to the local conventions.

Note that this is a convenience method for formatting the date or time range in the local time zone. If you want to specify the time zone please use formatDateRange.

Parameters
context Context: the context is required only if the time is shown
formatter Formatter: the Formatter used for formatting the date range. Note: be sure to call setLength(0) on StringBuilder passed to the Formatter constructor unless you want the results to accumulate.
startMillis long: the start time in UTC milliseconds
endMillis long: the end time in UTC milliseconds
flags int: a bit mask of options See formatDateRange
Returns
Formatter a string containing the formatted date/time range.

formatDateRange

Added in API level 3
String formatDateRange (Context context, 
                long startMillis, 
                long endMillis, 
                int flags)

Formats a date or a time range according to the local conventions.

Note that this is a convenience method. Using it involves creating an internal Formatter instance on-the-fly, which is somewhat costly in terms of memory and time. This is probably acceptable if you use the method only rarely, but if you rely on it for formatting a large number of dates, consider creating and reusing your own Formatter instance and use the version of formatDateRange that takes a Formatter.

Parameters
context Context: the context is required only if the time is shown
startMillis long: the start time in UTC milliseconds
endMillis long: the end time in UTC milliseconds
flags int: a bit mask of options See formatDateRange
Returns
String a string containing the formatted date/time range.

formatDateTime

Added in API level 3
String formatDateTime (Context context, 
                long millis, 
                int flags)

Formats a date or a time according to the local conventions. There are lots of options that allow the caller to control, for example, if the time is shown, if the day of the week is shown, if the month name is abbreviated, if noon is shown instead of 12pm, and so on. For the complete list of options, see the documentation for formatDateRange(Context, Formatter, long, long, int).

Example output strings (date formats in these examples are shown using the US date format convention but that may change depending on the local settings):

  • 10:15am
  • 3:00pm
  • 3pm
  • 3PM
  • 08:00
  • 17:00
  • noon
  • Noon
  • midnight
  • Midnight
  • Oct 31
  • Oct 31, 2007
  • October 31, 2007
  • 10am, Oct 31
  • 17:00, Oct 31
  • Wed
  • Wednesday
  • 10am, Wed, Oct 31
  • Wed, Oct 31
  • Wednesday, Oct 31
  • Wed, Oct 31, 2007
  • Wed, October 31
  • 10/31/2007

Parameters
context Context: the context is required only if the time is shown
millis long: a point in time in UTC milliseconds
flags int: a bit mask of formatting options
Returns
String a string containing the formatted date/time.

formatElapsedTime

Added in API level 3
String formatElapsedTime (StringBuilder recycle, 
                long elapsedSeconds)

Formats an elapsed time in a format like "MM:SS" or "H:MM:SS" (using a form suited to the current locale), similar to that used on the call-in-progress screen.

Parameters
recycle StringBuilder: StringBuilder to recycle, or null to use a temporary one.
elapsedSeconds long: the elapsed time in seconds.
Returns
String

formatElapsedTime

Added in API level 3
String formatElapsedTime (long elapsedSeconds)

Formats an elapsed time in the form "MM:SS" or "H:MM:SS" for display on the call-in-progress screen.

Parameters
elapsedSeconds long: the elapsed time in seconds.
Returns
String

formatSameDayTime

Added in API level 3
CharSequence formatSameDayTime (long then, 
                long now, 
                int dateStyle, 
                int timeStyle)

Format a date / time such that if the then is on the same day as now, it shows just the time and if it's a different day, it shows just the date.

The parameters dateFormat and timeFormat should each be one of DEFAULT, FULL, LONG, MEDIUM or SHORT

Parameters
then long: the date to format
now long: the base time
dateStyle int: how to format the date portion.
timeStyle int: how to format the time portion.
Returns
CharSequence

getAMPMString

Added in API level 3
String getAMPMString (int ampm)

This method was deprecated in API level 17.
Use SimpleDateFormat instead.

Return a localized string for AM or PM.

Parameters
ampm int: Either Calendar.AM or Calendar.PM.
Returns
String Localized version of "AM" or "PM".
Throws
IndexOutOfBoundsException if the ampm is out of bounds.

getDayOfWeekString

Added in API level 3
String getDayOfWeekString (int dayOfWeek, 
                int abbrev)

This method was deprecated in API level 17.
Use SimpleDateFormat instead.

Return a string for the day of the week.

Parameters
dayOfWeek int: One of Calendar.SUNDAY, Calendar.MONDAY, etc.
abbrev int: One of LENGTH_LONG, LENGTH_SHORT, LENGTH_MEDIUM, or LENGTH_SHORTEST. Note that in most languages, LENGTH_SHORT will return the same as LENGTH_MEDIUM. Undefined lengths will return LENGTH_MEDIUM but may return something different in the future.
Returns
String
Throws
IndexOutOfBoundsException if the dayOfWeek is out of bounds.

getMonthString

Added in API level 3
String getMonthString (int month, 
                int abbrev)

This method was deprecated in API level 17.
Use SimpleDateFormat instead.

Return a localized string for the month of the year.

Parameters
month int: One of Calendar.JANUARY, Calendar.FEBRUARY, etc.
abbrev int: One of LENGTH_LONG, LENGTH_MEDIUM, or LENGTH_SHORTEST. Undefined lengths will return LENGTH_MEDIUM but may return something different in the future.
Returns
String Localized month of the year.

getRelativeDateTimeString

Added in API level 3
CharSequence getRelativeDateTimeString (Context c, 
                long time, 
                long minResolution, 
                long transitionResolution, 
                int flags)

Return string describing the elapsed time since startTime formatted like "[relative time/date], [time]".

Example output strings for the US date format.

  • 3 min. ago, 10:15 AM
  • Yesterday, 12:20 PM
  • Dec 12, 4:12 AM
  • 11/14/2007, 8:20 AM

Parameters
c Context
time long: some time in the past.
minResolution long: the minimum elapsed time (in milliseconds) to report when showing relative times. For example, a time 3 seconds in the past will be reported as "0 minutes ago" if this is set to MINUTE_IN_MILLIS.
transitionResolution long: the elapsed time (in milliseconds) at which to stop reporting relative measurements. Elapsed times greater than this resolution will default to normal date formatting. For example, will transition from "7 days ago" to "Dec 12" when using WEEK_IN_MILLIS.
flags int
Returns
CharSequence

getRelativeTimeSpanString

Added in API level 3
CharSequence getRelativeTimeSpanString (Context c, 
                long millis, 
                boolean withPreposition)

Parameters
c Context
millis long
withPreposition boolean: If true, the string returned will include the correct preposition ("at 9:20am", "on 10/12/2008" or "on May 29").
Returns
CharSequence a relative time string to display the time expressed by millis. Times are counted starting at midnight, which means that assuming that the current time is March 31st, 0:30:
  • "millis=0:10 today" will be displayed as "0:10"
  • "millis=11:30pm the day before" will be displayed as "Mar 30"
If the given millis is in a different year, then the full date is returned in numeric format (e.g., "10/12/2008").

getRelativeTimeSpanString

Added in API level 3
CharSequence getRelativeTimeSpanString (long time, 
                long now, 
                long minResolution, 
                int flags)

Returns a string describing 'time' as a time relative to 'now'.

Time spans in the past are formatted like "42 minutes ago". Time spans in the future are formatted like "In 42 minutes".

Can use FORMAT_ABBREV_RELATIVE flag to use abbreviated relative times, like "42 mins ago".

Parameters
time long: the time to describe, in milliseconds
now long: the current time in milliseconds
minResolution long: the minimum timespan to report. For example, a time 3 seconds in the past will be reported as "0 minutes ago" if this is set to MINUTE_IN_MILLIS. Pass one of 0, MINUTE_IN_MILLIS, HOUR_IN_MILLIS, DAY_IN_MILLIS, WEEK_IN_MILLIS
flags int: a bit mask of formatting options, such as FORMAT_NUMERIC_DATE or FORMAT_ABBREV_RELATIVE
Returns
CharSequence

getRelativeTimeSpanString

Added in API level 3
CharSequence getRelativeTimeSpanString (long startTime)

Returns a string describing the elapsed time since startTime.

The minimum timespan to report is set to MINUTE_IN_MILLIS.

Parameters
startTime long: some time in the past.
Returns
CharSequence a String object containing the elapsed time.

See also:

getRelativeTimeSpanString

Added in API level 3
CharSequence getRelativeTimeSpanString (long time, 
                long now, 
                long minResolution)

Returns a string describing 'time' as a time relative to 'now'.

Time spans in the past are formatted like "42 minutes ago". Time spans in the future are formatted like "In 42 minutes".

Parameters
time long: the time to describe, in milliseconds
now long: the current time in milliseconds
minResolution long: the minimum timespan to report. For example, a time 3 seconds in the past will be reported as "0 minutes ago" if this is set to MINUTE_IN_MILLIS. Pass one of 0, MINUTE_IN_MILLIS, HOUR_IN_MILLIS, DAY_IN_MILLIS, WEEK_IN_MILLIS
Returns
CharSequence

getRelativeTimeSpanString

Added in API level 3
CharSequence getRelativeTimeSpanString (Context c, 
                long millis)

Convenience function to return relative time string without preposition.

Parameters
c Context: context for resources
millis long: time in milliseconds
Returns
CharSequence CharSequence containing relative time.

See also:

isToday

Added in API level 3
boolean isToday (long when)

Parameters
when long
Returns
boolean true if the supplied when is today else false
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.